Struct SemanticsConfiguration 

pub struct SemanticsConfiguration {

    pub content_description: Option<String>,
    pub state_description: Option<String>,
    pub on_click_label: Option<String>,
    pub role: Option<SemanticsWidgetRole>,
    pub selected: Option<bool>,
    pub toggled: Option<bool>,
    pub enabled: bool,
    pub is_clickable: bool,
    pub is_editable_text: bool,
    pub text: Option<String>,
    pub text_selection: Option<TextRange>,
    pub custom_actions: Vec<SemanticsCustomAction>,
    pub canvas_children: Vec<CanvasSemanticsNode>,
    pub is_modal: bool,
    pub hidden: bool,
    pub merge_descendants: bool,
    pub selectable_group: bool,
    pub pane_title: Option<String>,
    pub live_region: Option<LiveRegionMode>,
    pub progress: Option<ProgressBarRangeInfo>,
    pub set_progress: Option<SemanticsSetProgress>,
    pub set_text: Option<SemanticsSetText>,
    pub vertical_scroll: Option<ScrollAxisRange>,
    pub horizontal_scroll: Option<ScrollAxisRange>,
    pub scroll_by: Option<SemanticsScrollBy>,
    pub collection: Option<CollectionInfo>,
}

Semantics configuration for accessibility.

Fields

content_description: Option<String>

state_description: Option<String>

Compose’s stateDescription.

on_click_label: Option<String>

Compose’s onClick(label = …); implies clickable.

role: Option<SemanticsWidgetRole>

Compose’s Role.

selected: Option<bool>

toggled: Option<bool>

enabled: bool

is_clickable: bool

is_editable_text: bool

text: Option<String>

The text an editable field holds, read as its value. Compose’s editableText.

text_selection: Option<TextRange>

custom_actions: Vec<SemanticsCustomAction>

canvas_children: Vec<CanvasSemanticsNode>

Controls this node drew itself instead of laying out. See CanvasSemanticsNode.

is_modal: bool

Whether this node takes over the screen: everything outside it is inert, and a screen reader keeps its traversal inside.

hidden: bool

Whether a screen reader skips this node and everything under it: a decorative image, or a placeholder drawn under a named field. Compose’s hideFromAccessibility.

merge_descendants: bool

Whether a screen reader takes this node and the text under it as one stop, the way it does for a button: a row whose name, count and price belong together. Compose’s mergeDescendants.

selectable_group: bool

Whether the selectable controls under this node form one group, so a screen reader says which of how many a tab or a radio button is. Compose’s selectableGroup.

pane_title: Option<String>

The title of the screen or pane this node is the root of, read out when the app moves to it. Compose’s paneTitle.

live_region: Option<LiveRegionMode>

Compose’s liveRegion. When set, a screen reader reads this node again whenever its text changes, without the user moving to it.

progress: Option<ProgressBarRangeInfo>

Compose’s progressBarRangeInfo. A control with it is adjustable: a screen reader offers its own way to move the value.

set_progress: Option<SemanticsSetProgress>

What the control does when a screen reader moves its value. Compose’s setProgress.

set_text: Option<SemanticsSetText>

What this field does when a screen reader or a voice tool hands it text. Compose’s setText.

vertical_scroll: Option<ScrollAxisRange>

How far this container scrolled up and down. Compose’s verticalScrollAxisRange.

horizontal_scroll: Option<ScrollAxisRange>

How far this container scrolled left and right. Compose’s horizontalScrollAxisRange.

scroll_by: Option<SemanticsScrollBy>

What this container does when a screen reader pages it. Compose’s scrollBy.

collection: Option<CollectionInfo>

How many rows and columns this list holds. Compose’s collectionInfo.

Implementations

impl SemanticsConfiguration

pub fn merge(&mut self, other: &SemanticsConfiguration)

pub fn is_activatable(&self) -> bool

Whether a screen reader should offer activation. A named click label is how Compose declares onClick, so it implies the action the same way.

Trait Implementations

impl Clone for SemanticsConfiguration

fn clone(&self) -> SemanticsConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SemanticsConfiguration

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

Formats the value using the given formatter.

impl Default for SemanticsConfiguration

fn default() -> SemanticsConfiguration

Returns the “default value” for a type.

impl PartialEq for SemanticsConfiguration

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SemanticsConfiguration