Expand description
atspi root crate, which may bring in various subcrates:
atspi_common(required)atspi_proxies(with use ofproxiesfeature flag)atspi_connection(with use ofconnectionfeature flag)zbusre-export (with use ofzbusfeature flag)
Re-exports§
pub use atspi_proxies as proxy;pub use atspi_connection as connection;
Modules§
- action
- cache
- Common types for
org.a11y.atspi.Cacheevents. - error
- events
- interface
- Conversion functions and types representing a set of
Interfaces. - object_
match - object_
ref - operation
- state
Structs§
- Accessibility
Connection - A connection to the at-spi bus
- Action
- An action which may be triggered through the accessibility API.
- Cache
Item - The item type provided by
Cache:Addsignals - Interface
Set - A collection type which encodes the AT-SPI interfaces an accessible object has implemented.
- Legacy
Cache Item - The item type provided by
Cache:Addsignals - Object
Match Rule - Definition of match rules for accessible objects. Rule(s) against which we can match an object or a collection thereof.
- Object
RefOwned - A wrapper around the static variant of
ObjectRef. This is guaranteed to have a'staticlifetime. - State
Set - The bitflag representation of all states an object may have.
- Text
Selection - Describes a selection of text, including selections across object boundaries.
Enums§
- Atspi
Error - An error type that can describe atspi and
stdand differentzbuserrors. - Cache
Events - All events related to the
org.a11y.atspi.Cacheinterface. Note that these are not telling the client that an item has been added to a cache. It is telling the client “here is a bunch of information to store it in your cache”. - Clip
Type - Enumeration used by
TextProxyto indicate how to treat characters intersecting bounding boxes. - Coord
Type - The coordinate type encodes the frame of reference.
- Document
Events - Event
- Encapsulates the various different accessibility bus signal types.
- Event
Listener Events - The events that can be emitted by the registry daemon.
This enum is used to wrap the events that are emitted by the registry daemon.
The events are
EventListenerRegisteredEventandEventListenerDeregisteredEvent. - Focus
Events - Granularity
- Level of granularity to get text of, in relation to a cursor position.
- Interface
- AT-SPI interfaces an accessible object can implement.
- Keyboard
Events - Layer
- Indicates relative stacking order of a
atspi_proxies::component::ComponentProxywith respect to the onscreen visual representation of the UI. - Match
Type - Enumeration used by
ObjectMatchRuleto specify how to interpretObjectRefobjects. - Mouse
Events - Object
Events - Object
Ref - A unique identifier for an object in the accessibility tree.
- Operation
- An operation can either be
Self::InsertorSelf::Delete. These correspond to methods available onVec. - Politeness
- Enumeration used to indicate a type of live region and how assertive it should be in terms of speaking notifications.
- Relation
Type - Describes a relationship between one object and another.
- Role
- An accessible object role.
- Scroll
Type - Enumeration used by interface the
crate::interface::Interface::Accessibleto specify where an object should be placed on the screen when usingscroll_to. - Sort
Order - Enumeration used by interface
CollectionProxyto specify the wayObjectRefobjects should be sorted. - State
- Used by various interfaces indicating every possible state of an accessibility object.
- Terminal
Events - All events related to the
org.a11y.atspi.Event.Terminalinterface. - Tree
Traversal Type - Defines how an object-tree is to be traversed.
Used in
CollectionProxy. - Window
Events - All events on the
org.a11y.atspi.Event.Windowinterface.
Traits§
- Event
Properties EventPropertiesallows access to the internals of an event, specifically:- Event
Type Properties - Describes properties of a specific event type.