Gtk.Plug – gtk+-2.0 – Vala Binding Reference

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.

Namespace: Gtk

Package: gtk+-2.0

Content:

Properties:

public bool embedded { get; }

true if the plug is embedded in a socket.

public Window socket_window { get; }

The window of the socket the plug is embedded in.

Creation methods:

public Plug (NativeWindow socket_id)

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

public Plug.for_display (Display display, NativeWindow socket_id)

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

Methods:

public void @construct (NativeWindow socket_id)

Finish the initialization of this for a given Socket identified by socket_id.

public void construct_for_display (Display display, NativeWindow socket_id)

Finish the initialization of this for a given Socket identified by socket_id which is currently displayed on display.

public bool get_embedded ()

Determines whether the plug is embedded in a socket.

public NativeWindow get_id ()

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

public unowned Window get_socket_window ()

Retrieves the socket the plug is embedded in.

Fields:

Inherited Members:

All known members inherited from class Gtk.Bin

child

get_child

All known members inherited from class Gtk.Object

user_data

All known members inherited from interface Atk.Implementor

ref_accessible

Plug