Flutter Engine
 
Loading...
Searching...
No Matches
FlutterSemanticsFlags Struct Reference

#include <embedder.h>

Public Attributes

size_t struct_size
 The size of this struct. Must be sizeof(FlutterSemanticsFlags).
 
FlutterCheckState is_checked
 Whether a semantics node is checked.
 
FlutterTristate is_selected
 Whether a semantics node is selected.
 
FlutterTristate is_enabled
 Whether a semantic node is currently enabled.
 
FlutterTristate is_toggled
 
FlutterTristate is_expanded
 Whether a semantic node that is currently expanded.
 
FlutterTristate is_required
 
FlutterTristate is_focused
 Whether the semantic node currently holds the user's focus.
 
bool is_button
 Whether the semantic node represents a button.
 
bool is_text_field
 Whether the semantic node represents a text field.
 
bool is_in_mutually_exclusive_group
 Whether a semantic node is in a mutually exclusive group.
 
bool is_header
 Whether a semantic node is a header that divides content into sections.
 
bool is_obscured
 Whether the value of the semantics node is obscured.
 
bool scopes_route
 
bool names_route
 Whether the semantics node label is the name of a visually distinct route.
 
bool is_hidden
 Whether the semantics node is considered hidden.
 
bool is_image
 Whether the semantics node represents an image.
 
bool is_live_region
 Whether the semantics node is a live region.
 
bool has_implicit_scrolling
 
bool is_multiline
 
bool is_read_only
 
bool is_link
 Whether the semantics node represents a link.
 
bool is_slider
 Whether the semantics node represents a slider.
 
bool is_keyboard_key
 Whether the semantics node represents a keyboard key.
 
bool is_accessibility_focus_blocked
 Whether to block a11y focus for the semantics node.
 

Detailed Description

Definition at line 291 of file embedder.h.

Member Data Documentation

◆ has_implicit_scrolling

bool FlutterSemanticsFlags::has_implicit_scrolling

Whether the platform can scroll the semantics node when the user attempts to move the accessibility focus to an offscreen child.

For example, a ListView widget has implicit scrolling so that users can easily move the accessibility focus to the next set of children. A PageView widget does not have implicit scrolling, so that users don't navigate to the next page when reaching the end of the current one.

Definition at line 338 of file embedder.h.

◆ is_accessibility_focus_blocked

bool FlutterSemanticsFlags::is_accessibility_focus_blocked

Whether to block a11y focus for the semantics node.

Definition at line 356 of file embedder.h.

◆ is_button

bool FlutterSemanticsFlags::is_button

Whether the semantic node represents a button.

Definition at line 311 of file embedder.h.

Referenced by TEST_F().

◆ is_checked

FlutterCheckState FlutterSemanticsFlags::is_checked

Whether a semantics node is checked.

Definition at line 295 of file embedder.h.

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

◆ is_enabled

FlutterTristate FlutterSemanticsFlags::is_enabled

Whether a semantic node is currently enabled.

Definition at line 299 of file embedder.h.

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

◆ is_expanded

FlutterTristate FlutterSemanticsFlags::is_expanded

Whether a semantic node that is currently expanded.

Definition at line 304 of file embedder.h.

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

◆ is_focused

FlutterTristate FlutterSemanticsFlags::is_focused

Whether the semantic node currently holds the user's focus.

Definition at line 309 of file embedder.h.

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

◆ is_header

bool FlutterSemanticsFlags::is_header

Whether a semantic node is a header that divides content into sections.

Definition at line 317 of file embedder.h.

◆ is_hidden

bool FlutterSemanticsFlags::is_hidden

Whether the semantics node is considered hidden.

Definition at line 326 of file embedder.h.

Referenced by fl_accessible_node_set_flags_impl(), and TEST_F().

◆ is_image

bool FlutterSemanticsFlags::is_image

Whether the semantics node represents an image.

Definition at line 328 of file embedder.h.

◆ is_in_mutually_exclusive_group

bool FlutterSemanticsFlags::is_in_mutually_exclusive_group

Whether a semantic node is in a mutually exclusive group.

Definition at line 315 of file embedder.h.

Referenced by TEST_F().

◆ is_keyboard_key

bool FlutterSemanticsFlags::is_keyboard_key

Whether the semantics node represents a keyboard key.

Definition at line 354 of file embedder.h.

◆ is_link

bool FlutterSemanticsFlags::is_link

Whether the semantics node represents a link.

Definition at line 350 of file embedder.h.

◆ is_live_region

bool FlutterSemanticsFlags::is_live_region

Whether the semantics node is a live region.

Definition at line 330 of file embedder.h.

◆ is_multiline

bool FlutterSemanticsFlags::is_multiline

Whether the value of the semantics node is coming from a multi-line text field.

This is used for text fields to distinguish single-line text fields from multi-line ones.

Definition at line 344 of file embedder.h.

◆ is_obscured

bool FlutterSemanticsFlags::is_obscured

Whether the value of the semantics node is obscured.

Definition at line 319 of file embedder.h.

Referenced by fl_accessible_node_set_flags_impl(), TEST_F(), and TEST_F().

◆ is_read_only

bool FlutterSemanticsFlags::is_read_only

Whether the semantic node is read only.

Only applicable when kFlutterSemanticsFlagIsTextField flag is on.

Definition at line 348 of file embedder.h.

Referenced by fl_accessible_node_set_flags_impl(), and TEST_F().

◆ is_required

FlutterTristate FlutterSemanticsFlags::is_required

Whether user input is required on the semantics node before a form can be submitted.

Definition at line 307 of file embedder.h.

◆ is_selected

FlutterTristate FlutterSemanticsFlags::is_selected

Whether a semantics node is selected.

Definition at line 297 of file embedder.h.

Referenced by is_selected(), and TEST_F().

◆ is_slider

bool FlutterSemanticsFlags::is_slider

Whether the semantics node represents a slider.

Definition at line 352 of file embedder.h.

◆ is_text_field

◆ is_toggled

FlutterTristate FlutterSemanticsFlags::is_toggled

If true, the semantics node is "on". If false, the semantics node is "off".

Definition at line 302 of file embedder.h.

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

◆ names_route

bool FlutterSemanticsFlags::names_route

Whether the semantics node label is the name of a visually distinct route.

Definition at line 324 of file embedder.h.

◆ scopes_route

bool FlutterSemanticsFlags::scopes_route

Whether the semantics node is the root of a subtree for which a route name should be announced.

Definition at line 322 of file embedder.h.

◆ struct_size

size_t FlutterSemanticsFlags::struct_size

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

Definition at line 293 of file embedder.h.


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