summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkplug.sgml
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@src.gnome.org>1999-08-16 18:51:52 +0000
committerOwen Taylor <otaylor@src.gnome.org>1999-08-16 18:51:52 +0000
commit91a5956707f72e6ca4f57c2af51fab378bf22949 (patch)
treedf292b9e1130dc0906526afadd0742d38ce480a9 /docs/reference/gtk/tmpl/gtkplug.sgml
parent0455fa3029a4744fa40ab58bf4f837bfa1890509 (diff)
downloadgdk-pixbuf-91a5956707f72e6ca4f57c2af51fab378bf22949.tar.gz
Initial revision
Diffstat (limited to 'docs/reference/gtk/tmpl/gtkplug.sgml')
-rw-r--r--docs/reference/gtk/tmpl/gtkplug.sgml60
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/reference/gtk/tmpl/gtkplug.sgml b/docs/reference/gtk/tmpl/gtkplug.sgml
new file mode 100644
index 000000000..1f71fb5dc
--- /dev/null
+++ b/docs/reference/gtk/tmpl/gtkplug.sgml
@@ -0,0 +1,60 @@
+<!-- ##### 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
+XID of that widgets window to the other process,
+which then creates a #GtkPlug window with that XID.
+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>
+
+@window:
+@socket_window:
+@same_app:
+
+<!-- ##### FUNCTION gtk_plug_construct ##### -->
+<para>
+Finish 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 XID of the socket's window.
+
+
+<!-- ##### FUNCTION gtk_plug_new ##### -->
+<para>
+Create a new plug widget inside the #GtkSocket identified
+by @socket_id.
+</para>
+
+@socket_id: the XID of the socket's window.
+@Returns: the new #GtkPlug widget.
+
+