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 ID of that widgets window to the other process,
  14 which then creates a #GtkPlug with that window ID.
  15 Any widgets contained in the #GtkPlug then will appear
  16 inside the first applications window.
  17 </para>
  18
  19 <note>
  20 <para>
  21 The #GtkPlug and #GtkSocket widgets are currently not available
  22 on all platforms supported by GTK+.
  23 </para>
  24 </note>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28 <variablelist>
  29
  30 <varlistentry>
  31 <term>#GtkSocket</term>
  32 <listitem><para>the widget that a #GtkPlug plugs into.</para></listitem>
  33 </varlistentry>
  34
  35 </variablelist>
  36 </para>
  37
  38 <!-- ##### SECTION Stability_Level ##### -->
  39
  40
  41 <!-- ##### STRUCT GtkPlug ##### -->
  42 <para>
  43
  44 </para>
  45
  46
  47 <!-- ##### SIGNAL GtkPlug::embedded ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @plug: the object which received the signal.
  53
  54 <!-- ##### FUNCTION gtk_plug_construct ##### -->
  55 <para>
  56 </para>
  57
  58 @plug:
  59 @socket_id:
  60
  61
  62 <!-- ##### FUNCTION gtk_plug_construct_for_display ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @plug:
  68 @display:
  69 @socket_id:
  70
  71
  72 <!-- ##### FUNCTION gtk_plug_new ##### -->
  73 <para>
  74 </para>
  75
  76 @socket_id: the window ID of the socket, or 0.
  77 @Returns: the new #GtkPlug widget.
  78
  79
  80 <!-- ##### FUNCTION gtk_plug_new_for_display ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @display:
  86 @socket_id:
  87 @Returns:
  88
  89
  90 <!-- ##### FUNCTION gtk_plug_get_id ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @plug:
  96 @Returns:
  97
  98