Enum A11yRole 

#[non_exhaustive]
pub enum A11yRole {
    Window,
    Toolbar,
    Button,
    Tab,
    TabList,
    Menu,
    MenuItem,
    Tree,
    TreeItem,
    List,
    ListItem,
    Table,
    Row,
    Cell,
    TextInput,
    Document,
    Editor,
    Terminal,
    Dialog,
    Status,
    Progress,
    Image,
    Group,
    Presentation,
}

A typed accessibility role, replacing a free-form role string.

Each variant maps 1:1 onto an accesskit::Role (see the a11y cargo feature’s From<A11yRole> for accesskit::Role impl below) — this enum is deliberately a subset of accesskit::Role’s much larger vocabulary, scoped to what this crate’s own catalogue of primitives actually needs. Editor and Document both map onto accesskit::Role::Document: AccessKit has no separate “code editor” role, and a multi-line editable document is what every AT actually cares about. Presentation maps onto accesskit::Role::GenericContainer, which is AccessKit’s equivalent of the ARIA none/presentation role — an element an AT should skip over entirely.

#[non_exhaustive]: new roles are additive, not breaking. Construct with one of the named variants; there is no catch-all “custom string” escape hatch, deliberately — see the module doc.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Window

A top-level window or root application surface.

Toolbar

A toolbar grouping related actions.

Button

A clickable button.

Tab

A single tab within a Self::TabList.

TabList

A container of Self::Tabs.

Menu

A menu (menu bar entry, context menu, or submenu).

MenuItem

A single selectable entry within a Self::Menu.

Tree

A hierarchical tree of Self::TreeItems.

TreeItem

A single node within a Self::Tree.

List

A flat list of Self::ListItems.

ListItem

A single entry within a Self::List.

Table

A table of Self::Rows/Self::Cells.

Row

A row within a Self::Table.

Cell

A single cell within a Self::Table Self::Row.

TextInput

A single-line (or multi-line) editable text field.

Document

A read-mostly document surface (e.g. a rendered preview pane).

Editor

A multi-line editable document, such as a code editor. Maps onto the same accesskit::Role::Document as Self::Document — see this enum’s own doc for why AccessKit has no separate role.

Terminal

A VT-100-style terminal surface.

Dialog

A modal or non-modal dialog window.

Status

A status message region (e.g. a status bar).

Progress

A progress indicator.

Image

A non-interactive image.

Group

A generic grouping container with no more specific role.

Presentation

Decorative content an AT should skip — ARIA’s none/presentation.

Trait Implementations

impl Clone for A11yRole

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for A11yRole

impl Debug for A11yRole

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for A11yRole

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for A11yRole

impl From<A11yRole> for Role

Available on crate feature a11y only.

fn from(role: A11yRole) -> Self

Converts to this type from the input type.

impl Hash for A11yRole

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 PartialEq for A11yRole

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for A11yRole

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for A11yRole