gtk2/docs/reference/gtk/tmpl/gtkplug.sgml
Matthias Clasen 4127a267f1 Speak of window IDs rather than XIDs in the docs.
* gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
        than XIDs in the docs.

        * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.

        * gtk/tmpl/gtksocket.sgml, gtk/tmpl/gtkplug.sgml: speak of
        window IDs rather than XIDs.
2002-01-09 00:02:30 +00:00

75 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>
<!-- ##### 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>
<!-- ##### FUNCTION gtk_plug_construct ##### -->
<para>
Finishes the creation of a #GtkPlug widget. This function
will generally only be used by classes deriving
from #GtkPlug.
</para>
@plug: a #GtkPlug widget.
@socket_id: the window ID of the socket.
<!-- ##### FUNCTION gtk_plug_new ##### -->
<para>
Creates a new plug widget inside the #GtkSocket identified
by @socket_id. If @socket_id is 0, the plug is left "unplugged" and
can later be plugged into a #GtkSocket by gtk_socket_add_id().
</para>
@socket_id: the window ID of the socket, or 0.
@Returns: the new #GtkPlug widget.
<!-- ##### FUNCTION gtk_plug_get_id ##### -->
<para>
</para>
@plug:
@Returns:
<!-- ##### SIGNAL GtkPlug::embedded ##### -->
<para>
</para>
@plug: the object which received the signal.