Flutter Engine Uber Docs
Docs for the entire Flutter Engine repo.
 
Loading...
Searching...
No Matches
Public Attributes | List of all members
FlutterSemanticsNode2 Struct Reference

#include <embedder.h>

Public Attributes

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

Detailed Description

A node in the Flutter semantics tree.

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 FlutterUpdateSemanticsCallback2.

See also
https://api.flutter.dev/flutter/semantics/SemanticsNode-class.html

Definition at line 1639 of file embedder.h.

Member Data Documentation

◆ actions

FlutterSemanticsAction FlutterSemanticsNode2::actions

The set of semantics actions applicable to this node.

Definition at line 1651 of file embedder.h.

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

◆ child_count

size_t FlutterSemanticsNode2::child_count

The number of children this node has.

Definition at line 1693 of file embedder.h.

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

◆ children_in_hit_test_order

const int32_t* FlutterSemanticsNode2::children_in_hit_test_order

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

Definition at line 1697 of file embedder.h.

Referenced by flutter::testing::TEST_F().

◆ children_in_traversal_order

const int32_t* FlutterSemanticsNode2::children_in_traversal_order

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

Definition at line 1695 of file embedder.h.

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

◆ custom_accessibility_actions

const int32_t* FlutterSemanticsNode2::custom_accessibility_actions

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

Definition at line 1702 of file embedder.h.

◆ custom_accessibility_actions_count

size_t FlutterSemanticsNode2::custom_accessibility_actions_count

The number of custom accessibility action associated with this node.

Definition at line 1699 of file embedder.h.

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

◆ decreased_value

const char* FlutterSemanticsNode2::decreased_value

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

Definition at line 1683 of file embedder.h.

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

◆ decreased_value_attribute_count

size_t FlutterSemanticsNode2::decreased_value_attribute_count

Definition at line 1729 of file embedder.h.

◆ decreased_value_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::decreased_value_attributes

Definition at line 1732 of file embedder.h.

◆ elevation

double FlutterSemanticsNode2::elevation

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

Definition at line 1669 of file embedder.h.

◆ flags2

FlutterSemanticsFlags* FlutterSemanticsNode2::flags2

Definition at line 1735 of file embedder.h.

Referenced by create_node(), fl_view_accessible_handle_update_semantics(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ flags__deprecated__

FlutterSemanticsFlag FlutterSemanticsNode2::flags__deprecated__

The set of semantics flags associated with this node.

Definition at line 1649 of file embedder.h.

◆ heading_level

int32_t FlutterSemanticsNode2::heading_level

The heading level for this node. A value of 0 means the node is not a heading; higher values (1, 2, …) indicate the heading rank, with lower numbers being higher-level headings.

Definition at line 1739 of file embedder.h.

Referenced by flutter::testing::TEST_F().

◆ hint

const char* FlutterSemanticsNode2::hint

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

Definition at line 1675 of file embedder.h.

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

◆ hint_attribute_count

size_t FlutterSemanticsNode2::hint_attribute_count

Definition at line 1714 of file embedder.h.

◆ hint_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::hint_attributes

Definition at line 1717 of file embedder.h.

◆ id

int32_t FlutterSemanticsNode2::id

The unique identifier for this node.

Definition at line 1643 of file embedder.h.

Referenced by flutter::AccessibilityBridge::AddFlutterSemanticsNodeUpdate(), create_node(), flutter::testing::CreateSemanticsNode(), get_node(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), TEST(), TEST(), TEST(), TEST(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ identifier

const char* FlutterSemanticsNode2::identifier

An identifier for the semantics node in native accessibility hierarchy. This value should not be exposed to the users of the app. This is usually used for UI testing with tools that work by querying the native accessibility, like UI Automator, XCUITest, or Appium.

Definition at line 1744 of file embedder.h.

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

◆ increased_value

const char* FlutterSemanticsNode2::increased_value

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

Definition at line 1680 of file embedder.h.

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

◆ increased_value_attribute_count

size_t FlutterSemanticsNode2::increased_value_attribute_count

Definition at line 1724 of file embedder.h.

◆ increased_value_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::increased_value_attributes

Definition at line 1727 of file embedder.h.

◆ label

const char* FlutterSemanticsNode2::label

A textual description of the node.

Definition at line 1673 of file embedder.h.

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

◆ label_attribute_count

size_t FlutterSemanticsNode2::label_attribute_count

Definition at line 1709 of file embedder.h.

◆ label_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::label_attributes

Definition at line 1712 of file embedder.h.

◆ platform_view_id

FlutterPlatformViewIdentifier FlutterSemanticsNode2::platform_view_id

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

Definition at line 1705 of file embedder.h.

Referenced by flutter::testing::TEST_F().

◆ rect

FlutterRect FlutterSemanticsNode2::rect

The bounding box for this node in its coordinate system.

Definition at line 1688 of file embedder.h.

Referenced by fl_view_accessible_handle_update_semantics(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::testing::TEST().

◆ scroll_child_count

int32_t FlutterSemanticsNode2::scroll_child_count

The total number of scrollable children that contribute to semantics.

Definition at line 1657 of file embedder.h.

◆ scroll_extent_max

double FlutterSemanticsNode2::scroll_extent_max

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

Definition at line 1664 of file embedder.h.

◆ scroll_extent_min

double FlutterSemanticsNode2::scroll_extent_min

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

Definition at line 1666 of file embedder.h.

◆ scroll_index

int32_t FlutterSemanticsNode2::scroll_index

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

Definition at line 1659 of file embedder.h.

◆ scroll_position

double FlutterSemanticsNode2::scroll_position

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

Definition at line 1662 of file embedder.h.

◆ struct_size

size_t FlutterSemanticsNode2::struct_size

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

Definition at line 1641 of file embedder.h.

◆ text_direction

FlutterTextDirection FlutterSemanticsNode2::text_direction

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

Definition at line 1686 of file embedder.h.

Referenced by fl_view_accessible_handle_update_semantics().

◆ text_selection_base

int32_t FlutterSemanticsNode2::text_selection_base

The position at which the text selection originates.

Definition at line 1653 of file embedder.h.

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

◆ text_selection_extent

int32_t FlutterSemanticsNode2::text_selection_extent

The position at which the text selection terminates.

Definition at line 1655 of file embedder.h.

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

◆ thickness

double FlutterSemanticsNode2::thickness

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

Definition at line 1671 of file embedder.h.

◆ tooltip

const char* FlutterSemanticsNode2::tooltip

A textual tooltip attached to the node.

Definition at line 1707 of file embedder.h.

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

◆ transform

FlutterTransformation FlutterSemanticsNode2::transform

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

Definition at line 1691 of file embedder.h.

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

◆ value

const char* FlutterSemanticsNode2::value

A textual description of the current value of the node.

Definition at line 1677 of file embedder.h.

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

◆ value_attribute_count

size_t FlutterSemanticsNode2::value_attribute_count

Definition at line 1719 of file embedder.h.

◆ value_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::value_attributes

Definition at line 1722 of file embedder.h.

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