Enum accesskit::Role

#[repr(u8)]
pub enum Role {
    Unknown = 0,
    InlineTextBox = 1,
    Cell = 2,
    StaticText = 3,
    Image = 4,
    Link = 5,
    Row = 6,
    ListItem = 7,
    ListMarker = 8,
    TreeItem = 9,
    ListBoxOption = 10,
    MenuItem = 11,
    MenuListOption = 12,
    Paragraph = 13,
    GenericContainer = 14,
    CheckBox = 15,
    RadioButton = 16,
    TextInput = 17,
    Button = 18,
    DefaultButton = 19,
    Pane = 20,
    RowHeader = 21,
    ColumnHeader = 22,
    RowGroup = 23,
    List = 24,
    Table = 25,
    LayoutTableCell = 26,
    LayoutTableRow = 27,
    LayoutTable = 28,
    Switch = 29,
    Menu = 30,
    MultilineTextInput = 31,
    SearchInput = 32,
    DateInput = 33,
    DateTimeInput = 34,
    WeekInput = 35,
    MonthInput = 36,
    TimeInput = 37,
    EmailInput = 38,
    NumberInput = 39,
    PasswordInput = 40,
    PhoneNumberInput = 41,
    UrlInput = 42,
    Abbr = 43,
    Alert = 44,
    AlertDialog = 45,
    Application = 46,
    Article = 47,
    Audio = 48,
    Banner = 49,
    Blockquote = 50,
    Canvas = 51,
    Caption = 52,
    Caret = 53,
    Code = 54,
    ColorWell = 55,
    ComboBox = 56,
    EditableComboBox = 57,
    Complementary = 58,
    Comment = 59,
    ContentDeletion = 60,
    ContentInsertion = 61,
    ContentInfo = 62,
    Definition = 63,
    DescriptionList = 64,
    DescriptionListDetail = 65,
    DescriptionListTerm = 66,
    Details = 67,
    Dialog = 68,
    Directory = 69,
    DisclosureTriangle = 70,
    Document = 71,
    EmbeddedObject = 72,
    Emphasis = 73,
    Feed = 74,
    FigureCaption = 75,
    Figure = 76,
    Footer = 77,
    FooterAsNonLandmark = 78,
    Form = 79,
    Grid = 80,
    Group = 81,
    Header = 82,
    HeaderAsNonLandmark = 83,
    Heading = 84,
    Iframe = 85,
    IframePresentational = 86,
    ImeCandidate = 87,
    Keyboard = 88,
    Legend = 89,
    LineBreak = 90,
    ListBox = 91,
    Log = 92,
    Main = 93,
    Mark = 94,
    Marquee = 95,
    Math = 96,
    MenuBar = 97,
    MenuItemCheckBox = 98,
    MenuItemRadio = 99,
    MenuListPopup = 100,
    Meter = 101,
    Navigation = 102,
    Note = 103,
    PluginObject = 104,
    Portal = 105,
    Pre = 106,
    ProgressIndicator = 107,
    RadioGroup = 108,
    Region = 109,
    RootWebArea = 110,
    Ruby = 111,
    RubyAnnotation = 112,
    ScrollBar = 113,
    ScrollView = 114,
    Search = 115,
    Section = 116,
    Slider = 117,
    SpinButton = 118,
    Splitter = 119,
    Status = 120,
    Strong = 121,
    Suggestion = 122,
    SvgRoot = 123,
    Tab = 124,
    TabList = 125,
    TabPanel = 126,
    Term = 127,
    Time = 128,
    Timer = 129,
    TitleBar = 130,
    Toolbar = 131,
    Tooltip = 132,
    Tree = 133,
    TreeGrid = 134,
    Video = 135,
    WebView = 136,
    Window = 137,
    PdfActionableHighlight = 138,
    PdfRoot = 139,
    GraphicsDocument = 140,
    GraphicsObject = 141,
    GraphicsSymbol = 142,
    DocAbstract = 143,
    DocAcknowledgements = 144,
    DocAfterword = 145,
    DocAppendix = 146,
    DocBackLink = 147,
    DocBiblioEntry = 148,
    DocBibliography = 149,
    DocBiblioRef = 150,
    DocChapter = 151,
    DocColophon = 152,
    DocConclusion = 153,
    DocCover = 154,
    DocCredit = 155,
    DocCredits = 156,
    DocDedication = 157,
    DocEndnote = 158,
    DocEndnotes = 159,
    DocEpigraph = 160,
    DocEpilogue = 161,
    DocErrata = 162,
    DocExample = 163,
    DocFootnote = 164,
    DocForeword = 165,
    DocGlossary = 166,
    DocGlossRef = 167,
    DocIndex = 168,
    DocIntroduction = 169,
    DocNoteRef = 170,
    DocNotice = 171,
    DocPageBreak = 172,
    DocPageFooter = 173,
    DocPageHeader = 174,
    DocPageList = 175,
    DocPart = 176,
    DocPreface = 177,
    DocPrologue = 178,
    DocPullquote = 179,
    DocQna = 180,
    DocSubtitle = 181,
    DocTip = 182,
    DocToc = 183,
    ListGrid = 184,
    Terminal = 185,
}

The type of an accessibility node.

The majority of these roles come from the ARIA specification. Reference the latest draft for proper usage.

