Struct bevy_internal::a11y::AccessibilityNode

pub struct AccessibilityNode(pub NodeBuilder);

Component to wrap a accesskit::Node, representing this entity to the platform’s accessibility API.

If an entity has a parent, and that parent also has an AccessibilityNode, the entity’s node will be a child of the parent’s node.

If the entity doesn’t have a parent, or if the immediate parent doesn’t have an AccessibilityNode, its node will be an immediate child of the primary window.

Tuple Fields

0: NodeBuilder

Methods from Deref<Target = NodeBuilder>

pub fn role(&self) -> Role

pub fn set_role(&mut self, value: Role)

pub fn supports_action(&self, action: Action) -> bool

pub fn add_action(&mut self, action: Action)

pub fn remove_action(&mut self, action: Action)

pub fn clear_actions(&mut self)

pub fn is_hovered(&self) -> bool

pub fn set_hovered(&mut self)

pub fn clear_hovered(&mut self)

pub fn is_hidden(&self) -> bool

Exclude this node and its descendants from the tree presented to assistive technologies, and from hit testing.

pub fn set_hidden(&mut self)

pub fn clear_hidden(&mut self)

pub fn is_linked(&self) -> bool

pub fn set_linked(&mut self)

pub fn clear_linked(&mut self)

pub fn is_multiselectable(&self) -> bool

pub fn set_multiselectable(&mut self)

pub fn clear_multiselectable(&mut self)

pub fn is_required(&self) -> bool

pub fn set_required(&mut self)

pub fn clear_required(&mut self)

pub fn is_visited(&self) -> bool

pub fn set_visited(&mut self)

pub fn clear_visited(&mut self)

pub fn is_busy(&self) -> bool

pub fn set_busy(&mut self)

pub fn clear_busy(&mut self)

pub fn is_live_atomic(&self) -> bool

pub fn set_live_atomic(&mut self)

pub fn clear_live_atomic(&mut self)

pub fn is_modal(&self) -> bool

If a dialog box is marked as explicitly modal.

pub fn set_modal(&mut self)

pub fn clear_modal(&mut self)

pub fn is_touch_transparent(&self) -> bool

This element allows touches to be passed through when a screen reader is in touch exploration mode, e.g. a virtual keyboard normally behaves this way.

pub fn set_touch_transparent(&mut self)

pub fn clear_touch_transparent(&mut self)

pub fn is_read_only(&self) -> bool

Use for a textbox that allows focus/selection but not input.

pub fn set_read_only(&mut self)

pub fn clear_read_only(&mut self)

pub fn is_disabled(&self) -> bool

Use for a control or group of controls that disallows input.

pub fn set_disabled(&mut self)

pub fn clear_disabled(&mut self)

pub fn is_bold(&self) -> bool

pub fn set_bold(&mut self)

pub fn clear_bold(&mut self)

pub fn is_italic(&self) -> bool

pub fn set_italic(&mut self)

pub fn clear_italic(&mut self)

pub fn clips_children(&self) -> bool

Indicates that this node clips its children, i.e. may have overflow: hidden or clip children by default.

pub fn set_clips_children(&mut self)

pub fn clear_clips_children(&mut self)

pub fn is_line_breaking_object(&self) -> bool

Indicates whether this node causes a hard line-break (e.g. block level elements, or <br>).

pub fn set_is_line_breaking_object(&mut self)

pub fn clear_is_line_breaking_object(&mut self)

pub fn is_page_breaking_object(&self) -> bool

Indicates whether this node causes a page break.

pub fn set_is_page_breaking_object(&mut self)

pub fn clear_is_page_breaking_object(&mut self)

pub fn is_spelling_error(&self) -> bool

pub fn set_is_spelling_error(&mut self)

pub fn clear_is_spelling_error(&mut self)

pub fn is_grammar_error(&self) -> bool

pub fn set_is_grammar_error(&mut self)

pub fn clear_is_grammar_error(&mut self)

pub fn is_search_match(&self) -> bool

pub fn set_is_search_match(&mut self)

pub fn clear_is_search_match(&mut self)

pub fn is_suggestion(&self) -> bool

