Skip to main content

Module screen_reader_chord

Module screen_reader_chord 

Expand description

The chord that turns the screen reader on and off on every screen: Ctrl + Super + Enter, and on a device without a keyboard both volume keys held for three seconds (docs/security/sign-in.md §3.4).

One recognizer for every host, so no screen can lack the chord or read it differently: toolkit apps feed it winit’s key events (ChordKey::from_winit), the compositor and the KMS/libinput host feed it xkbcommon keysyms (ChordKey::from_keysym). It is pure: the host passes the time of each event and arms a timer for ScreenReaderChord::deadline, then calls ScreenReaderChord::tick when it fires.

Structs§

ChordEvent
One key going down or up.
ChordModifiers
The modifiers held with a key. The chord wants exactly Ctrl and Super.
ScreenReaderChord
Recognizes the screen reader chord over a host’s key events.

Enums§

ChordKey
The keys the chord is made of; every other key is ChordKey::Other.

Constants§

VOLUME_HOLD
How long both volume keys are held before the screen reader toggles.

Functions§

state_words
What is said when the chord turns the screen reader on or off, in the interface language; English when no catalog is loaded.