Enum accesskit::Action

#[repr(u8)]
pub enum Action {
    Default,
    Focus,
    Blur,
    Collapse,
    Expand,
    CustomAction,
    Decrement,
    Increment,
    HideTooltip,
    ShowTooltip,
    InvalidateTree,
    LoadInlineTextBoxes,
    ReplaceSelectedText,
    ScrollBackward,
    ScrollDown,
    ScrollForward,
    ScrollLeft,
    ScrollRight,
    ScrollUp,
    ScrollIntoView,
    ScrollToPoint,
    SetScrollOffset,
    SetTextSelection,
    SetSequentialFocusNavigationStartingPoint,
    SetValue,
    ShowContextMenu,
}

An action to be taken on an accessibility node.

In contrast to DefaultActionVerb, these describe what happens to the object, e.g. “focus”.

Variants

Default

Do the default action for an object, typically this means “click”.

Focus

Blur

Collapse

Expand

CustomAction

Requires ActionRequest::data to be set to ActionData::CustomAction.

Decrement

Decrement a numeric value by one step.

Increment

Increment a numeric value by one step.

HideTooltip

ShowTooltip

InvalidateTree

Request that the tree source invalidate its entire tree.

LoadInlineTextBoxes

Load inline text boxes for this subtree, providing information about word boundaries, line layout, and individual character bounding boxes.

ReplaceSelectedText

Delete any selected text in the control’s text value and insert the specified value in its place, like when typing or pasting. Requires ActionRequest::data to be set to ActionData::Value.

ScrollBackward

ScrollDown

ScrollForward

ScrollLeft

ScrollRight

ScrollUp

ScrollIntoView

Scroll any scrollable containers to make the target object visible on the screen. Optionally set ActionRequest::data to ActionData::ScrollTargetRect.

ScrollToPoint

Scroll the given object to a specified point in the tree’s container (e.g. window). Requires ActionRequest::data to be set to ActionData::ScrollToPoint.

SetScrollOffset

Requires ActionRequest::data to be set to ActionData::SetScrollOffset.

SetTextSelection

Requires ActionRequest::data to be set to ActionData::SetTextSelection.

SetSequentialFocusNavigationStartingPoint

Don’t focus this node, but set it as the sequential focus navigation starting point, so that pressing Tab moves to the next element following this one, for example.

SetValue

Replace the value of the control with the specified value and reset the selection, if applicable. Requires ActionRequest::data to be set to ActionData::Value or ActionData::NumericValue.

ShowContextMenu

Implementations

impl Action

pub fn n(value: u8) -> Option<Self>

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Action

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Action

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Action

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Action

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for Action

fn cmp(&self, other: &Action) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Action> for Action

fn eq(&self, other: &Action) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Action> for Action

fn partial_cmp(&self, other: &Action) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Action

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
__S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Action

impl Eq for Action

impl StructuralEq for Action

impl StructuralPartialEq for Action