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

Contents

Description

See tSocket

Synopsis

Exported types

newtype Plug Source #

Memory-managed wrapper type.

Constructors

Plug (ManagedPtr Plug) 
Instances
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 ': ([] :: [Type])))

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
(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 tPlug

-> m Text

Returns: the unique ID for the plug

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

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

Since: 1.30

new

plugNew Source #

Arguments

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

Returns: the newly created tPlug

Creates a new tPlug instance.

Since: 1.30

setChild

plugSetChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsPlug a, IsObject b) 
=> a

plug: an tPlug to be set as accessible parent of child.

-> b

child: an tObject to be set as accessible child of plug.

-> m () 

Sets child as accessible child of plug and plug as accessible parent of child. child can be NULL.

In some cases, one can not use the AtkPlug type directly as accessible object for the toplevel widget of the application. For instance in the gtk case, GtkPlugAccessible can not inherit both from GtkWindowAccessible and from AtkPlug. In such a case, one can create, in addition to the standard accessible object for the toplevel widget, an AtkPlug object, and make the former the child of the latter by calling plugSetChild.

Since: 2.35.0