Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.Plug

Contents

Exported types
Methods
Properties
- embedded
- socketWindow
Signals
- embedded

Description

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.

Synopsis

newtype Plug = Plug (ManagedPtr Plug)
class GObject o => IsPlug o
toPlug :: (MonadIO m, IsPlug o) => o -> m Plug
noPlug :: Maybe Plug
plugConstruct :: (HasCallStack, MonadIO m, IsPlug a) => a -> CULong -> m ()
plugConstructForDisplay :: (HasCallStack, MonadIO m, IsPlug a, IsDisplay b) => a -> b -> CULong -> m ()
plugGetEmbedded :: (HasCallStack, MonadIO m, IsPlug a) => a -> m Bool
plugGetId :: (HasCallStack, MonadIO m, IsPlug a) => a -> m CULong
plugGetSocketWindow :: (HasCallStack, MonadIO m, IsPlug a) => a -> m (Maybe Window)
plugNew :: (HasCallStack, MonadIO m) => CULong -> m Plug
plugNewForDisplay :: (HasCallStack, MonadIO m, IsDisplay a) => a -> CULong -> m Plug
getPlugEmbedded :: (MonadIO m, IsPlug o) => o -> m Bool
getPlugSocketWindow :: (MonadIO m, IsPlug o) => o -> m (Maybe Window)
type C_PlugEmbeddedCallback = Ptr () -> Ptr () -> IO ()
type PlugEmbeddedCallback = IO ()
afterPlugEmbedded :: (IsPlug a, MonadIO m) => a -> PlugEmbeddedCallback -> m SignalHandlerId
genClosure_PlugEmbedded :: PlugEmbeddedCallback -> IO Closure
mk_PlugEmbeddedCallback :: C_PlugEmbeddedCallback -> IO (FunPtr C_PlugEmbeddedCallback)
noPlugEmbeddedCallback :: Maybe PlugEmbeddedCallback
onPlugEmbedded :: (IsPlug a, MonadIO m) => a -> PlugEmbeddedCallback -> m SignalHandlerId
wrap_PlugEmbeddedCallback :: PlugEmbeddedCallback -> C_PlugEmbeddedCallback

Exported types

newtype Plug Source #

Memory-managed wrapper type.

Constructors

Plug (ManagedPtr Plug)

Instances

GObject Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug Methods gobjectType :: Plug -> IO GType #
IsImplementorIface Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsObject Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsBuildable Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsBin Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsContainer Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsWidget Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsWindow Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsPlug Plug Source #
Instance details Defined in GI.Gtk.Objects.Plug

class GObject o => IsPlug o Source #

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

Instances

(GObject a, (UnknownAncestorError Plug a :: Constraint)) => IsPlug a Source #
Instance details Defined in GI.Gtk.Objects.Plug
IsPlug Plug Source #
Instance details Defined in GI.Gtk.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

construct

plugConstruct Source #

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

plugConstructForDisplay Source #

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

plugGetEmbedded Source #

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

plugGetId Source #

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

plugGetSocketWindow Source #

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

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

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.