Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkplug.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkPlug
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Toplevel for embedding into other processes.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Together with #GtkSocket, #GtkPlug provides the ability
  10 to embed widgets from one process into another process
  11 in a fashion that is transparent to the user. One
  12 process creates a #GtkSocket widget and, passes the
  13 XID of that widgets window to the other process,
  14 which then creates a #GtkPlug window with that XID.
  15 Any widgets contained in the #GtkPlug then will appear
  16 inside the first applications window.
  17 </para>
  18
  19 <!-- ##### SECTION See_Also ##### -->
  20 <para>
  21 <variablelist>
  22
  23 <varlistentry>
  24 <term>#GtkSocket</term>
  25 <listitem><para>the widget that a #GtkPlug plugs into.</para></listitem>
  26 </varlistentry>
  27
  28 </variablelist>
  29 </para>
  30
  31 <!-- ##### STRUCT GtkPlug ##### -->
  32 <para>
  33
  34 </para>
  35
  36 @window:
  37 @socket_window:
  38 @same_app:
  39
  40 <!-- ##### FUNCTION gtk_plug_construct ##### -->
  41 <para>
  42 Finish the creation of a #GtkPlug widget. This function
  43 will generally only be used by classes deriving
  44 from #GtkPlug.
  45 </para>
  46
  47 @plug: a #GtkPlug widget.
  48 @socket_id: the XID of the socket's window.
  49
  50
  51 <!-- ##### FUNCTION gtk_plug_new ##### -->
  52 <para>
  53 Create a new plug widget inside the #GtkSocket identified
  54 by @socket_id.
  55 </para>
  56
  57 @socket_id: the XID of the socket's window.
  58 @Returns: the new #GtkPlug widget.
  59
  60