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

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

Deprecated:: Use FlutterSemanticsNode2 instead. In order to preserve ABI compatibility for existing users, no new fields will be added to this struct. New fields will continue to be added to FlutterSemanticsNode2.

Definition at line 1258 of file embedder.h.

Member Data Documentation

◆ actions

FlutterSemanticsAction FlutterSemanticsNode::actions

The set of semantics actions applicable to this node.

Definition at line 1266 of file embedder.h.

◆ child_count

size_t FlutterSemanticsNode::child_count

The number of children this node has.

Definition at line 1308 of file embedder.h.

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

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

◆ custom_accessibility_actions_count

size_t FlutterSemanticsNode::custom_accessibility_actions_count

The number of custom accessibility action associated with this node.

Definition at line 1314 of file embedder.h.

◆ decreased_value

const char* FlutterSemanticsNode::decreased_value

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

Definition at line 1298 of file embedder.h.

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

◆ flags

FlutterSemanticsFlag FlutterSemanticsNode::flags

The set of semantics flags associated with this node.

Definition at line 1264 of file embedder.h.

◆ hint

const char* FlutterSemanticsNode::hint

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

Definition at line 1290 of file embedder.h.

◆ id

int32_t FlutterSemanticsNode::id

The unique identifier for this node.

Definition at line 1262 of file embedder.h.

◆ increased_value

const char* FlutterSemanticsNode::increased_value

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

Definition at line 1295 of file embedder.h.

◆ label

const char* FlutterSemanticsNode::label

A textual description of the node.

Definition at line 1288 of file embedder.h.

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

◆ rect

FlutterRect FlutterSemanticsNode::rect

The bounding box for this node in its coordinate system.

Definition at line 1303 of file embedder.h.

◆ scroll_child_count

int32_t FlutterSemanticsNode::scroll_child_count

The total number of scrollable children that contribute to semantics.

Definition at line 1272 of file embedder.h.

◆ scroll_extent_max

double FlutterSemanticsNode::scroll_extent_max

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

Definition at line 1279 of file embedder.h.

◆ scroll_extent_min

double FlutterSemanticsNode::scroll_extent_min

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

Definition at line 1281 of file embedder.h.

◆ scroll_index

int32_t FlutterSemanticsNode::scroll_index

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

Definition at line 1274 of file embedder.h.

◆ scroll_position

double FlutterSemanticsNode::scroll_position

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

Definition at line 1277 of file embedder.h.

◆ struct_size

size_t FlutterSemanticsNode::struct_size

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

Definition at line 1260 of file embedder.h.

◆ text_direction

FlutterTextDirection FlutterSemanticsNode::text_direction

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

Definition at line 1301 of file embedder.h.

◆ text_selection_base

int32_t FlutterSemanticsNode::text_selection_base

The position at which the text selection originates.

Definition at line 1268 of file embedder.h.

◆ text_selection_extent

int32_t FlutterSemanticsNode::text_selection_extent

The position at which the text selection terminates.

Definition at line 1270 of file embedder.h.

◆ thickness

double FlutterSemanticsNode::thickness

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

Definition at line 1286 of file embedder.h.

◆ tooltip

const char* FlutterSemanticsNode::tooltip

A textual tooltip attached to the node.

Definition at line 1322 of file embedder.h.

◆ transform

FlutterTransformation FlutterSemanticsNode::transform

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

Definition at line 1306 of file embedder.h.

◆ value

const char* FlutterSemanticsNode::value

A textual description of the current value of the node.

Definition at line 1292 of file embedder.h.

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

shell/platform/embedder/embedder.h

Public Attributes