GI.Gtk.Objects.Plug

Together with Socket, Plug provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a Socket widget and passes the ID of that widget’s window to the other process, which then creates a Plug with that window ID. Any widgets contained in the Plug then will appear inside the first application’s window.

The communication between a Socket and a Plug follows the XEmbed Protocol. This protocol has also been implemented in other toolkits, e.g. Qt, allowing the same level of integration when embedding a Qt widget in GTK+ or vice versa.

The Plug and Socket widgets are only available when GTK+ is compiled for the X11 platform and GDK_WINDOWING_X11 is defined. They can only be used on a GdkX11Display. To use Plug and Socket, you need to include the gtk/gtkx.h header.

Exported types

newtype Plug

Constructors

Plug (ManagedPtr Plug)

Instances

GObject Plug

Methods

gobjectType :: Plug -> IO GType

IsImplementorIface Plug

IsObject Plug

IsWindow Plug

IsWidget Plug

IsContainer Plug

IsBin Plug

IsBuildable Plug

IsPlug Plug

((~) * info (ResolvePlugMethod t Plug), MethodInfo * info Plug p) => IsLabel t (Plug -> p)

Methods

fromLabel :: Proxy# Symbol t -> Plug -> p

((~) * info (ResolvePlugMethod t Plug), MethodInfo * info Plug p) => IsLabelProxy t (Plug -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Plug -> p

HasAttributeList * Plug

type AttributeList Plug

type AttributeList Plug

type SignalList Plug

type SignalList Plug

class GObject o => IsPlug o

Instances

(GObject a, UnknownAncestorError Constraint Plug a) => IsPlug a

IsPlug Plug

toPlug :: IsPlug o => o -> IO Plug

noPlug :: Maybe Plug

Methods

construct

data PlugConstructMethodInfo

Instances

((~) * signature (CULong -> m ()), MonadIO m, IsPlug a) => MethodInfo * PlugConstructMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PlugConstructMethodInfo a -> signature -> s

plugConstruct

Arguments

:: (HasCallStack, MonadIO m, IsPlug a)

=> a

plug: a Plug.

-> CULong

socketId: the XID of the socket’s window.

-> m ()

Finish the initialization of plug for a given Socket identified by socketId. This function will generally only be used by classes deriving from Plug.

constructForDisplay

data PlugConstructForDisplayMethodInfo

Instances

((~) * signature (b -> CULong -> m ()), MonadIO m, IsPlug a, IsDisplay b) => MethodInfo * PlugConstructForDisplayMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PlugConstructForDisplayMethodInfo a -> signature -> s

plugConstructForDisplay

Arguments

:: (HasCallStack, MonadIO m, IsPlug a, IsDisplay b)

=> a

plug: a Plug.

-> b

display: the Display associated with socketId’s Socket.

-> CULong

socketId: the XID of the socket’s window.

-> m ()

Finish the initialization of plug for a given Socket identified by socketId which is currently displayed on display. This function will generally only be used by classes deriving from Plug.

Since: 2.2

getEmbedded

data PlugGetEmbeddedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsPlug a) => MethodInfo * PlugGetEmbeddedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PlugGetEmbeddedMethodInfo a -> signature -> s

plugGetEmbedded

Arguments

:: (HasCallStack, MonadIO m, IsPlug a)

=> a

plug: a Plug

-> m Bool

Returns: True if the plug is embedded in a socket

Determines whether the plug is embedded in a socket.

Since: 2.14

getId

data PlugGetIdMethodInfo

Instances

((~) * signature (m CULong), MonadIO m, IsPlug a) => MethodInfo * PlugGetIdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PlugGetIdMethodInfo a -> signature -> s

plugGetId

Arguments

:: (HasCallStack, MonadIO m, IsPlug a)

=> a

plug: a Plug.

-> m CULong

Returns: the window ID for the plug

Gets the window ID of a Plug widget, which can then be used to embed this window inside another window, for instance with socketAddId.

getSocketWindow

data PlugGetSocketWindowMethodInfo

Instances

((~) * signature (m (Maybe Window)), MonadIO m, IsPlug a) => MethodInfo * PlugGetSocketWindowMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PlugGetSocketWindowMethodInfo a -> signature -> s

plugGetSocketWindow

Arguments

:: (HasCallStack, MonadIO m, IsPlug a)

=> a

plug: a Plug

-> m (Maybe Window)

Returns: the window of the socket, or Nothing

Retrieves the socket the plug is embedded in.

Since: 2.14

new

plugNew

Arguments

:: (HasCallStack, MonadIO m)

=> CULong

socketId: the window ID of the socket, or 0.

-> m Plug

Returns: the new Plug widget.

Creates a new plug widget inside the Socket identified by socketId. If socketId is 0, the plug is left “unplugged” and can later be plugged into a Socket by socketAddId.

newForDisplay

plugNewForDisplay

Arguments

:: (HasCallStack, MonadIO m, IsDisplay a)

=> a

display: the Display on which socketId is displayed

-> CULong

socketId: the XID of the socket’s window.

-> m Plug

Returns: the new Plug widget.

Create a new plug widget inside the Socket identified by socket_id.

Since: 2.2

Properties

embedded

data PlugEmbeddedPropertyInfo

Instances

AttrInfo PlugEmbeddedPropertyInfo

Associated Types

