Struct accesskit::NodeBuilder
source · pub struct NodeBuilder { /* private fields */ }
Expand description
Builds a Node
.
Implementations§
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn is_hovered(&self) -> bool
pub fn set_hovered(&mut self)
pub fn clear_hovered(&mut self)
Exclude this node and its descendants from the tree presented to assistive technologies, and from hit testing.
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 set_modal(&mut self)
pub fn clear_modal(&mut self)
sourcepub fn is_touch_transparent(&self) -> bool
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)
sourcepub fn is_read_only(&self) -> bool
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)
sourcepub fn is_disabled(&self) -> bool
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)
sourcepub fn clips_children(&self) -> bool
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)
sourcepub fn is_line_breaking_object(&self) -> bool
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)
sourcepub fn is_page_breaking_object(&self) -> bool
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn children(&self) -> &[NodeId]
pub fn set_children(&mut self, value: impl Into<Vec<NodeId>>)
pub fn clear_children(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_child(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
pub fn controls(&self) -> &[NodeId]
pub fn set_controls(&mut self, value: impl Into<Vec<NodeId>>)
pub fn clear_controls(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_controlled(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
pub fn details(&self) -> &[NodeId]
pub fn set_details(&mut self, value: impl Into<Vec<NodeId>>)
pub fn clear_details(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_detail(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_described_by(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_flow_to(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_labelled_by(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn owns(&self) -> &[NodeId]
pub fn owns(&self) -> &[NodeId]
As with the aria-owns
property in ARIA, this property should be set
only if the nodes referenced in the property are not descendants
of the owning node in the AccessKit tree. In the common case, where the
owned nodes are direct children or indirect descendants, this property
is unnecessary.
pub fn set_owns(&mut self, value: impl Into<Vec<NodeId>>)
pub fn clear_owns(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_owned(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn radio_group(&self) -> &[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)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_to_radio_group(&mut self, item: NodeId)
source§impl NodeBuilder
impl NodeBuilder
pub fn active_descendant(&self) -> Option<NodeId>
pub fn set_active_descendant(&mut self, value: NodeId)
pub fn clear_active_descendant(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn error_message(&self) -> Option<NodeId>
pub fn set_error_message(&mut self, value: NodeId)
pub fn clear_error_message(&mut self)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn member_of(&self) -> Option<NodeId>
pub fn set_member_of(&mut self, value: NodeId)
pub fn clear_member_of(&mut self)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn popup_for(&self) -> Option<NodeId>
pub fn set_popup_for(&mut self, value: NodeId)
pub fn clear_popup_for(&mut self)
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
pub fn description(&self) -> Option<&str>
pub fn set_description(&mut self, value: impl Into<Box<str>>)
pub fn clear_description(&mut self)
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn access_key(&self) -> Option<&str>
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)
source§impl NodeBuilder
impl NodeBuilder
A way for application authors to identify this node for automated testing purpose. The value must be unique among this node’s siblings.
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn font_family(&self) -> Option<&str>
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)
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn inner_html(&self) -> Option<&str>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn keyboard_shortcut(&self) -> Option<&str>
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)
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn placeholder(&self) -> Option<&str>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn role_description(&self) -> Option<&str>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn state_description(&self) -> Option<&str>
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)
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
pub fn row_index_text(&self) -> Option<&str>
pub fn set_row_index_text(&mut self, value: impl Into<Box<str>>)
pub fn clear_row_index_text(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn column_index_text(&self) -> Option<&str>
pub fn set_column_index_text(&mut self, value: impl Into<Box<str>>)
pub fn clear_column_index_text(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn scroll_x(&self) -> Option<f64>
pub fn set_scroll_x(&mut self, value: f64)
pub fn clear_scroll_x(&mut self)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn scroll_y(&self) -> Option<f64>
pub fn set_scroll_y(&mut self, value: f64)
pub fn clear_scroll_y(&mut self)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn numeric_value(&self) -> Option<f64>
pub fn set_numeric_value(&mut self, value: f64)
pub fn clear_numeric_value(&mut self)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn set_font_size(&mut self, value: f64)
pub fn clear_font_size(&mut self)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn font_weight(&self) -> Option<f64>
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn row_count(&self) -> Option<usize>
pub fn set_row_count(&mut self, value: usize)
pub fn clear_row_count(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn column_count(&self) -> Option<usize>
pub fn set_column_count(&mut self, value: usize)
pub fn clear_column_count(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn row_index(&self) -> Option<usize>
pub fn set_row_index(&mut self, value: usize)
pub fn clear_row_index(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn column_index(&self) -> Option<usize>
pub fn set_column_index(&mut self, value: usize)
pub fn clear_column_index(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn row_span(&self) -> Option<usize>
pub fn set_row_span(&mut self, value: usize)
pub fn clear_row_span(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn column_span(&self) -> Option<usize>
pub fn set_column_span(&mut self, value: usize)
pub fn clear_column_span(&mut self)
source§impl NodeBuilder
impl NodeBuilder
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn color_value(&self) -> Option<u32>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn background_color(&self) -> Option<u32>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn foreground_color(&self) -> Option<u32>
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn overline(&self) -> Option<TextDecoration>
pub fn set_overline(&mut self, value: TextDecoration)
pub fn clear_overline(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn strikethrough(&self) -> Option<TextDecoration>
pub fn set_strikethrough(&mut self, value: TextDecoration)
pub fn clear_strikethrough(&mut self)
source§impl NodeBuilder
impl NodeBuilder
pub fn underline(&self) -> Option<TextDecoration>
pub fn set_underline(&mut self, value: TextDecoration)
pub fn clear_underline(&mut self)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn character_lengths(&self) -> &[u8] ⓘ
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn word_lengths(&self) -> &[u8] ⓘ
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn character_positions(&self) -> Option<&[f32]>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn character_widths(&self) -> Option<&[f32]>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn is_expanded(&self) -> Option<bool>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn is_selected(&self) -> Option<bool>
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn invalid(&self) -> Option<Invalid>
pub fn set_invalid(&mut self, value: Invalid)
pub fn clear_invalid(&mut self)
pub fn toggled(&self) -> Option<Toggled>
pub fn set_toggled(&mut self, value: Toggled)
pub fn clear_toggled(&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)
sourcepub fn list_style(&self) -> Option<ListStyle>
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)
source§impl NodeBuilder
impl NodeBuilder
sourcepub fn transform(&self) -> Option<&Affine>
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)
sourcepub fn bounds(&self) -> Option<Rect>
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)
source§impl NodeBuilder
impl NodeBuilder
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)
source§impl NodeBuilder
impl NodeBuilder
pub fn push_custom_action(&mut self, item: CustomAction)
Trait Implementations§
source§impl Clone for NodeBuilder
impl Clone for NodeBuilder
source§fn clone(&self) -> NodeBuilder
fn clone(&self) -> NodeBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for NodeBuilder
impl Debug for NodeBuilder
source§impl Default for NodeBuilder
impl Default for NodeBuilder
source§fn default() -> NodeBuilder
fn default() -> NodeBuilder
source§impl PartialEq for NodeBuilder
impl PartialEq for NodeBuilder
impl StructuralPartialEq for NodeBuilder
Auto Trait Implementations§
impl Freeze for NodeBuilder
impl RefUnwindSafe for NodeBuilder
impl Send for NodeBuilder
impl Sync for NodeBuilder
impl Unpin for NodeBuilder
impl UnwindSafe for NodeBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)