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

GI.Atk.Objects.Socket

Description

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 socketEmbed. 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 plugGetId and socketEmbed, 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 socketEmbed in order to embed it.

For the same reasons, an implementor doesn't need to implement objectGetNAccessibleChildren and objectRefAccessibleChild. All the logic related to those functions will be implemented by the IPC layer.

See Atk.AtkPlug

Synopsis

Exported types

newtype Socket Source #

Memory-managed wrapper type.

Constructors

Socket (ManagedPtr Socket) 

Instances

Instances details
Eq Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

Methods

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

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

GObject Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

ManagedPtrNewtype Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

TypedObject Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

Methods

glibType :: IO GType #

HasParentTypes Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

HasAttributeList Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

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

Defined in GI.Atk.Objects.Socket

Methods

getField :: Socket -> p #

(info ~ ResolveSocketMethod t Socket, OverloadedMethodInfo info Socket) => IsLabel t (MethodProxy info Socket) Source # 
Instance details

Defined in GI.Atk.Objects.Socket

Methods

fromLabel :: MethodProxy info Socket #

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

Defined in GI.Atk.Objects.Socket

Methods

fromLabel :: Socket -> p #

IsGValue (Maybe Socket) Source #

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

Instance details

Defined in GI.Atk.Objects.Socket

type AttributeList Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

type ParentTypes Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

type SignalList Socket Source # 
Instance details

Defined in GI.Atk.Objects.Socket

class (GObject o, IsDescendantOf Socket o) => IsSocket o Source #

Type class for types which can be safely cast to Socket, for instance with toSocket.

Instances

Instances details
(GObject o, IsDescendantOf Socket o) => IsSocket o Source # 
Instance details

Defined in GI.Atk.Objects.Socket

toSocket :: (MonadIO m, IsSocket o) => o -> m Socket Source #

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

Methods

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

Equations

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

embed

data SocketEmbedMethodInfo Source #

Instances

Instances details
(signature ~ (Text -> m ()), MonadIO m, IsSocket a) => OverloadedMethod SocketEmbedMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Objects.Socket

Methods

overloadedMethod :: a -> signature #

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

Defined in GI.Atk.Objects.Socket

socketEmbed Source #

Arguments

:: (HasCallStack, MonadIO m, IsSocket a) 
=> a

obj: an Socket

-> Text

plugId: the ID of an Plug

-> m () 

Embeds the children of an Plug as the children of the Socket. The plug may be in the same process or in a different process.

The class item used by this function should be filled in by the IPC layer (usually at-spi2-atk). The implementor of the AtkSocket should call this function and pass the id for the plug as returned by plugGetId. It is the responsibility of the application to pass the plug id on to the process implementing the Socket as needed.

Since: 1.30

isOccupied

data SocketIsOccupiedMethodInfo Source #

Instances

Instances details
(signature ~ m Bool, MonadIO m, IsSocket a) => OverloadedMethod SocketIsOccupiedMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Objects.Socket

Methods

overloadedMethod :: a -> signature #

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

Defined in GI.Atk.Objects.Socket

socketIsOccupied Source #

Arguments

:: (HasCallStack, MonadIO m, IsSocket a) 
=> a

obj: an Socket

-> m Bool

Returns: TRUE if a plug is embedded in the socket

Determines whether or not the socket has an embedded plug.

Since: 1.30

new

socketNew Source #

Arguments

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

Returns: the newly created Socket instance

Creates a new Socket.