Struct Semantics 

pub struct Semantics { /* private fields */ }

How a node appears to screen readers: its Role, name and state.

Built-in components set this themselves. Custom components call BuildCx::semantics on the node they return:

use ravenrs_core::Role;
use ravenrs_widgets::Semantics;

let s = Semantics::new(Role::Switch).name("Wi-Fi").toggled(true);
assert_eq!(s.role(), Role::Switch);

Without semantics, a focusable node is announced as a button named by the text inside it, text is announced as a label, and other boxes are transparent: their children belong to the nearest described ancestor.

Implementations

impl Semantics

pub fn new(role: Role) -> Semantics

A node with this role, named by its content when the role allows it.

pub fn hidden() -> Semantics

Hides the node and everything inside it from assistive technology (decorations, duplicated content).

pub fn role(&self) -> Role

The role.

pub fn name(self, name: impl Into<String>) -> Semantics

Sets the accessible name, replacing the name from content.

pub fn description(self, description: impl Into<String>) -> Semantics

Sets a description, read after the name.

pub fn value(self, value: impl Into<String>) -> Semantics

Sets a text value (text fields, combo boxes).

pub fn numeric( self, value: f64, min: f64, max: f64, step: Option<f64>, ) -> Semantics

Sets a numeric value and its range.

pub fn toggled(self, toggled: impl Into<Toggled>) -> Semantics

Sets the checked state.

pub fn selected(self, selected: bool) -> Semantics

Sets the selected state.

pub fn expanded(self, expanded: bool) -> Semantics

Sets the expanded state.

pub fn disabled(self, disabled: bool) -> Semantics

Marks the control as not responding to input.

pub fn read_only(self, read_only: bool) -> Semantics

Marks the control’s value as readable but not changeable.

pub fn modal(self) -> Semantics

Marks a dialog as modal.

pub fn active(self, active: bool) -> Semantics

Marks the option highlighted in a list that a focused text field drives (combobox pattern), so screen readers announce it.

pub fn level(self, level: u32) -> Semantics

Sets the heading level (1 to 6).

Trait Implementations

impl Clone for Semantics

fn clone(&self) -> Semantics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Semantics

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

Formats the value using the given formatter.

impl PartialEq for Semantics

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Semantics