summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkplug.sgml
blob: 1f71fb5dc91cbf317c43fdb9d5964cf5baebc966 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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.