Enum atspi::RelationType

source ·
pub enum RelationType {
Show 23 variants Null = 0, LabelFor = 1, LabelledBy = 2, ControllerFor = 3, ControlledBy = 4, MemberOf = 5, TooltipFor = 6, NodeChildOf = 7, NodeParentOf = 8, Extended = 9, FlowsTo = 10, FlowsFrom = 11, SubwindowOf = 12, Embeds = 13, EmbeddedBy = 14, PopupFor = 15, ParentWindowOf = 16, DescriptionFor = 17, DescribedBy = 18, Details = 19, DetailsFor = 20, ErrorMessage = 21, ErrorFor = 22,
}
Expand description

Describes a relationship between one object and another.

Variants§

§

Null = 0

Not a meaningful relationship; clients should not normally encounter this value.

§

LabelFor = 1

Object is a label for one or more other objects.

§

LabelledBy = 2

Object is labelled by one or more other objects.

§

ControllerFor = 3

Object is an interactive object which modifies the state, onscreen location, or other attributes of one or more target objects.

§

ControlledBy = 4

Object state, position, etc. is modified/controlled by user interaction with one or more other objects. For instance a viewport or scroll pane may be ControlledBy scrollbars.

§

MemberOf = 5

Object has a grouping relationship (e.g. ‘same group as’) to one or more other objects.

§

TooltipFor = 6

Object is a tooltip associated with another object.

§

NodeChildOf = 7

Object is a child of the target.

§

NodeParentOf = 8

Object is a parent of the target.

§

Extended = 9

Used to indicate that a relationship exists, but its type is not specified in the enumeration.

§

FlowsTo = 10

Object renders content which flows logically to another object. For instance, text in a paragraph may flow to another object which is not the ‘next sibling’ in the accessibility hierarchy.

§

FlowsFrom = 11

Reciprocal of FlowsTo.

§

SubwindowOf = 12

Object is visually and semantically considered a subwindow of another object, even though it is not the object’s child. Useful when dealing with embedded applications and other cases where the widget hierarchy does not map cleanly to the onscreen presentation.

§

Embeds = 13

Similar to SubwindowOf, but specifically used for cross-process embedding.

§

EmbeddedBy = 14

Reciprocal of Embeds. Used to denote content rendered by embedded renderers that live in a separate process space from the embedding context.

§

PopupFor = 15

Denotes that the object is a transient window or frame associated with another onscreen object. Similar to TooltipFor, but more general. Useful for windows which are technically toplevels but which, for one or more reasons, do not explicitly cause their associated window to lose ‘window focus’. Creation of an crate::Role::Window object with the PopupFor relation usually requires some presentation action on the part of assistive technology clients, even though the previous toplevel crate::Role::Frame object may still be the active window.

§

ParentWindowOf = 16

This is the reciprocal relation to PopupFor.

§

DescriptionFor = 17

Reciprocal of DescribedBy. Indicates that this object provides descriptive information about the target object(s). See also DetailsFor and ErrorFor.

§

DescribedBy = 18

Reciprocal of DescriptionFor. Indicates that one or more target objects provide descriptive information about this object. This relation type is most appropriate for information that is not essential as its presentation may be user-configurable and/or limited to an on-demand mechanism such as an assistive technology command. For brief, essential information such as can be found in a widget’s on-screen label, use LabelledBy. For an on-screen error message, use ErrorMessage. For lengthy extended descriptive information contained in an on-screen object, consider using Details as assistive technologies may provide a means for the user to navigate to objects containing detailed descriptions so that their content can be more closely reviewed.

§

Details = 19

Reciprocal of DetailsFor. Indicates that this object has a detailed or extended description, the contents of which can be found in the target object(s). This relation type is most appropriate for information that is sufficiently lengthy as to make navigation to the container of that information desirable. For less verbose information suitable for announcement only, see DescribedBy. If the detailed information describes an error condition, ErrorFor should be used instead. Included in upstream AT-SPI2-CORE since 2.26.

§

DetailsFor = 20

Reciprocal of Details. Indicates that this object provides a detailed or extended description about the target object(s). See also DescriptionFor and ErrorFor. Included in upstream AT-SPI2-CORE since 2.26.

§

ErrorMessage = 21

Reciprocal of ErrorFor. Indicates that this object has one or more errors, the nature of which is described in the contents of the target object(s). Objects that have this relation type should also contain crate::state::State::InvalidEntry when their GetState method is called.
Included in upstream AT-SPI2-CORE since 2.26.

§

ErrorFor = 22

Reciprocal of ErrorMessage. Indicates that this object contains an error message describing an invalid condition in the target object(s). Included in upstream AT-SPI2-CORE since 2.26.

Trait Implementations§

source§

impl Clone for RelationType

source§

fn clone(&self) -> RelationType

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RelationType

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for RelationType

source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<RelationType, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Hash for RelationType

source§

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
source§

impl PartialEq for RelationType

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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.
source§

impl Serialize for RelationType

source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Type for RelationType

source§

fn signature() -> Signature<'static>

Get the signature for the implementing type. Read more
source§

impl Copy for RelationType

source§

impl Eq for RelationType

source§

impl StructuralPartialEq for RelationType

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<'de, T> DynamicDeserialize<'de> for T
where T: Type + Deserialize<'de> + ?Sized,

§

type Deserializer = PhantomData<T>

A DeserializeSeed implementation for this type.
source§

fn deserializer_for_signature<S>( signature: S, ) -> Result<<T as DynamicDeserialize<'de>>::Deserializer, Error>
where S: TryInto<Signature<'de>>, <S as TryInto<Signature<'de>>>::Error: Into<Error>,

Get a deserializer compatible with this signature.
source§

impl<T> DynamicType for T
where T: Type + ?Sized,

source§

fn dynamic_signature(&self) -> Signature<'_>

Get the signature for the implementing type. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,