gi-atk
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Atk.Objects.Plug

Description

Toplevel for embedding into other processes

See Atk.AtkSocket

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

ManagedPtrNewtype Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

TypedObject Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

glibType :: IO GType #

HasParentTypes Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

HasAttributeList Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

(info ~ ResolvePlugMethod t Plug, OverloadedMethod info Plug p, HasField t Plug p) => HasField (t :: Symbol) Plug (p :: Type) Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

getField :: Plug -> p #

(info ~ ResolvePlugMethod t Plug, OverloadedMethodInfo info Plug) => IsLabel t (MethodProxy info Plug) Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

fromLabel :: MethodProxy info Plug #

(info ~ ResolvePlugMethod t Plug, OverloadedMethod info Plug p) => IsLabel t (Plug -> p) Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

fromLabel :: Plug -> p #

IsGValue (Maybe Plug) Source #

Convert Plug to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Atk.Objects.Plug

type AttributeList Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

type ParentTypes Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

type SignalList Plug Source # 
Instance details

Defined in GI.Atk.Objects.Plug

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.

Methods

type family ResolvePlugMethod (t :: Symbol) o where ... Source #

Equations

ResolvePlugMethod "addRelationship" o = ObjectAddRelationshipMethodInfo 
ResolvePlugMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolvePlugMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolvePlugMethod "contains" o = ComponentContainsMethodInfo 
ResolvePlugMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolvePlugMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolvePlugMethod "getv" o = ObjectGetvMethodInfo 
ResolvePlugMethod "grabFocus" o = ComponentGrabFocusMethodInfo 
ResolvePlugMethod "initialize" o = ObjectInitializeMethodInfo 
ResolvePlugMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolvePlugMethod "notify" o = ObjectNotifyMethodInfo 
ResolvePlugMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolvePlugMethod "notifyStateChange" o = ObjectNotifyStateChangeMethodInfo 
ResolvePlugMethod "peekParent" o = ObjectPeekParentMethodInfo 
ResolvePlugMethod "ref" o = ObjectRefMethodInfo 
ResolvePlugMethod "refAccessibleAtPoint" o = ComponentRefAccessibleAtPointMethodInfo 
ResolvePlugMethod "refAccessibleChild" o = ObjectRefAccessibleChildMethodInfo 
ResolvePlugMethod "refRelationSet" o = ObjectRefRelationSetMethodInfo 
ResolvePlugMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolvePlugMethod "refStateSet" o = ObjectRefStateSetMethodInfo 
ResolvePlugMethod "removeFocusHandler" o = ComponentRemoveFocusHandlerMethodInfo 
ResolvePlugMethod "removePropertyChangeHandler" o = ObjectRemovePropertyChangeHandlerMethodInfo 
ResolvePlugMethod "removeRelationship" o = ObjectRemoveRelationshipMethodInfo 
ResolvePlugMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolvePlugMethod "scrollTo" o = ComponentScrollToMethodInfo 
ResolvePlugMethod "scrollToPoint" o = ComponentScrollToPointMethodInfo 
ResolvePlugMethod "stealData" o = ObjectStealDataMethodInfo 
ResolvePlugMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolvePlugMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolvePlugMethod "unref" o = ObjectUnrefMethodInfo 
ResolvePlugMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolvePlugMethod "getAccessibleId" o = ObjectGetAccessibleIdMethodInfo 
ResolvePlugMethod "getAlpha" o = ComponentGetAlphaMethodInfo 
ResolvePlugMethod "getAttributes" o = ObjectGetAttributesMethodInfo 
ResolvePlugMethod "getData" o = ObjectGetDataMethodInfo 
ResolvePlugMethod "getDescription" o = ObjectGetDescriptionMethodInfo 
ResolvePlugMethod "getExtents" o = ComponentGetExtentsMethodInfo 
ResolvePlugMethod "getHelpText" o = ObjectGetHelpTextMethodInfo 
ResolvePlugMethod "getId" o = PlugGetIdMethodInfo 
ResolvePlugMethod "getIndexInParent" o = ObjectGetIndexInParentMethodInfo 
ResolvePlugMethod "getLayer" o = ObjectGetLayerMethodInfo 
ResolvePlugMethod "getMdiZorder" o = ObjectGetMdiZorderMethodInfo 
ResolvePlugMethod "getNAccessibleChildren" o = ObjectGetNAccessibleChildrenMethodInfo 
ResolvePlugMethod "getName" o = ObjectGetNameMethodInfo 
ResolvePlugMethod "getObjectLocale" o = ObjectGetObjectLocaleMethodInfo 
ResolvePlugMethod "getParent" o = ObjectGetParentMethodInfo 
ResolvePlugMethod "getPosition" o = ComponentGetPositionMethodInfo 
ResolvePlugMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolvePlugMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolvePlugMethod "getRole" o = ObjectGetRoleMethodInfo 
ResolvePlugMethod "getSize" o = ComponentGetSizeMethodInfo 
ResolvePlugMethod "setAccessibleId" o = ObjectSetAccessibleIdMethodInfo 
ResolvePlugMethod "setChild" o = PlugSetChildMethodInfo 
ResolvePlugMethod "setData" o = ObjectSetDataMethodInfo 
ResolvePlugMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolvePlugMethod "setDescription" o = ObjectSetDescriptionMethodInfo 
ResolvePlugMethod "setExtents" o = ComponentSetExtentsMethodInfo 
ResolvePlugMethod "setHelpText" o = ObjectSetHelpTextMethodInfo 
ResolvePlugMethod "setName" o = ObjectSetNameMethodInfo 
ResolvePlugMethod "setParent" o = ObjectSetParentMethodInfo 
ResolvePlugMethod "setPosition" o = ComponentSetPositionMethodInfo 
ResolvePlugMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolvePlugMethod "setRole" o = ObjectSetRoleMethodInfo 
ResolvePlugMethod "setSize" o = ComponentSetSizeMethodInfo 
ResolvePlugMethod l o = MethodResolutionFailed l o :: Type 

getId

data PlugGetIdMethodInfo Source #

Instances

Instances details
(signature ~ m Text, MonadIO m, IsPlug a) => OverloadedMethod PlugGetIdMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo PlugGetIdMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Objects.Plug

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

Arguments

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

Returns: the newly created Plug

Creates a new Plug instance.

Since: 1.30

setChild

data PlugSetChildMethodInfo Source #

Instances

Instances details
(signature ~ (b -> m ()), MonadIO m, IsPlug a, IsObject b) => OverloadedMethod PlugSetChildMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Objects.Plug

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo PlugSetChildMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Objects.Plug

plugSetChild Source #

Arguments

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

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

-> b

child: an Object 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