Enum Role 

#[repr(u8)]
pub enum Role {
    Unknown = 0,
    TextRun = 1,
    Cell = 2,
    Label = 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,
    Details = 65,
    Dialog = 66,
    DisclosureTriangle = 67,
    Document = 68,
    EmbeddedObject = 69,
    Emphasis = 70,
    Feed = 71,
    FigureCaption = 72,
    Figure = 73,
    Footer = 74,
    Form = 75,
    Grid = 76,
    GridCell = 77,
    Group = 78,
    Header = 79,
    Heading = 80,
    Iframe = 81,
    IframePresentational = 82,
    ImeCandidate = 83,
    Keyboard = 84,
    Legend = 85,
    LineBreak = 86,
    ListBox = 87,
    Log = 88,
    Main = 89,
    Mark = 90,
    Marquee = 91,
    Math = 92,
    MenuBar = 93,
    MenuItemCheckBox = 94,
    MenuItemRadio = 95,
    MenuListPopup = 96,
    Meter = 97,
    Navigation = 98,
    Note = 99,
    PluginObject = 100,
    ProgressIndicator = 101,
    RadioGroup = 102,
    Region = 103,
    RootWebArea = 104,
    Ruby = 105,
    RubyAnnotation = 106,
    ScrollBar = 107,
    ScrollView = 108,
    Search = 109,
    Section = 110,
    SectionFooter = 111,
    SectionHeader = 112,
    Slider = 113,
    SpinButton = 114,
    Splitter = 115,
    Status = 116,
    Strong = 117,
    Suggestion = 118,
    SvgRoot = 119,
    Tab = 120,
    TabList = 121,
    TabPanel = 122,
    Term = 123,
    Time = 124,
    Timer = 125,
    TitleBar = 126,
    Toolbar = 127,
    Tooltip = 128,
    Tree = 129,
    TreeGrid = 130,
    Video = 131,
    WebView = 132,
    Window = 133,
    PdfActionableHighlight = 134,
    PdfRoot = 135,
    GraphicsDocument = 136,
    GraphicsObject = 137,
    GraphicsSymbol = 138,
    DocAbstract = 139,
    DocAcknowledgements = 140,
    DocAfterword = 141,
    DocAppendix = 142,
    DocBackLink = 143,
    DocBiblioEntry = 144,
    DocBibliography = 145,
    DocBiblioRef = 146,
    DocChapter = 147,
    DocColophon = 148,
    DocConclusion = 149,
    DocCover = 150,
    DocCredit = 151,
    DocCredits = 152,
    DocDedication = 153,
    DocEndnote = 154,
    DocEndnotes = 155,
    DocEpigraph = 156,
    DocEpilogue = 157,
    DocErrata = 158,
    DocExample = 159,
    DocFootnote = 160,
    DocForeword = 161,
    DocGlossary = 162,
    DocGlossRef = 163,
    DocIndex = 164,
    DocIntroduction = 165,
    DocNoteRef = 166,
    DocNotice = 167,
    DocPageBreak = 168,
    DocPageFooter = 169,
    DocPageHeader = 170,
    DocPageList = 171,
    DocPart = 172,
    DocPreface = 173,
    DocPrologue = 174,
    DocPullquote = 175,
    DocQna = 176,
    DocSubtitle = 177,
    DocTip = 178,
    DocToc = 179,
    ListGrid = 180,
    Terminal = 181,
}

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

TextRun = 1

Cell = 2

Label = 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

Details = 65

Dialog = 66

DisclosureTriangle = 67

Document = 68

EmbeddedObject = 69

Emphasis = 70

Feed = 71

FigureCaption = 72

Figure = 73

Footer = 74

Form = 75

Grid = 76

GridCell = 77

Group = 78

Header = 79

Heading = 80

Iframe = 81

IframePresentational = 82

ImeCandidate = 83

Keyboard = 84

Legend = 85

LineBreak = 86

ListBox = 87

Log = 88

Main = 89

Mark = 90

Marquee = 91

Math = 92

MenuBar = 93

MenuItemCheckBox = 94

MenuItemRadio = 95

MenuListPopup = 96

Meter = 97

Navigation = 98

Note = 99

PluginObject = 100

ProgressIndicator = 101

RadioGroup = 102

Region = 103

RootWebArea = 104

Ruby = 105

RubyAnnotation = 106

ScrollBar = 107

ScrollView = 108

Search = 109

Section = 110

SectionFooter = 111

SectionHeader = 112

Slider = 113

SpinButton = 114

Splitter = 115

Status = 116

Strong = 117

Suggestion = 118

SvgRoot = 119

Tab = 120

TabList = 121

TabPanel = 122

Term = 123

Time = 124

Timer = 125

TitleBar = 126

Toolbar = 127

Tooltip = 128

Tree = 129

TreeGrid = 130

Video = 131

WebView = 132

Window = 133

PdfActionableHighlight = 134

PdfRoot = 135

GraphicsDocument = 136

GraphicsObject = 137

GraphicsSymbol = 138

DocAbstract = 139

DocAcknowledgements = 140

DocAfterword = 141

DocAppendix = 142

DocBackLink = 143

DocBiblioEntry = 144

DocBibliography = 145

DocBiblioRef = 146

DocChapter = 147

DocColophon = 148

DocConclusion = 149

DocCover = 150

DocCredit = 151

DocCredits = 152

DocDedication = 153

DocEndnote = 154

DocEndnotes = 155

DocEpigraph = 156

DocEpilogue = 157

DocErrata = 158

DocExample = 159

DocFootnote = 160

DocForeword = 161

DocGlossary = 162

DocGlossRef = 163

DocIndex = 164

DocIntroduction = 165

DocNoteRef = 166

DocNotice = 167

DocPageBreak = 168

DocPageFooter = 169

DocPageHeader = 170

DocPageList = 171

DocPart = 172

DocPreface = 173

DocPrologue = 174

DocPullquote = 175

DocQna = 176

DocSubtitle = 177

DocTip = 178

DocToc = 179

ListGrid = 180

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 = 181

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 duplicate 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() -> Cow<'static, str>

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(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being 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,

Restrict a value to a certain interval.

impl PartialEq for Role

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

Tests for self and other values to be equal, and is used by ==.

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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