Like the AccessKit schema as a whole, this list is largely taken from Chromium. However, unlike Chromium’s alphabetized list, this list is ordered roughly by expected usage frequency (with the notable exception of Role::Unknown). This is more efficient in serialization formats where integers use a variable-length encoding.

Variants

Unknown = 0

InlineTextBox = 1

Cell = 2

StaticText = 3

Image = 4

Link = 5

Row = 6

ListItem = 7

ListMarker = 8

Contains the bullet, number, or other marker for a list item.

TreeItem = 9

ListBoxOption = 10

MenuItem = 11

MenuListOption = 12

Paragraph = 13

GenericContainer = 14

A generic container that should be ignored by assistive technologies and filtered out of platform accessibility trees. Equivalent to the ARIA none or presentation role, or to an HTML div with no role.

CheckBox = 15

RadioButton = 16

TextInput = 17

Button = 18

DefaultButton = 19

Pane = 20

RowHeader = 21

ColumnHeader = 22

RowGroup = 23

List = 24

Table = 25

LayoutTableCell = 26

LayoutTableRow = 27

LayoutTable = 28

Switch = 29

Menu = 30

MultilineTextInput = 31

SearchInput = 32

DateInput = 33

DateTimeInput = 34

WeekInput = 35

MonthInput = 36

TimeInput = 37

EmailInput = 38

NumberInput = 39

PasswordInput = 40

PhoneNumberInput = 41

UrlInput = 42

Abbr = 43

Alert = 44

AlertDialog = 45

Application = 46

Article = 47

Audio = 48

Banner = 49

Blockquote = 50

Canvas = 51

Caption = 52

Caret = 53

Code = 54

ColorWell = 55

ComboBox = 56

EditableComboBox = 57

Complementary = 58

Comment = 59

ContentDeletion = 60

ContentInsertion = 61

ContentInfo = 62

Definition = 63

DescriptionList = 64

DescriptionListDetail = 65

DescriptionListTerm = 66

Details = 67

Dialog = 68

Directory = 69

DisclosureTriangle = 70

Document = 71

EmbeddedObject = 72

Emphasis = 73

Feed = 74

FigureCaption = 75

Figure = 76

Footer = 77

FooterAsNonLandmark = 78

Form = 79

Grid = 80

Group = 81

Header = 82

HeaderAsNonLandmark = 83

Heading = 84

Iframe = 85

IframePresentational = 86

ImeCandidate = 87

Keyboard = 88

Legend = 89

LineBreak = 90

ListBox = 91

Log = 92

Main = 93

Mark = 94

Marquee = 95

Math = 96

MenuBar = 97

MenuItemCheckBox = 98

MenuItemRadio = 99

MenuListPopup = 100

Meter = 101

Navigation = 102

Note = 103

PluginObject = 104

Portal = 105

Pre = 106

ProgressIndicator = 107

RadioGroup = 108

Region = 109

RootWebArea = 110

Ruby = 111

RubyAnnotation = 112

ScrollBar = 113

ScrollView = 114

Search = 115

Section = 116

Slider = 117

SpinButton = 118

Splitter = 119

Status = 120

Strong = 121

Suggestion = 122

SvgRoot = 123

Tab = 124

TabList = 125

TabPanel = 126

Term = 127

Time = 128

Timer = 129

TitleBar = 130

Toolbar = 131

Tooltip = 132

Tree = 133

TreeGrid = 134

Video = 135

WebView = 136

Window = 137

PdfActionableHighlight = 138

PdfRoot = 139

GraphicsDocument = 140

GraphicsObject = 141

GraphicsSymbol = 142

DocAbstract = 143

DocAcknowledgements = 144

DocAfterword = 145

DocAppendix = 146

DocBackLink = 147

DocBiblioEntry = 148

DocBibliography = 149

DocBiblioRef = 150

DocChapter = 151

DocColophon = 152

DocConclusion = 153

DocCover = 154

DocCredit = 155

DocCredits = 156

DocDedication = 157

DocEndnote = 158

DocEndnotes = 159

DocEpigraph = 160

DocEpilogue = 161

DocErrata = 162

DocExample = 163

DocFootnote = 164

DocForeword = 165

DocGlossary = 166

DocGlossRef = 167

DocIndex = 168

DocIntroduction = 169

DocNoteRef = 170

DocNotice = 171

DocPageBreak = 172

DocPageFooter = 173

DocPageHeader = 174

DocPageList = 175

DocPart = 176

DocPreface = 177

DocPrologue = 178

DocPullquote = 179

DocQna = 180

DocSubtitle = 181

DocTip = 182

DocToc = 183

ListGrid = 184

Behaves similar to an ARIA grid but is primarily used by Chromium’s TableView and its subclasses, so they can be exposed correctly on certain platforms.

Terminal = 185

This is just like a multi-line document, but signals that assistive technologies should implement behavior specific to a VT-100-style terminal.

Implementations

impl Role

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

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl Default for Role

fn default() -> Role

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Role

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Role

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 Role

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

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 Role

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Role

fn eq(&self, other: &Role) -> 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 for Role

fn partial_cmp(&self, other: &Role) -> 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 Role

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 Role

impl Eq for Role

impl StructuralPartialEq for Role