pub fn set_is_suggestion(&mut self)

pub fn clear_is_suggestion(&mut self)

pub fn children(&self) -> &[NodeId]

pub fn set_children(&mut self, value: impl Into<Vec<NodeId>>)

pub fn clear_children(&mut self)

pub fn push_child(&mut self, item: NodeId)

pub fn controls(&self) -> &[NodeId]

pub fn set_controls(&mut self, value: impl Into<Vec<NodeId>>)

pub fn clear_controls(&mut self)

pub fn push_controlled(&mut self, item: NodeId)

pub fn details(&self) -> &[NodeId]

pub fn set_details(&mut self, value: impl Into<Vec<NodeId>>)

pub fn clear_details(&mut self)

pub fn push_detail(&mut self, item: NodeId)

pub fn described_by(&self) -> &[NodeId]

pub fn set_described_by(&mut self, value: impl Into<Vec<NodeId>>)

pub fn clear_described_by(&mut self)

pub fn push_described_by(&mut self, item: NodeId)

pub fn flow_to(&self) -> &[NodeId]

pub fn set_flow_to(&mut self, value: impl Into<Vec<NodeId>>)

pub fn clear_flow_to(&mut self)

pub fn push_flow_to(&mut self, item: NodeId)

pub fn labelled_by(&self) -> &[NodeId]

pub fn set_labelled_by(&mut self, value: impl Into<Vec<NodeId>>)

pub fn clear_labelled_by(&mut self)

pub fn push_labelled_by(&mut self, item: NodeId)

pub fn radio_group(&self) -> &[NodeId]

On radio buttons this should be set to a list of all of the buttons in the same group as this one, including this radio button itself.

pub fn set_radio_group(&mut self, value: impl Into<Vec<NodeId>>)

pub fn clear_radio_group(&mut self)

pub fn push_to_radio_group(&mut self, item: NodeId)

pub fn active_descendant(&self) -> Option<NodeId>

pub fn set_active_descendant(&mut self, value: NodeId)

pub fn clear_active_descendant(&mut self)

pub fn error_message(&self) -> Option<NodeId>

pub fn set_error_message(&mut self, value: NodeId)

pub fn clear_error_message(&mut self)

pub fn in_page_link_target(&self) -> Option<NodeId>

pub fn set_in_page_link_target(&mut self, value: NodeId)

pub fn clear_in_page_link_target(&mut self)

pub fn member_of(&self) -> Option<NodeId>

pub fn set_member_of(&mut self, value: NodeId)

pub fn clear_member_of(&mut self)

pub fn next_on_line(&self) -> Option<NodeId>

pub fn set_next_on_line(&mut self, value: NodeId)

pub fn clear_next_on_line(&mut self)

pub fn previous_on_line(&self) -> Option<NodeId>

pub fn set_previous_on_line(&mut self, value: NodeId)

pub fn clear_previous_on_line(&mut self)

pub fn popup_for(&self) -> Option<NodeId>

pub fn set_popup_for(&mut self, value: NodeId)

pub fn clear_popup_for(&mut self)

pub fn table_header(&self) -> Option<NodeId>

pub fn set_table_header(&mut self, value: NodeId)

pub fn clear_table_header(&mut self)

pub fn table_row_header(&self) -> Option<NodeId>

pub fn set_table_row_header(&mut self, value: NodeId)

pub fn clear_table_row_header(&mut self)

pub fn table_column_header(&self) -> Option<NodeId>

pub fn set_table_column_header(&mut self, value: NodeId)

pub fn clear_table_column_header(&mut self)

pub fn name(&self) -> Option<&str>

pub fn set_name(&mut self, value: impl Into<Box<str>>)

pub fn clear_name(&mut self)

pub fn description(&self) -> Option<&str>

pub fn set_description(&mut self, value: impl Into<Box<str>>)

pub fn clear_description(&mut self)

pub fn value(&self) -> Option<&str>

pub fn set_value(&mut self, value: impl Into<Box<str>>)

pub fn clear_value(&mut self)

pub fn access_key(&self) -> Option<&str>