type AttrAllowedOps PlugEmbeddedPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint PlugEmbeddedPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint PlugEmbeddedPropertyInfo :: * -> Constraint

type AttrGetType PlugEmbeddedPropertyInfo :: *

type AttrLabel PlugEmbeddedPropertyInfo :: Symbol

type AttrOrigin PlugEmbeddedPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint PlugEmbeddedPropertyInfo o => Proxy * PlugEmbeddedPropertyInfo -> o -> IO (AttrGetType PlugEmbeddedPropertyInfo)

attrSet :: (AttrBaseTypeConstraint PlugEmbeddedPropertyInfo o, AttrSetTypeConstraint PlugEmbeddedPropertyInfo b) => Proxy * PlugEmbeddedPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint PlugEmbeddedPropertyInfo o => Proxy * PlugEmbeddedPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint PlugEmbeddedPropertyInfo o, AttrSetTypeConstraint PlugEmbeddedPropertyInfo b) => Proxy * PlugEmbeddedPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin PlugEmbeddedPropertyInfo

type AttrOrigin PlugEmbeddedPropertyInfo = Plug

type AttrLabel PlugEmbeddedPropertyInfo

type AttrLabel PlugEmbeddedPropertyInfo = "embedded"

type AttrGetType PlugEmbeddedPropertyInfo

type AttrGetType PlugEmbeddedPropertyInfo = Bool

type AttrBaseTypeConstraint PlugEmbeddedPropertyInfo

type AttrBaseTypeConstraint PlugEmbeddedPropertyInfo = IsPlug

type AttrSetTypeConstraint PlugEmbeddedPropertyInfo

type AttrSetTypeConstraint PlugEmbeddedPropertyInfo = * ~ ()

type AttrAllowedOps PlugEmbeddedPropertyInfo

type AttrAllowedOps PlugEmbeddedPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getPlugEmbedded :: (MonadIO m, IsPlug o) => o -> m Bool

plugEmbedded :: AttrLabelProxy "embedded"

socketWindow

data PlugSocketWindowPropertyInfo

Instances

AttrInfo PlugSocketWindowPropertyInfo

Associated Types

type AttrAllowedOps PlugSocketWindowPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint PlugSocketWindowPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint PlugSocketWindowPropertyInfo :: * -> Constraint

type AttrGetType PlugSocketWindowPropertyInfo :: *

type AttrLabel PlugSocketWindowPropertyInfo :: Symbol

type AttrOrigin PlugSocketWindowPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint PlugSocketWindowPropertyInfo o => Proxy * PlugSocketWindowPropertyInfo -> o -> IO (AttrGetType PlugSocketWindowPropertyInfo)

attrSet :: (AttrBaseTypeConstraint PlugSocketWindowPropertyInfo o, AttrSetTypeConstraint PlugSocketWindowPropertyInfo b) => Proxy * PlugSocketWindowPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint PlugSocketWindowPropertyInfo o => Proxy * PlugSocketWindowPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint PlugSocketWindowPropertyInfo o, AttrSetTypeConstraint PlugSocketWindowPropertyInfo b) => Proxy * PlugSocketWindowPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin PlugSocketWindowPropertyInfo

type AttrOrigin PlugSocketWindowPropertyInfo = Plug

type AttrLabel PlugSocketWindowPropertyInfo

type AttrLabel PlugSocketWindowPropertyInfo = "socket-window"

type AttrGetType PlugSocketWindowPropertyInfo

type AttrGetType PlugSocketWindowPropertyInfo = Maybe Window

type AttrBaseTypeConstraint PlugSocketWindowPropertyInfo

type AttrBaseTypeConstraint PlugSocketWindowPropertyInfo = IsPlug

type AttrSetTypeConstraint PlugSocketWindowPropertyInfo

type AttrSetTypeConstraint PlugSocketWindowPropertyInfo = * ~ ()

type AttrAllowedOps PlugSocketWindowPropertyInfo

type AttrAllowedOps PlugSocketWindowPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

getPlugSocketWindow :: (MonadIO m, IsPlug o) => o -> m (Maybe Window)

plugSocketWindow :: AttrLabelProxy "socketWindow"

Signals

embedded

type C_PlugEmbeddedCallback = Ptr () -> Ptr () -> IO ()

type PlugEmbeddedCallback = IO ()

data PlugEmbeddedSignalInfo

Instances

SignalInfo PlugEmbeddedSignalInfo

Associated Types

type HaskellCallbackType PlugEmbeddedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o PlugEmbeddedSignalInfo -> o -> HaskellCallbackType PlugEmbeddedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType PlugEmbeddedSignalInfo

type HaskellCallbackType PlugEmbeddedSignalInfo = PlugEmbeddedCallback

afterPlugEmbedded :: (GObject a, MonadIO m) => a -> PlugEmbeddedCallback -> m SignalHandlerId

genClosure_PlugEmbedded :: PlugEmbeddedCallback -> IO Closure

mk_PlugEmbeddedCallback :: C_PlugEmbeddedCallback -> IO (FunPtr C_PlugEmbeddedCallback)

noPlugEmbeddedCallback :: Maybe PlugEmbeddedCallback

onPlugEmbedded :: (GObject a, MonadIO m) => a -> PlugEmbeddedCallback -> m SignalHandlerId

wrap_PlugEmbeddedCallback :: PlugEmbeddedCallback -> Ptr () -> Ptr () -> IO ()