Struct atk::Socket

#[repr(transparent)]
pub struct Socket { /* private fields */ }

Container for AtkPlug objects from other processes

Together with Plug, Socket provides the ability to embed accessibles from one process into another in a fashion that is transparent to assistive technologies. Socket works as the container of Plug, embedding it using the method AtkSocketExt::embed(). Any accessible contained in the Plug will appear to the assistive technologies as being inside the application that created the Socket.

The communication between a Socket and a Plug is done by the IPC layer of the accessibility framework, normally implemented by the D-Bus based implementation of AT-SPI (at-spi2). If that is the case, at-spi-atk2 is the responsible to implement the abstract methods AtkPlugExt::id() and AtkSocketExt::embed(), so an ATK implementor shouldn’t reimplement them. The process that contains the Plug is responsible to send the ID returned by atk_plug_id() to the process that contains the Socket, so it could call the method AtkSocketExt::embed() in order to embed it.

For the same reasons, an implementor doesn’t need to implement AtkObjectExt::n_accessible_children() and AtkObjectExt::ref_accessible_child(). All the logic related to those functions will be implemented by the IPC layer.

See [classPlug]

Implements

AtkSocketExt, AtkObjectExt, glib::ObjectExt, ComponentExt

Implementations

impl Socket

pub const NONE: Option<&'static Socket> = None

pub fn new() -> Socket

Creates a new Socket.

Returns

the newly created Socket instance

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Socket

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

Formats the value using the given formatter.

impl Default for Socket

fn default() -> Self

Returns the “default value” for a type.

impl Display for Socket

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

Formats the value using the given formatter.

impl Hash for Socket

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

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 Socket

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Socket

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Socket

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Socket

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

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

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

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

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

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

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

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

const 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 Socket

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Socket

impl IsA<Component> for Socket

impl IsA<Object> for Socket