Flutter Engine
The Flutter Engine
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). 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
 
const char * tooltip
 A textual tooltip attached to the node. More...
 
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
 

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 1333 of file embedder.h.

Member Data Documentation

◆ actions

FlutterSemanticsAction FlutterSemanticsNode2::actions

The set of semantics actions applicable to this node.

Definition at line 1341 of file embedder.h.

◆ child_count

size_t FlutterSemanticsNode2::child_count

The number of children this node has.

Definition at line 1383 of file embedder.h.

◆ 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 1387 of file embedder.h.

◆ 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 1385 of file embedder.h.

◆ 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 1392 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 1389 of file embedder.h.

◆ decreased_value

const char* FlutterSemanticsNode2::decreased_value

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

Definition at line 1373 of file embedder.h.

◆ decreased_value_attribute_count

size_t FlutterSemanticsNode2::decreased_value_attribute_count

Definition at line 1419 of file embedder.h.

◆ decreased_value_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::decreased_value_attributes

Definition at line 1422 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 1359 of file embedder.h.

◆ flags

FlutterSemanticsFlag FlutterSemanticsNode2::flags

The set of semantics flags associated with this node.

Definition at line 1339 of file embedder.h.

◆ hint

const char* FlutterSemanticsNode2::hint

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

Definition at line 1365 of file embedder.h.

◆ hint_attribute_count

size_t FlutterSemanticsNode2::hint_attribute_count

Definition at line 1404 of file embedder.h.

◆ hint_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::hint_attributes

Definition at line 1407 of file embedder.h.

◆ id

int32_t FlutterSemanticsNode2::id

The unique identifier for this node.

Definition at line 1337 of file embedder.h.

◆ increased_value

const char* FlutterSemanticsNode2::increased_value

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

Definition at line 1370 of file embedder.h.

◆ increased_value_attribute_count

size_t FlutterSemanticsNode2::increased_value_attribute_count

Definition at line 1414 of file embedder.h.

◆ increased_value_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::increased_value_attributes

Definition at line 1417 of file embedder.h.

◆ label

const char* FlutterSemanticsNode2::label

A textual description of the node.

Definition at line 1363 of file embedder.h.

◆ label_attribute_count

size_t FlutterSemanticsNode2::label_attribute_count

Definition at line 1399 of file embedder.h.

◆ label_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::label_attributes

Definition at line 1402 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 1395 of file embedder.h.

◆ rect

FlutterRect FlutterSemanticsNode2::rect

The bounding box for this node in its coordinate system.

Definition at line 1378 of file embedder.h.

◆ scroll_child_count

int32_t FlutterSemanticsNode2::scroll_child_count

The total number of scrollable children that contribute to semantics.

Definition at line 1347 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 1354 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 1356 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 1349 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 1352 of file embedder.h.

◆ struct_size

size_t FlutterSemanticsNode2::struct_size

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

Definition at line 1335 of file embedder.h.

◆ text_direction

FlutterTextDirection FlutterSemanticsNode2::text_direction

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

Definition at line 1376 of file embedder.h.

◆ text_selection_base

int32_t FlutterSemanticsNode2::text_selection_base

The position at which the text selection originates.

Definition at line 1343 of file embedder.h.

◆ text_selection_extent

int32_t FlutterSemanticsNode2::text_selection_extent

The position at which the text selection terminates.

Definition at line 1345 of file embedder.h.

◆ thickness

double FlutterSemanticsNode2::thickness

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

Definition at line 1361 of file embedder.h.

◆ tooltip

const char* FlutterSemanticsNode2::tooltip

A textual tooltip attached to the node.

Definition at line 1397 of file embedder.h.

◆ transform

FlutterTransformation FlutterSemanticsNode2::transform

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

Definition at line 1381 of file embedder.h.

◆ value

const char* FlutterSemanticsNode2::value

A textual description of the current value of the node.

Definition at line 1367 of file embedder.h.

◆ value_attribute_count

size_t FlutterSemanticsNode2::value_attribute_count

Definition at line 1409 of file embedder.h.

◆ value_attributes

const FlutterStringAttribute** FlutterSemanticsNode2::value_attributes

Definition at line 1412 of file embedder.h.


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