Flutter Engine
FlutterSemanticsNode Struct Reference

#include <embedder.h>

Public Attributes

size_t struct_size
 The size of this struct. Must be sizeof(FlutterSemanticsNode). More...
 
int32_t id
 The unique identifier for this node. More...
 
FlutterSemanticsFlag flags
 The set of semantics flags associated with this node. More...
 
FlutterSemanticsAction actions
 The set of semantics actions applicable to this node. More...
 
int32_t text_selection_base
 The position at which the text selection originates. More...
 
int32_t text_selection_extent
 The position at which the text selection terminates. More...
 
int32_t scroll_child_count
 The total number of scrollable children that contribute to semantics. More...
 
int32_t scroll_index
 The index of the first visible semantic child of a scroll node. More...
 
double scroll_position
 
double scroll_extent_max
 The maximum in-range value for scrollPosition if the node is scrollable. More...
 
double scroll_extent_min
 The minimum in-range value for scrollPosition if the node is scrollable. More...
 
double elevation
 
double thickness
 Describes how much space the semantics node takes up along the z-axis. More...
 
const char * label
 A textual description of the node. More...
 
const char * hint
 A brief description of the result of performing an action on the node. More...
 
const char * value
 A textual description of the current value of the node. More...
 
const char * increased_value
 
const char * decreased_value
 
FlutterTextDirection text_direction
 
FlutterRect rect
 The bounding box for this node in its coordinate system. More...
 
FlutterTransformation transform
 
size_t child_count
 The number of children this node has. More...
 
const int32_t * children_in_traversal_order
 Array of child node IDs in traversal order. Has length child_count. More...
 
const int32_t * children_in_hit_test_order
 Array of child node IDs in hit test order. Has length child_count. More...
 
size_t custom_accessibility_actions_count
 The number of custom accessibility action associated with this node. More...
 
const int32_t * custom_accessibility_actions
 
FlutterPlatformViewIdentifier platform_view_id
 

Detailed Description

A node that represents some semantic data.

The semantics tree is maintained during the semantics phase of the pipeline (i.e., during PipelineOwner.flushSemantics), which happens after compositing. Updates are then pushed to embedders via the registered FlutterUpdateSemanticsNodeCallback.

Definition at line 794 of file embedder.h.

Member Data Documentation

◆ actions

FlutterSemanticsAction FlutterSemanticsNode::actions

◆ child_count

size_t FlutterSemanticsNode::child_count

◆ children_in_hit_test_order

const int32_t* FlutterSemanticsNode::children_in_hit_test_order

Array of child node IDs in hit test order. Has length child_count.

Definition at line 848 of file embedder.h.

◆ children_in_traversal_order

const int32_t* FlutterSemanticsNode::children_in_traversal_order

Array of child node IDs in traversal order. Has length child_count.

Definition at line 846 of file embedder.h.

Referenced by fl_view_accessible_handle_update_semantics_node(), flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ custom_accessibility_actions

const int32_t* FlutterSemanticsNode::custom_accessibility_actions

Array of FlutterSemanticsCustomAction IDs associated with this node. Has length custom_accessibility_actions_count.

Definition at line 853 of file embedder.h.

Referenced by flutter::AccessibilityBridge::UpdateDelegate().

◆ custom_accessibility_actions_count

size_t FlutterSemanticsNode::custom_accessibility_actions_count

The number of custom accessibility action associated with this node.

Definition at line 850 of file embedder.h.

Referenced by flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ decreased_value

const char* FlutterSemanticsNode::decreased_value

A value that value will have after a kFlutterSemanticsActionDecrease` action has been performed.

Definition at line 834 of file embedder.h.

Referenced by flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ elevation

double FlutterSemanticsNode::elevation

The elevation along the z-axis at which the rect of this semantics node is located above its parent.

Definition at line 820 of file embedder.h.

Referenced by FlutterEngineInitialize(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ flags

FlutterSemanticsFlag FlutterSemanticsNode::flags

◆ hint

const char* FlutterSemanticsNode::hint

A brief description of the result of performing an action on the node.

Definition at line 826 of file embedder.h.

Referenced by FlutterEngineInitialize(), flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ id

◆ increased_value

const char* FlutterSemanticsNode::increased_value

A value that value will have after a kFlutterSemanticsActionIncrease` action has been performed.