A single character, usually part of this node’s name, that can be pressed, possibly along with a platform-specific modifier, to perform this node’s default action. For menu items, the access key is only active while the menu is active, in contrast with keyboard_shortcut; a single menu item may in fact have both properties.

pub fn set_access_key(&mut self, value: impl Into<Box<str>>)

pub fn clear_access_key(&mut self)

pub fn class_name(&self) -> Option<&str>

pub fn set_class_name(&mut self, value: impl Into<Box<str>>)

pub fn clear_class_name(&mut self)

pub fn font_family(&self) -> Option<&str>

Only present when different from parent.

pub fn set_font_family(&mut self, value: impl Into<Box<str>>)

pub fn clear_font_family(&mut self)

pub fn html_tag(&self) -> Option<&str>

pub fn set_html_tag(&mut self, value: impl Into<Box<str>>)

pub fn clear_html_tag(&mut self)

pub fn inner_html(&self) -> Option<&str>

Inner HTML of an element. Only used for a top-level math element, to support third-party math accessibility products that parse MathML.

pub fn set_inner_html(&mut self, value: impl Into<Box<str>>)

pub fn clear_inner_html(&mut self)

pub fn keyboard_shortcut(&self) -> Option<&str>

A keystroke or sequence of keystrokes, complete with any required modifiers(s), that will perform this node’s default action. The value of this property should be in a human-friendly format.

pub fn set_keyboard_shortcut(&mut self, value: impl Into<Box<str>>)

pub fn clear_keyboard_shortcut(&mut self)

pub fn language(&self) -> Option<&str>

Only present when different from parent.

pub fn set_language(&mut self, value: impl Into<Box<str>>)

pub fn clear_language(&mut self)

pub fn placeholder(&self) -> Option<&str>

If a text input has placeholder text, it should be exposed through this property rather than name.

pub fn set_placeholder(&mut self, value: impl Into<Box<str>>)

pub fn clear_placeholder(&mut self)

pub fn role_description(&self) -> Option<&str>

An optional string that may override an assistive technology’s description of the node’s role. Only provide this for custom control types. The value of this property should be in a human-friendly, localized format.

pub fn set_role_description(&mut self, value: impl Into<Box<str>>)

pub fn clear_role_description(&mut self)

pub fn state_description(&self) -> Option<&str>

An optional string that may override an assistive technology’s description of the node’s state, replacing default strings such as “checked” or “selected”. Note that most platform accessibility APIs and assistive technologies do not support this feature.

pub fn set_state_description(&mut self, value: impl Into<Box<str>>)

pub fn clear_state_description(&mut self)

pub fn tooltip(&self) -> Option<&str>

If a node’s only accessible name comes from a tooltip, it should be exposed through this property rather than name.

pub fn set_tooltip(&mut self, value: impl Into<Box<str>>)

pub fn clear_tooltip(&mut self)

pub fn url(&self) -> Option<&str>

pub fn set_url(&mut self, value: impl Into<Box<str>>)

pub fn clear_url(&mut self)

pub fn scroll_x(&self) -> Option<f64>

pub fn set_scroll_x(&mut self, value: f64)

pub fn clear_scroll_x(&mut self)

pub fn scroll_x_min(&self) -> Option<f64>

pub fn set_scroll_x_min(&mut self, value: f64)

pub fn clear_scroll_x_min(&mut self)

pub fn scroll_x_max(&self) -> Option<f64>

pub fn set_scroll_x_max(&mut self, value: f64)

pub fn clear_scroll_x_max(&mut self)

pub fn scroll_y(&self) -> Option<f64>

pub fn set_scroll_y(&mut self, value: f64)

pub fn clear_scroll_y(&mut self)

pub fn scroll_y_min(&self) -> Option<f64>

pub fn set_scroll_y_min(&mut self, value: f64)

pub fn clear_scroll_y_min(&mut self)

pub fn scroll_y_max(&self) -> Option<f64>

pub fn set_scroll_y_max(&mut self, value: f64)

pub fn clear_scroll_y_max(&mut self)

pub fn numeric_value(&self) -> Option<f64>

pub fn set_numeric_value(&mut self, value: f64)

pub fn clear_numeric_value(&mut self)

