Graphics.UI.Gtk.Embedding.Plug

Toplevel for embedding into other processes

Detail

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 widgets 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 applications window.

Class Hierarchy

| GObject
| +----Object
| +----Widget
| +----Container
| +----Bin
| +----Window
| +----Plug

Types

data Plug

Instances

Eq Plug

Methods

(==) :: Plug -> Plug -> Bool

(/=) :: Plug -> Plug -> Bool

Ord Plug

Methods

compare :: Plug -> Plug -> Ordering

(<) :: Plug -> Plug -> Bool

(<=) :: Plug -> Plug -> Bool

(>) :: Plug -> Plug -> Bool

(>=) :: Plug -> Plug -> Bool

max :: Plug -> Plug -> Plug

min :: Plug -> Plug -> Plug

GObjectClass Plug

Methods

toGObject :: Plug -> GObject

unsafeCastGObject :: GObject -> Plug

WindowClass Plug

BinClass Plug

ContainerClass Plug

WidgetClass Plug

PlugClass Plug

class WindowClass o => PlugClass o

Instances

PlugClass Plug

castToPlug :: GObjectClass obj => obj -> Plug

gTypePlug :: GType

toPlug :: PlugClass o => o -> Plug

data NativeWindowId

The identifer of a window of the underlying windowing system.

Instances

Eq NativeWindowId

Methods

(==) :: NativeWindowId -> NativeWindowId -> Bool

(/=) :: NativeWindowId -> NativeWindowId -> Bool

Show NativeWindowId

Methods

showsPrec :: Int -> NativeWindowId -> ShowS

show :: NativeWindowId -> String

showList :: [NativeWindowId] -> ShowS

Constructors

plugNew

Arguments

:: Maybe NativeWindowId

socketId - the window ID of the socket, or Nothing.

-> IO Plug

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

If a NativeWindowId is supplied the foreign application window will immediatly appear in this Plug once it is shown. If Nothing is passed then a NativeWindowId can be extracted from this Plug using plugGetId and be passed to the application which is to be embedded.

plugNewForDisplay

Arguments

:: Display

display - the Display on which socketId is displayed

-> Maybe NativeWindowId

socketId - the XID of the socket's window.

-> IO Plug

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

• Available since Gtk+ version 2.2

Methods

plugGetId

Arguments

:: PlugClass self

=> self

-> IO NativeWindowId

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.

plugGetEmbedded

Arguments

:: PlugClass self

=> self

-> IO Bool

returns True if the plug is embedded in a socket

Determines whether the plug is embedded in a socket.

• Available since Gtk+ version 2.14

plugGetSocketWindow

Arguments

:: PlugClass self

=> self

-> IO (Maybe DrawWindow)

returns the window of the socket

Retrieves the socket the plug is embedded in.

• Available since Gtk+ version 2.14

Attributes

plugAttrEmbedded :: PlugClass self => ReadAttr self Bool

True if the plug is embedded in a socket.

Default value: False

• Available since Gtk+ version 2.12

plugAttrSocketWindow :: PlugClass self => ReadAttr self (Maybe DrawWindow)

The window of the socket the plug is embedded in.

• Available since Gtk+ version 2.14

Signals

plugEmbedded :: PlugClass self => Signal self (IO ())

Gets emitted when the plug becomes embedded in a socket and when the embedding ends.