Definition at line 831 of file embedder.h.

Referenced by flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ label

◆ platform_view_id

FlutterPlatformViewIdentifier FlutterSemanticsNode::platform_view_id

Identifier of the platform view associated with this semantics node, or -1 if none.

Definition at line 856 of file embedder.h.

◆ rect

FlutterRect FlutterSemanticsNode::rect

The bounding box for this node in its coordinate system.

Definition at line 839 of file embedder.h.

Referenced by fl_view_accessible_handle_update_semantics_node(), FlutterEngineInitialize(), flutter::testing::TEST(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ scroll_child_count

int32_t FlutterSemanticsNode::scroll_child_count

The total number of scrollable children that contribute to semantics.

Definition at line 808 of file embedder.h.

Referenced by flutter::AccessibilityBridge::UpdateDelegate().

◆ scroll_extent_max

double FlutterSemanticsNode::scroll_extent_max

The maximum in-range value for scrollPosition if the node is scrollable.

Definition at line 815 of file embedder.h.

Referenced by flutter::AccessibilityBridge::UpdateDelegate().

◆ scroll_extent_min

double FlutterSemanticsNode::scroll_extent_min

The minimum in-range value for scrollPosition if the node is scrollable.

Definition at line 817 of file embedder.h.

Referenced by flutter::AccessibilityBridge::UpdateDelegate().

◆ scroll_index

int32_t FlutterSemanticsNode::scroll_index

The index of the first visible semantic child of a scroll node.

Definition at line 810 of file embedder.h.

Referenced by flutter::AccessibilityBridge::UpdateDelegate().

◆ scroll_position

double FlutterSemanticsNode::scroll_position

The current scrolling position in logical pixels if the node is scrollable.

Definition at line 813 of file embedder.h.

Referenced by flutter::AccessibilityBridge::UpdateDelegate().

◆ struct_size

size_t FlutterSemanticsNode::struct_size

The size of this struct. Must be sizeof(FlutterSemanticsNode).

Definition at line 796 of file embedder.h.

◆ text_direction

FlutterTextDirection FlutterSemanticsNode::text_direction

The reading direction for label, value, hint, increasedValue, and decreasedValue.

Definition at line 837 of file embedder.h.

Referenced by flutter::AccessibilityBridge::UpdateDelegate().

◆ text_selection_base

int32_t FlutterSemanticsNode::text_selection_base

The position at which the text selection originates.

Definition at line 804 of file embedder.h.

Referenced by flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ text_selection_extent

int32_t FlutterSemanticsNode::text_selection_extent

The position at which the text selection terminates.

Definition at line 806 of file embedder.h.

Referenced by flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ thickness

double FlutterSemanticsNode::thickness

Describes how much space the semantics node takes up along the z-axis.

Definition at line 822 of file embedder.h.

Referenced by FlutterEngineInitialize(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ transform

FlutterTransformation FlutterSemanticsNode::transform

The transform from this node's coordinate system to its parent's coordinate system.

Definition at line 842 of file embedder.h.

Referenced by fl_view_accessible_handle_update_semantics_node(), FlutterEngineInitialize(), flutter::testing::TEST(), and flutter::AccessibilityBridge::UpdateDelegate().

◆ value

const char* FlutterSemanticsNode::value

A textual description of the current value of the node.

Definition at line 828 of file embedder.h.

Referenced by FlutterEngineInitialize(), flutter::testing::TEST(), flutter::testing::TEST_F(), and flutter::AccessibilityBridge::UpdateDelegate().


The documentation for this struct was generated from the following file: