Plug

Object Hierarchy:

Gtk.Plug Gtk.Plug Gtk.Plug Gtk.Window Gtk.Window Gtk.Window->Gtk.Plug Gtk.Bin Gtk.Bin Gtk.Bin->Gtk.Window Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Widget Gtk.Widget Gtk.Widget->Gtk.Container GLib.InitiallyUnowned GLib.InitiallyUnowned GLib.InitiallyUnowned->Gtk.Widget GLib.Object GLib.Object GLib.Object->GLib.InitiallyUnowned Atk.Implementor Atk.Implementor Atk.Implementor->Gtk.Plug Atk.Implementor->Gtk.Window Atk.Implementor->Gtk.Bin Atk.Implementor->Gtk.Container Atk.Implementor->Gtk.Widget Gtk.Buildable Gtk.Buildable Gtk.Buildable->Gtk.Plug Gtk.Buildable->Gtk.Window Gtk.Buildable->Gtk.Bin Gtk.Buildable->Gtk.Container Gtk.Buildable->Gtk.Widget

Description:

[ CCode ( type_id = "gtk_plug_get_type ()" ) ]
public class Plug : Window, Implementor, Buildable

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+-3.0

Content:

Properties:

  • public virtual 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:

Methods:

  • public void @construct (Window socket_id)
    Finish the initialization of this for a given Socket identified by socket_id.
  • public void construct_for_display (Display display, Window 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 Window 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.

Signals:

  • public signal void on_embedded ()
    Gets emitted when the plug becomes embedded in a socket.

Inherited Members:

All known members inherited from class Gtk.Window
All known members inherited from class Gtk.Bin
All known members inherited from class Gtk.Container
All known members inherited from class Gtk.Widget
All known members inherited from class GLib.Object
All known members inherited from interface Atk.Implementor
All known members inherited from interface Gtk.Buildable