gtk2/docs/reference/gtk/tmpl/gtkplug.sgml
Matthias Clasen 3657b05ccc Add note on limited availability. (#164347, Roger Light)
2005-01-25  Matthias Clasen  <mclasen@redhat.com>

	* gtk/tmpl/gtksocket.sgml:
	* gtk/tmpl/gtkplug.sgml: Add note on limited
	availability.  (#164347, Roger Light)
2005-01-25 18:46:27 +00:00

96 lines
1.6 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkPlug
<!-- ##### SECTION Short_Description ##### -->
Toplevel for embedding into other processes
<!-- ##### SECTION Long_Description ##### -->
<para>
Together with #GtkSocket, #GtkPlug 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 #GtkSocket widget and, passes the
ID of that widgets window to the other process,
which then creates a #GtkPlug with that window ID.
Any widgets contained in the #GtkPlug then will appear
inside the first applications window.
</para>
<note>
<para>
The #GtkPlug and #GtkSocket widgets are currently not available
on all platforms supported by GTK+.
</para>
</note>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkSocket</term>
<listitem><para>the widget that a #GtkPlug plugs into.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### STRUCT GtkPlug ##### -->
<para>
</para>
<!-- ##### SIGNAL GtkPlug::embedded ##### -->
<para>
</para>
@plug: the object which received the signal.
<!-- ##### FUNCTION gtk_plug_construct ##### -->
<para>
</para>
@plug:
@socket_id:
<!-- ##### FUNCTION gtk_plug_construct_for_display ##### -->
<para>
</para>
@plug:
@display:
@socket_id:
<!-- ##### FUNCTION gtk_plug_new ##### -->
<para>
</para>
@socket_id: the window ID of the socket, or 0.
@Returns: the new #GtkPlug widget.
<!-- ##### FUNCTION gtk_plug_new_for_display ##### -->
<para>
</para>
@display:
@socket_id:
@Returns:
<!-- ##### FUNCTION gtk_plug_get_id ##### -->
<para>
</para>
@plug:
@Returns: