Class

GtkPlug

[]

Description [src]

class Gtk.Plug : Gtk.Window
  implements Atk.ImplementorIface, Gtk.Buildable {
  GtkPlugPrivate* priv
}

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

The communication between a GtkSocket and a GtkPlug 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 GtkPlug and GtkSocket 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 GtkPlug and GtkSocket, you need to include the gtk/gtkx.h header.

[]

Hierarchy

hierarchy this GtkPlug implements_0 AtkImplementorIface this--implements_0 implements_1 GtkBuildable this--implements_1 ancestor_0 GtkWindow ancestor_0--this ancestor_1 GtkBin ancestor_1--ancestor_0 ancestor_2 GtkContainer ancestor_2--ancestor_1 ancestor_3 GtkWidget ancestor_3--ancestor_2 ancestor_4 GInitiallyUnowned ancestor_4--ancestor_3 ancestor_5 GObject ancestor_5--ancestor_4
[]

Constructors

gtk_plug_new

Creates a new plug widget inside the GtkSocket identified by socket_id. If socket_id is 0, the plug is left “unplugged” and can later be plugged into a GtkSocket by gtk_socket_add_id().

gtk_plug_new_for_display

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

since: 2.2

[]

Instance methods

gtk_plug_construct

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

gtk_plug_construct_for_display

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

since: 2.2

gtk_plug_get_embedded

Determines whether the plug is embedded in a socket.

since: 2.14

gtk_plug_get_id

Gets the window ID of a GtkPlug widget, which can then be used to embed this window inside another window, for instance with gtk_socket_add_id().

gtk_plug_get_socket_window

Retrieves the socket the plug is embedded in.

since: 2.14

Methods inherited from GtkWindow (109)
Methods inherited from GtkBin (1)
Methods inherited from GtkContainer (33)
Methods inherited from GtkWidget (263)
Methods inherited from GObject (43)
Methods inherited from GtkBuildable (10)
[]

Properties

Gtk.Plug:embedded

TRUE if the plug is embedded in a socket.

since: 2.12

Gtk.Plug:socket-window

The window of the socket the plug is embedded in.

since: 2.14

Properties inherited from GtkWindow (33)
Properties inherited from GtkContainer (3)
Properties inherited from GtkWidget (39)
[]

Signals

Gtk.Plug::embedded

Gets emitted when the plug becomes embedded in a socket.

Signals inherited from GtkWindow (5)
Signals inherited from GtkContainer (4)
Signals inherited from GtkWidget (69)
Signals inherited from GObject (1)

Class structure

[]

Virtual methods

Gtk.PlugClass.embedded
No description available.