Enum AccessibleRole

#[non_exhaustive]
pub enum AccessibleRole {
    Alert,
    AlertDialog,
    Banner,
    Button,
    Caption,
    Cell,
    Checkbox,
    ColumnHeader,
    ComboBox,
    Command,
    Composite,
    Dialog,
    Document,
    Feed,
    Form,
    Generic,
    Grid,
    GridCell,
    Group,
    Heading,
    Img,
    Input,
    Label,
    Landmark,
    Legend,
    Link,
    List,
    ListBox,
    ListItem,
    Log,
    Main,
    Marquee,
    Math,
    Meter,
    Menu,
    MenuBar,
    MenuItem,
    MenuItemCheckbox,
    MenuItemRadio,
    Navigation,
    None,
    Note,
    Option,
    Presentation,
    ProgressBar,
    Radio,
    RadioGroup,
    Range,
    Region,
    Row,
    RowGroup,
    RowHeader,
    Scrollbar,
    Search,
    SearchBox,
    Section,
    SectionHead,
    Select,
    Separator,
    Slider,
    SpinButton,
    Status,
    Structure,
    Switch,
    Tab,
    Table,
    TabList,
    TabPanel,
    TextBox,
    Time,
    Timer,
    Toolbar,
    Tooltip,
    Tree,
    TreeGrid,
    TreeItem,
    Widget,
    Window,
    ToggleButton,
    Application,
    Paragraph,
    BlockQuote,
    Article,
    Comment,
    Terminal,
}

The accessible role for a Accessible implementation.

Abstract roles are only used as part of the ontology; application developers must not use abstract roles in their code.

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.

Alert

An element with important, and usually time-sensitive, information

AlertDialog

A type of dialog that contains an alert message

Banner

Unused

Button

An input element that allows for user-triggered actions when clicked or pressed

Caption

Unused

Cell

Unused

Checkbox

A checkable input element that has three possible values: true, false, or mixed

ColumnHeader

A header in a columned list.

ComboBox

An input that controls another element, such as a list or a grid, that can dynamically pop up to help the user set the value of the input

Command

Abstract role.

Composite

Abstract role.

Dialog

A dialog is a window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response.

Document

Content that assistive technology users may want to browse in a reading mode.

Feed

Unused

Form

Unused

Generic

A nameless container that has no semantic meaning of its own. This is the role that GTK uses by default for widgets.

Grid

A grid of items.

GridCell

An item in a grid or tree grid.

Group

An element that groups multiple related widgets. GTK uses this role for various containers, like HeaderBar or Notebook.

Heading

Unused

Img

An image.

Input

Abstract role.

Label

A visible name or caption for a user interface component.

Landmark

Abstract role.

Legend

Unused

Link

A clickable link.

List

A list of items.

ListBox

Unused.

ListItem

An item in a list.

Log

Unused

Main

Unused

Marquee

Unused

Math

Unused

Meter

An element that represents a value within a known range.

Menu

A menu.

MenuBar

A menubar.

MenuItem

An item in a menu.

MenuItemCheckbox

A check item in a menu.

MenuItemRadio

A radio item in a menu.

Navigation

Unused

None

An element that is not represented to accessibility technologies. This role is synonymous to @GTK_ACCESSIBLE_ROLE_PRESENTATION.

Note

Unused

Option

Unused

Presentation

An element that is not represented to accessibility technologies. This role is synonymous to @GTK_ACCESSIBLE_ROLE_NONE.

ProgressBar

An element that displays the progress status for tasks that take a long time.

Radio

A checkable input in a group of radio roles, only one of which can be checked at a time.

RadioGroup

Unused

Range

Abstract role.

Region

Unused

Row

A row in a columned list.

RowGroup

Unused

RowHeader

Unused

Scrollbar

A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area.

Search

Unused

SearchBox

A type of textbox intended for specifying search criteria.

Section

Abstract role.

SectionHead

Abstract role.

Select

Abstract role.

Separator

A divider that separates and distinguishes sections of content or groups of menuitems.

Slider

A user input where the user selects a value from within a given range.

SpinButton

A form of range that expects the user to select from among discrete choices.

Status

Unused

Structure

Abstract role.

Switch

A type of checkbox that represents on/off values, as opposed to checked/unchecked values.

Tab

An item in a list of tab used for switching pages.

Table

Unused

TabList

A list of tabs for switching pages.

TabPanel

A page in a notebook or stack.

TextBox

A type of input that allows free-form text as its value.

Time

Unused

Timer

Unused

Toolbar

Unused

Tooltip

Unused

Tree

Unused

TreeGrid

A treeview-like, columned list.

TreeItem

Unused

Widget

Abstract role for interactive components of a graphical user interface

Window

Abstract role for windows.

ToggleButton

Available on crate feature v4_10 only.

A type of push button which stays pressed until depressed by a second activation.

Application

Available on crate feature v4_12 only.

A toplevel element of a graphical user interface.

This is the role that GTK uses by default for windows.

Paragraph

Available on crate feature v4_14 only.

A paragraph of content.

BlockQuote

Available on crate feature v4_14 only.

A section of content that is quoted from another source.

Article

Available on crate feature v4_14 only.

A section of a page that consists of a composition that forms an independent part of a document, page, or site.

Comment

Available on crate feature v4_14 only.

A comment contains content expressing reaction to other content.

Terminal

Available on crate feature v4_14 only.

A virtual terminal.

Trait Implementations

impl Clone for AccessibleRole

fn clone(&self) -> AccessibleRole

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessibleRole

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

Formats the value using the given formatter.

impl From<AccessibleRole> for Value

fn from(v: AccessibleRole) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for AccessibleRole

type Checker = GenericValueTypeChecker<AccessibleRole>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for AccessibleRole

type ParamSpec = ParamSpecEnum

type SetValue = AccessibleRole

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: AccessibleRole) -> ParamSpecEnumBuilder<'_, AccessibleRole>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AccessibleRole

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 Ord for AccessibleRole

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for AccessibleRole

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for AccessibleRole

type Type = AccessibleRole

Type to get the Type from.

impl Copy for AccessibleRole

impl Eq for AccessibleRole

impl StructuralPartialEq for AccessibleRole