Libraries:Gtk:Gtk:Plug

Types

T

Inherits from:

Gtk.Gtk.Window.T, Gtk.Gtk.Bin.T, Gtk.Gtk.Container.T, Gtk.Gtk.Widget.T, Gtk.Gtk.Object.T, Gtk.GObject.Object.T

Together with Gtk.Gtk.Socket.T, T 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 Gtk.Gtk.Socket.T widget and passes the ID of that widget's window to the other process, which then creates a T with that window ID. Any widgets contained in the T then will appear inside the first application's window.

Note

The T and Gtk.Gtk.Socket.T widgets are currently not available on all platforms supported by GTK+.

Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T

New(socket_id @ Std.Integer.SmallT) : Gtk.Gtk.Plug.T

Creates a new plug widget inside the Gtk.Gtk.Socket.T identified by socket_id. If socket_id is 0, the plug is left "unplugged" and can later be plugged into a Gtk.Gtk.Socket.T by Gtk.Gtk.Socket.AddId.

socket_id	the window ID of the socket, or 0.
Returns	the new T widget.

NewForDisplay(display @ Gtk.Gdk.Display.T, socket_id @ Std.Integer.SmallT) : Gtk.Gtk.Plug.T

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

display	the Gtk.Gdk.Display.T on which socket_id is displayed
socket_id	the XID of the socket's window.
Returns	the new T widget.

Methods

:Construct(self @ T, socket_id @ Std.Integer.SmallT) : Std.Object.T

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

plug	a T.
socket_id	the XID of the socket's window.

:ConstructForDisplay(self @ T, display @ Gtk.Gdk.Display.T, socket_id @ Std.Integer.SmallT) : Std.Object.T

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

plug	a T.
display	the Gtk.Gdk.Display.T associated with socket_id's Gtk.Gtk.Socket.T.
socket_id	the XID of the socket's window.

:GetEmbedded(self @ T) : Std.Symbol.T

Determines whether the plug is embedded in a socket.

plug	a T
Returns	TRUE if the plug is embedded in a socket

:GetId(self @ T) : Std.Integer.SmallT

Gets the window ID of a T widget, which can then be used to embed this window inside another window, for instance with Gtk.Gtk.Socket.AddId.

plug	a T.
Returns	the window ID for the plug

:GetSocketWindow(self @ T) : Gtk.Gdk.Window.T

Retrieves the socket the plug is embedded in.

plug	a T
Returns	the window of the socket, or NULL. [transfer none]

Plug