Enum atk::RelationType

#[non_exhaustive]
pub enum RelationType {
    Null,
    ControlledBy,
    ControllerFor,
    LabelFor,
    LabelledBy,
    MemberOf,
    NodeChildOf,
    FlowsTo,
    FlowsFrom,
    SubwindowOf,
    Embeds,
    EmbeddedBy,
    PopupFor,
    ParentWindowOf,
    DescribedBy,
    DescriptionFor,
    NodeParentOf,
    Details,
    DetailsFor,
    ErrorMessage,
    ErrorFor,
    LastDefined,
    // some variants omitted
}

Describes the type of the relation

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

Not used, represens “no relationship” or an error condition.

ControlledBy

Indicates an object controlled by one or more target objects.

ControllerFor

Indicates an object is an controller for one or more target objects.

LabelFor

Indicates an object is a label for one or more target objects.

LabelledBy

Indicates an object is labelled by one or more target objects.

MemberOf

Indicates an object is a member of a group of one or more target objects.

NodeChildOf

Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.

FlowsTo

Indicates that the object has content that flows logically to another AtkObject in a sequential way, (for instance text-flow).

FlowsFrom

Indicates that the object has content that flows logically from another AtkObject in a sequential way, (for instance text-flow).

SubwindowOf

Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component.

Embeds

Indicates that the object visually embeds another object’s content, i.e. this object’s content flows around another’s content.

EmbeddedBy

Reciprocal of Embeds, indicates that this object’s content is visualy embedded in another object.

PopupFor

Indicates that an object is a popup for another object.

ParentWindowOf

Indicates that an object is a parent window of another object.

DescribedBy

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.

DescriptionFor

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

NodeParentOf

Indicates an object is a cell in a treetable and is expanded to display other cells in the same column.

Details

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. Since: ATK-2.26.

DetailsFor

Reciprocal of Details. Indicates that this object provides a detailed or extended description about the target object(s). See also DescriptionFor and ErrorFor. Since: ATK-2.26.

ErrorMessage

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 StateType::InvalidEntry in their StateSet. Since: ATK-2.26.

ErrorFor

Reciprocal of ErrorMessage. Indicates that this object contains an error message describing an invalid condition in the target object(s). Since: ATK_2.26.

LastDefined

Not used, this value indicates the end of the enumeration.

Implementations

impl RelationType

pub fn for_name(name: &str) -> RelationType

pub fn name(self) -> Option<GString>

Trait Implementations

impl Clone for RelationType

fn clone(&self) -> RelationType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelationType

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

Formats the value using the given formatter.

impl Display for RelationType

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

Formats the value using the given formatter.

impl<'a> FromValue<'a> for RelationType

type Checker = GenericValueTypeChecker<Self>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl Hash for RelationType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for RelationType

fn cmp(&self, other: &RelationType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RelationType> for RelationType

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<RelationType> for RelationType

fn partial_cmp(&self, other: &RelationType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for RelationType

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for RelationType

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ValueType for RelationType

type Type = Self

Type to get the Type from.

impl Copy for RelationType

impl Eq for RelationType

impl StructuralEq for RelationType

impl StructuralPartialEq for RelationType