pub fn min_numeric_value(&self) -> Option<f64>

pub fn set_min_numeric_value(&mut self, value: f64)

pub fn clear_min_numeric_value(&mut self)

pub fn max_numeric_value(&self) -> Option<f64>

pub fn set_max_numeric_value(&mut self, value: f64)

pub fn clear_max_numeric_value(&mut self)

pub fn numeric_value_step(&self) -> Option<f64>

pub fn set_numeric_value_step(&mut self, value: f64)

pub fn clear_numeric_value_step(&mut self)

pub fn numeric_value_jump(&self) -> Option<f64>

pub fn set_numeric_value_jump(&mut self, value: f64)

pub fn clear_numeric_value_jump(&mut self)

pub fn font_size(&self) -> Option<f64>

Font size is in pixels.

pub fn set_font_size(&mut self, value: f64)

pub fn clear_font_size(&mut self)

pub fn font_weight(&self) -> Option<f64>

Font weight can take on any arbitrary numeric value. Increments of 100 in range [0, 900] represent keywords such as light, normal, bold, etc.

pub fn set_font_weight(&mut self, value: f64)

pub fn clear_font_weight(&mut self)

pub fn table_row_count(&self) -> Option<usize>

pub fn set_table_row_count(&mut self, value: usize)

pub fn clear_table_row_count(&mut self)

pub fn table_column_count(&self) -> Option<usize>

pub fn set_table_column_count(&mut self, value: usize)

pub fn clear_table_column_count(&mut self)

pub fn table_row_index(&self) -> Option<usize>

pub fn set_table_row_index(&mut self, value: usize)

pub fn clear_table_row_index(&mut self)

pub fn table_column_index(&self) -> Option<usize>

pub fn set_table_column_index(&mut self, value: usize)

pub fn clear_table_column_index(&mut self)

pub fn table_cell_column_index(&self) -> Option<usize>

pub fn set_table_cell_column_index(&mut self, value: usize)

pub fn clear_table_cell_column_index(&mut self)

pub fn table_cell_column_span(&self) -> Option<usize>

pub fn set_table_cell_column_span(&mut self, value: usize)

pub fn clear_table_cell_column_span(&mut self)

pub fn table_cell_row_index(&self) -> Option<usize>

pub fn set_table_cell_row_index(&mut self, value: usize)

pub fn clear_table_cell_row_index(&mut self)

pub fn table_cell_row_span(&self) -> Option<usize>

pub fn set_table_cell_row_span(&mut self, value: usize)

pub fn clear_table_cell_row_span(&mut self)

pub fn hierarchical_level(&self) -> Option<usize>

pub fn set_hierarchical_level(&mut self, value: usize)

pub fn clear_hierarchical_level(&mut self)

pub fn size_of_set(&self) -> Option<usize>

pub fn set_size_of_set(&mut self, value: usize)

pub fn clear_size_of_set(&mut self)

pub fn position_in_set(&self) -> Option<usize>

pub fn set_position_in_set(&mut self, value: usize)

pub fn clear_position_in_set(&mut self)

pub fn color_value(&self) -> Option<u32>

For Role::ColorWell, specifies the selected color in RGBA.

pub fn set_color_value(&mut self, value: u32)

pub fn clear_color_value(&mut self)

pub fn background_color(&self) -> Option<u32>

Background color in RGBA.

pub fn set_background_color(&mut self, value: u32)

pub fn clear_background_color(&mut self)

pub fn foreground_color(&self) -> Option<u32>

Foreground color in RGBA.

pub fn set_foreground_color(&mut self, value: u32)

pub fn clear_foreground_color(&mut self)

pub fn overline(&self) -> Option<TextDecoration>

pub fn set_overline(&mut self, value: TextDecoration)

pub fn clear_overline(&mut self)

pub fn strikethrough(&self) -> Option<TextDecoration>

pub fn set_strikethrough(&mut self, value: TextDecoration)

pub fn clear_strikethrough(&mut self)

pub fn underline(&self) -> Option<TextDecoration>

pub fn set_underline(&mut self, value: TextDecoration)

pub fn clear_underline(&mut self)

