GI.Atk.Objects.Plug

See Socket

Exported types

newtype Plug

Memory-managed wrapper type.

Constructors

Plug (ManagedPtr Plug)

Instances

Eq Plug

Defined in GI.Atk.Objects.Plug

Methods

(==) :: Plug -> Plug -> Bool

(/=) :: Plug -> Plug -> Bool

GObject Plug

Defined in GI.Atk.Objects.Plug

Methods

gobjectType :: IO GType

IsGValue Plug

Convert Plug to and from GValue with toGValue and fromGValue.

Defined in GI.Atk.Objects.Plug

Methods

toGValue :: Plug -> IO GValue

fromGValue :: GValue -> IO Plug

HasParentTypes Plug

Defined in GI.Atk.Objects.Plug

type ParentTypes Plug

Defined in GI.Atk.Objects.Plug

type ParentTypes Plug = '[Object, Object, Component]

class (GObject o, IsDescendantOf Plug o) => IsPlug o

Type class for types which can be safely cast to Plug, for instance with toPlug.

Instances

(GObject o, IsDescendantOf Plug o) => IsPlug o

Defined in GI.Atk.Objects.Plug

toPlug :: (MonadIO m, IsPlug o) => o -> m Plug

Cast to Plug, for types for which this is known to be safe. For general casts, use castTo.

noPlug :: Maybe Plug

A convenience alias for Nothing :: Maybe Plug.

Methods

Overloaded methods

getId

plugGetId

Arguments

:: (HasCallStack, MonadIO m, IsPlug a)

=> a

plug: an Plug

-> m Text

Returns: the unique ID for the plug

Gets the unique ID of an Plug object, which can be used to embed inside of an Socket using socketEmbed.

Internally, this calls a class function that should be registered by the IPC layer (usually at-spi2-atk). The implementor of an Plug object should call this function (after atk-bridge is loaded) and pass the value to the process implementing the Socket, so it could embed the plug.

Since: 1.30

new

plugNew :: (HasCallStack, MonadIO m) => m Plug

No description available in the introspection data.