Skip to main content

AccessibleRole

slint::language

Enum AccessibleRole

#[non_exhaustive]
#[repr(u32)]pub enum AccessibleRole {
Show 29 variants    None = 0,
    Button = 1,
    Checkbox = 2,
    Combobox = 3,
    Groupbox = 4,
    Image = 5,
    List = 6,
    Slider = 7,
    Spinbox = 8,
    Tab = 9,
    TabList = 10,
    TabPanel = 11,
    Text = 12,
    Table = 13,
    Tree = 14,
    ProgressIndicator = 15,
    TextInput = 16,
    Switch = 17,
    ListItem = 18,
    RadioButton = 19,
    RadioGroup = 20,
    Banner = 21,
    Complementary = 22,
    ContentInfo = 23,
    Form = 24,
    Main = 25,
    Navigation = 26,
    Region = 27,
    Search = 28,
}

Expand description

This enum represents the different values for the accessible-role property, used to describe the role of an element in the context of assistive technology such as screen readers.

In addition to widget roles, this enum includes landmark roles (banner, complementary, content-info, form, main, navigation, region, search). Landmarks identify large content areas that screen reader users can jump between, giving the application a navigable structure similar to headings in a document. See WAI-ARIA Landmark Regions for guidance on when and how to use them.

Variants (Non-exhaustive)§

This enum is marked as 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.

None = 0

The element isn’t accessible.

Button = 1

The element is a Button or behaves like one.

Checkbox = 2

The element is a CheckBox or behaves like one.

Combobox = 3

The element is a ComboBox or behaves like one.

Groupbox = 4

The element is a GroupBox or behaves like one.

Image = 5

The element is an Image or behaves like one. This is automatically applied to Image elements.

List = 6

The element is a ListView or behaves like one.

Slider = 7

The element is a Slider or behaves like one.

Spinbox = 8

The element is a SpinBox or behaves like one.

Tab = 9

The element is a Tab or behaves like one.

TabList = 10

The element is similar to the tab bar in a TabWidget.

TabPanel = 11

The element is a container for tab content.

Text = 12

The role for a Text element. This is automatically applied to Text elements.

Table = 13

The role for a TableView or behaves like one.

Tree = 14

The role for a TreeView or behaves like one. (Not provided yet)

ProgressIndicator = 15

The element is a ProgressIndicator or behaves like one.

TextInput = 16

The role for widget with editable text such as a LineEdit or a TextEdit. This is automatically applied to TextInput elements.

Switch = 17

The element is a Switch or behaves like one.

ListItem = 18

The element is an item in a ListView.

RadioButton = 19

The element is a RadioButton or behaves like one.

RadioGroup = 20

The element is a container grouping related RadioButtons.

Landmark: the header area of the application, typically containing a logo, title, or global navigation.

Complementary = 22

Landmark: a supporting section that complements the main content, such as a sidebar.

ContentInfo = 23

Landmark: information about the application or its content, typically at the bottom (e.g. status bar, copyright).

Form = 24

Landmark: a region containing input fields and controls for submitting information.

Main = 25

Landmark: the primary content of the application. Each view should have exactly one main landmark.

Landmark: a group of links or controls used for navigating the application.

Region = 27

Landmark: a generic section significant enough to be listed in a summary. Use a more specific landmark if one applies.

Search = 28

Landmark: a region containing controls for searching or filtering content.

Trait Implementations§

impl Clone for AccessibleRole

fn clone(&self) -> AccessibleRole

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for AccessibleRole

impl Debug for AccessibleRole

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

Formats the value using the given formatter. Read more

impl Default for AccessibleRole

fn default() -> AccessibleRole

Returns the “default value” for a type. Read more

impl Display for AccessibleRole

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

Formats the value using the given formatter. Read more

impl Eq for AccessibleRole

impl From<AccessibleRole> for Value

fn from(v: AccessibleRole) -> Value

Converts to this type from the input type.

impl FromStr for AccessibleRole

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<AccessibleRole, <AccessibleRole as FromStr>::Err>

Parses a string s to return a value of this type. Read more

impl Hash for AccessibleRole

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for AccessibleRole

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

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

1.0.0 (const: unstable) · Source§

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

impl TryFrom<&str> for AccessibleRole

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<AccessibleRole, <AccessibleRole as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Value> for AccessibleRole

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<AccessibleRole, ()>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for AccessibleRole

impl RefUnwindSafe for AccessibleRole

impl Send for AccessibleRole

impl Sync for AccessibleRole

impl Unpin for AccessibleRole

impl UnsafeUnpin for AccessibleRole

impl UnwindSafe for AccessibleRole

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Brush for T
where T: Clone + PartialEq + Default + Debug,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> NoneValue for T
where T: Default,

type NoneType = T

fn null_value() -> T

The none-equivalent value.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSharedString for T
where T: Display + ?Sized,

fn to_shared_string(&self) -> SharedString

Converts the given value to a SharedString.

impl<T> ToSmolStr for T
where T: Display + ?Sized,

fn to_smolstr(&self) -> SmolStr

impl<T> ToSmolStr for T
where T: Display + ?Sized,

fn to_smolstr(&self) -> SmolStr

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

impl<T> WasmNotSync for T
where T: Sync,

impl<T> WasmNotSync for T
where T: Sync,

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more