pub fn character_lengths(&self) -> &[u8]

For inline text. The length (non-inclusive) of each character in UTF-8 code units (bytes). The sum of these lengths must equal the length of value, also in bytes.

A character is defined as the smallest unit of text that can be selected. This isn’t necessarily a single Unicode scalar value (code point). This is why AccessKit can’t compute the lengths of the characters from the text itself; this information must be provided by the text editing implementation.

If this node is the last text box in a line that ends with a hard line break, that line break should be included at the end of this node’s value as either a CRLF or LF; in both cases, the line break should be counted as a single character for the sake of this slice. When the caret is at the end of such a line, the focus of the text selection should be on the line break, not after it.

pub fn set_character_lengths(&mut self, value: impl Into<Box<[u8]>>)

pub fn clear_character_lengths(&mut self)

pub fn word_lengths(&self) -> &[u8]

For inline text. The length of each word in characters, as defined in character_lengths. The sum of these lengths must equal the length of character_lengths.

The end of each word is the beginning of the next word; there are no characters that are not considered part of a word. Trailing whitespace is typically considered part of the word that precedes it, while a line’s leading whitespace is considered its own word. Whether punctuation is considered a separate word or part of the preceding word depends on the particular text editing implementation. Some editors may have their own definition of a word; for example, in an IDE, words may correspond to programming language tokens.

Not all assistive technologies require information about word boundaries, and not all platform accessibility APIs even expose this information, but for assistive technologies that do use this information, users will get unpredictable results if the word boundaries exposed by the accessibility tree don’t match the editor’s behavior. This is why AccessKit does not determine word boundaries itself.

pub fn set_word_lengths(&mut self, value: impl Into<Box<[u8]>>)

pub fn clear_word_lengths(&mut self)

pub fn character_positions(&self) -> Option<&[f32]>

For inline text. This is the position of each character within the node’s bounding box, in the direction given by text_direction, in the coordinate space of this node.

When present, the length of this slice should be the same as the length of character_lengths, including for lines that end with a hard line break. The position of such a line break should be the position where an end-of-paragraph marker would be rendered.

This property is optional. Without it, AccessKit can’t support some use cases, such as screen magnifiers that track the caret position or screen readers that display a highlight cursor. However, most text functionality still works without this information.

pub fn set_character_positions(&mut self, value: impl Into<Box<[f32]>>)

pub fn clear_character_positions(&mut self)

pub fn character_widths(&self) -> Option<&[f32]>

For inline text. This is the advance width of each character, in the direction given by text_direction, in the coordinate space of this node.

When present, the length of this slice should be the same as the length of character_lengths, including for lines that end with a hard line break. The width of such a line break should be non-zero if selecting the line break by itself results in a visible highlight (as in Microsoft Word), or zero if not (as in Windows Notepad).

This property is optional. Without it, AccessKit can’t support some use cases, such as screen magnifiers that track the caret position or screen readers that display a highlight cursor. However, most text functionality still works without this information.

pub fn set_character_widths(&mut self, value: impl Into<Box<[f32]>>)

pub fn clear_character_widths(&mut self)

pub fn is_expanded(&self) -> Option<bool>

Whether this node is expanded, collapsed, or neither.

Setting this to false means the node is collapsed; omitting it means this state isn’t applicable.

pub fn set_expanded(&mut self, value: bool)

pub fn clear_expanded(&mut self)

pub fn is_selected(&self) -> Option<bool>

Indicates whether this node is selected or unselected.

The absence of this flag (as opposed to a false setting) means that the concept of “selected” doesn’t apply. When deciding whether to set the flag to false or omit it, consider whether it would be appropriate for a screen reader to announce “not selected”. The ambiguity of this flag in platform accessibility APIs has made extraneous “not selected” announcements a common annoyance.

pub fn set_selected(&mut self, value: bool)

pub fn clear_selected(&mut self)

pub fn invalid(&self) -> Option<Invalid>

pub fn set_invalid(&mut self, value: Invalid)

pub fn clear_invalid(&mut self)

pub fn checked(&self) -> Option<Checked>

pub fn set_checked(&mut self, value: Checked)

