gi-atk-2.0.21: Atk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Atk.Objects.Plug

Description

See Socket

Synopsis

Exported types

newtype Plug Source #

Memory-managed wrapper type.

Constructors

Plug (ManagedPtr Plug) 

Instances

Instances details
Eq Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

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

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

GObject Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

gobjectType :: IO GType #

IsGValue Plug Source #

Convert Plug to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Atk.Objects.Plug

Methods

toGValue :: Plug -> IO GValue #

fromGValue :: GValue -> IO Plug #

HasParentTypes Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

type ParentTypes Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

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

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

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

Instances

Instances details
(GObject o, IsDescendantOf Plug o) => IsPlug o Source # 
Instance details

Defined in GI.Atk.Objects.Plug

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

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

noPlug :: Maybe Plug Source #

A convenience alias for Nothing :: Maybe Plug.

Methods

Overloaded methods

getId

plugGetId Source #

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 Source #

No description available in the introspection data.