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 <!-- ##### ARG GtkPlug:embedded ##### -->
  55 <para>
  56
  57 </para>
  58
  59 <!-- ##### FUNCTION gtk_plug_construct ##### -->
  60 <para>
  61 </para>
  62
  63 @plug:
  64 @socket_id:
  65
  66
  67 <!-- ##### FUNCTION gtk_plug_construct_for_display ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @plug:
  73 @display:
  74 @socket_id:
  75
  76
  77 <!-- ##### FUNCTION gtk_plug_new ##### -->
  78 <para>
  79 </para>
  80
  81 @socket_id: the window ID of the socket, or 0.
  82 @Returns: the new #GtkPlug widget.
  83
  84
  85 <!-- ##### FUNCTION gtk_plug_new_for_display ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @display:
  91 @socket_id:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION gtk_plug_get_id ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @plug:
 101 @Returns:
 102
 103