pub fn clear_checked(&mut self)

pub fn live(&self) -> Option<Live>

pub fn set_live(&mut self, value: Live)

pub fn clear_live(&mut self)

pub fn default_action_verb(&self) -> Option<DefaultActionVerb>

pub fn set_default_action_verb(&mut self, value: DefaultActionVerb)

pub fn clear_default_action_verb(&mut self)

pub fn text_direction(&self) -> Option<TextDirection>

pub fn set_text_direction(&mut self, value: TextDirection)

pub fn clear_text_direction(&mut self)

pub fn orientation(&self) -> Option<Orientation>

pub fn set_orientation(&mut self, value: Orientation)

pub fn clear_orientation(&mut self)

pub fn sort_direction(&self) -> Option<SortDirection>

pub fn set_sort_direction(&mut self, value: SortDirection)

pub fn clear_sort_direction(&mut self)

pub fn aria_current(&self) -> Option<AriaCurrent>

pub fn set_aria_current(&mut self, value: AriaCurrent)

pub fn clear_aria_current(&mut self)

pub fn auto_complete(&self) -> Option<AutoComplete>

pub fn set_auto_complete(&mut self, value: AutoComplete)

pub fn clear_auto_complete(&mut self)

pub fn has_popup(&self) -> Option<HasPopup>

pub fn set_has_popup(&mut self, value: HasPopup)

pub fn clear_has_popup(&mut self)

pub fn list_style(&self) -> Option<ListStyle>

The list style type. Only available on list items.

pub fn set_list_style(&mut self, value: ListStyle)

pub fn clear_list_style(&mut self)

pub fn text_align(&self) -> Option<TextAlign>

pub fn set_text_align(&mut self, value: TextAlign)

pub fn clear_text_align(&mut self)

pub fn vertical_offset(&self) -> Option<VerticalOffset>

pub fn set_vertical_offset(&mut self, value: VerticalOffset)

pub fn clear_vertical_offset(&mut self)

pub fn transform(&self) -> Option<&Affine>

An affine transform to apply to any coordinates within this node and its descendants, including the bounds property of this node. The combined transforms of this node and its ancestors define the coordinate space of this node. /// This should be None if it would be set to the identity transform, which should be the case for most nodes.

AccessKit expects the final transformed coordinates to be relative to the origin of the tree’s container (e.g. window), in physical pixels, with the y coordinate being top-down.

pub fn set_transform(&mut self, value: impl Into<Box<Affine>>)

pub fn clear_transform(&mut self)

pub fn bounds(&self) -> Option<Rect>

The bounding box of this node, in the node’s coordinate space. This property does not affect the coordinate space of either this node or its descendants; only the transform property affects that. This, along with the recommendation that most nodes should have a transform of None, implies that the bounds property of most nodes should be in the coordinate space of the nearest ancestor with a non-None transform, or if there is no such ancestor, the tree’s container (e.g. window).

pub fn set_bounds(&mut self, value: Rect)

pub fn clear_bounds(&mut self)

pub fn text_selection(&self) -> Option<&TextSelection>

pub fn set_text_selection(&mut self, value: impl Into<Box<TextSelection>>)

pub fn clear_text_selection(&mut self)

pub fn custom_actions(&self) -> &[CustomAction]

pub fn set_custom_actions(&mut self, value: impl Into<Vec<CustomAction>>)

pub fn clear_custom_actions(&mut self)

pub fn push_custom_action(&mut self, item: CustomAction)

Trait Implementations

impl Clone for AccessibilityNode

fn clone(&self) -> AccessibilityNode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for AccessibilityNode

where AccessibilityNode: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Deref for AccessibilityNode

type Target = NodeBuilder

The resulting type after dereferencing.

fn deref(&self) -> &<AccessibilityNode as Deref>::Target

Dereferences the value.

impl DerefMut for AccessibilityNode

fn deref_mut(&mut self) -> &mut <AccessibilityNode as Deref>::Target

Mutably dereferences the value.

impl From<NodeBuilder> for AccessibilityNode

fn from(node: NodeBuilder) -> AccessibilityNode

Converts to this type from the input type.