1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
8
<link rel="up" href="PlugSocket.html" title="Cross-process Embedding">
9
<link rel="prev" href="PlugSocket.html" title="Cross-process Embedding">
10
<link rel="next" href="GtkSocket.html" title="GtkSocket">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="PlugSocket.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="PlugSocket.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
21
<td><a accesskey="n" href="GtkSocket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GtkPlug.synopsis" class="shortcut">Top</a>
26
<a href="#GtkPlug.description" class="shortcut">Description</a>
28
<a href="#GtkPlug.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GtkPlug.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GtkPlug.properties" class="shortcut">Properties</a>
34
<a href="#GtkPlug.signals" class="shortcut">Signals</a>
37
<div class="refentry">
38
<a name="GtkPlug"></a><div class="titlepage"></div>
39
<div class="refnamediv"><table width="100%"><tr>
41
<h2><span class="refentrytitle"><a name="GtkPlug.top_of_page"></a>GtkPlug</span></h2>
42
<p>GtkPlug — Toplevel for embedding into other processes</p>
44
<td valign="top" align="right"></td>
46
<div class="refsynopsisdiv">
47
<a name="GtkPlug.synopsis"></a><h2>Synopsis</h2>
48
<pre class="synopsis">
49
#include <gtk/gtk.h>
51
struct <a class="link" href="GtkPlug.html#GtkPlug-struct" title="struct GtkPlug">GtkPlug</a>;
52
<span class="returnvalue">void</span> <a class="link" href="GtkPlug.html#gtk-plug-construct" title="gtk_plug_construct ()">gtk_plug_construct</a> (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
53
<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
54
<span class="returnvalue">void</span> <a class="link" href="GtkPlug.html#gtk-plug-construct-for-display" title="gtk_plug_construct_for_display ()">gtk_plug_construct_for_display</a> (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
55
<em class="parameter"><code><a href="../gdk2/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
56
<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
57
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()">gtk_plug_new</a> (<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
58
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkPlug.html#gtk-plug-new-for-display" title="gtk_plug_new_for_display ()">gtk_plug_new_for_display</a> (<em class="parameter"><code><a href="../gdk2/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
59
<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
60
<a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a> <a class="link" href="GtkPlug.html#gtk-plug-get-id" title="gtk_plug_get_id ()">gtk_plug_get_id</a> (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);
61
<span class="returnvalue">gboolean</span> <a class="link" href="GtkPlug.html#gtk-plug-get-embedded" title="gtk_plug_get_embedded ()">gtk_plug_get_embedded</a> (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);
62
<a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * <a class="link" href="GtkPlug.html#gtk-plug-get-socket-window" title="gtk_plug_get_socket_window ()">gtk_plug_get_socket_window</a> (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);
65
<div class="refsect1">
66
<a name="GtkPlug.object-hierarchy"></a><h2>Object Hierarchy</h2>
67
<pre class="synopsis">
69
+----GInitiallyUnowned
70
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
71
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
72
+----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
73
+----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
74
+----<a class="link" href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
78
<div class="refsect1">
79
<a name="GtkPlug.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
82
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
84
<div class="refsect1">
85
<a name="GtkPlug.properties"></a><h2>Properties</h2>
86
<pre class="synopsis">
87
"<a class="link" href="GtkPlug.html#GtkPlug--embedded" title='The "embedded" property'>embedded</a>" <span class="type">gboolean</span> : Read
88
"<a class="link" href="GtkPlug.html#GtkPlug--socket-window" title='The "socket-window" property'>socket-window</a>" <a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>* : Read
91
<div class="refsect1">
92
<a name="GtkPlug.signals"></a><h2>Signals</h2>
93
<pre class="synopsis">
94
"<a class="link" href="GtkPlug.html#GtkPlug-embedded" title='The "embedded" signal'>embedded</a>" : <code class="literal">Run Last</code>
97
<div class="refsect1">
98
<a name="GtkPlug.description"></a><h2>Description</h2>
100
Together with <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> provides the ability
101
to embed widgets from one process into another process
102
in a fashion that is transparent to the user. One
103
process creates a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget and passes the
104
ID of that widget's window to the other process,
105
which then creates a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with that window ID.
106
Any widgets contained in the <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> then will appear
107
inside the first application's window.
111
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
112
<h3 class="title">Note</h3>
113
The <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widgets are currently not available
114
on all platforms supported by GTK+.
119
<div class="refsect1">
120
<a name="GtkPlug.details"></a><h2>Details</h2>
121
<div class="refsect2">
122
<a name="GtkPlug-struct"></a><h3>struct GtkPlug</h3>
123
<pre class="programlisting">struct GtkPlug;</pre>
128
<div class="refsect2">
129
<a name="gtk-plug-construct"></a><h3>gtk_plug_construct ()</h3>
130
<pre class="programlisting"><span class="returnvalue">void</span> gtk_plug_construct (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
131
<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
133
Finish the initialization of <em class="parameter"><code>plug</code></em> for a given <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
134
<em class="parameter"><code>socket_id</code></em>. This function will generally only be used by classes deriving from <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.
136
<div class="variablelist"><table border="0" class="variablelist">
138
<col align="left" valign="top">
143
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
144
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</td>
147
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
148
<td>the XID of the socket's window.</td>
154
<div class="refsect2">
155
<a name="gtk-plug-construct-for-display"></a><h3>gtk_plug_construct_for_display ()</h3>
156
<pre class="programlisting"><span class="returnvalue">void</span> gtk_plug_construct_for_display (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
157
<em class="parameter"><code><a href="../gdk2/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
158
<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
160
Finish the initialization of <em class="parameter"><code>plug</code></em> for a given <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
161
<em class="parameter"><code>socket_id</code></em> which is currently displayed on <em class="parameter"><code>display</code></em>.
162
This function will generally only be used by classes deriving from <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.
164
<div class="variablelist"><table border="0" class="variablelist">
166
<col align="left" valign="top">
171
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
172
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</td>
175
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
176
<td>the <a href="../gdk2/GdkDisplay.html"><span class="type">GdkDisplay</span></a> associated with <em class="parameter"><code>socket_id</code></em>'s
177
<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</td>
180
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
181
<td>the XID of the socket's window.</td>
185
<p class="since">Since 2.2</p>
188
<div class="refsect2">
189
<a name="gtk-plug-new"></a><h3>gtk_plug_new ()</h3>
190
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_plug_new (<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
192
Creates a new plug widget inside the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified
193
by <em class="parameter"><code>socket_id</code></em>. If <em class="parameter"><code>socket_id</code></em> is 0, the plug is left "unplugged" and
194
can later be plugged into a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> by <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>.
196
<div class="variablelist"><table border="0" class="variablelist">
198
<col align="left" valign="top">
203
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
204
<td>the window ID of the socket, or 0.</td>
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
208
<td>the new <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.</td>
214
<div class="refsect2">
215
<a name="gtk-plug-new-for-display"></a><h3>gtk_plug_new_for_display ()</h3>
216
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_plug_new_for_display (<em class="parameter"><code><a href="../gdk2/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
217
<em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
219
Create a new plug widget inside the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by socket_id.
221
<div class="variablelist"><table border="0" class="variablelist">
223
<col align="left" valign="top">
228
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
229
<td>the <a href="../gdk2/GdkDisplay.html"><span class="type">GdkDisplay</span></a> on which <em class="parameter"><code>socket_id</code></em> is displayed</td>
232
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
233
<td>the XID of the socket's window.</td>
236
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
237
<td>the new <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.</td>
241
<p class="since">Since 2.2</p>
244
<div class="refsect2">
245
<a name="gtk-plug-get-id"></a><h3>gtk_plug_get_id ()</h3>
246
<pre class="programlisting"><a href="../gdk2/gdk2-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a> gtk_plug_get_id (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
248
Gets the window ID of a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget, which can then
249
be used to embed this window inside another window, for
250
instance with <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>.
252
<div class="variablelist"><table border="0" class="variablelist">
254
<col align="left" valign="top">
259
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
260
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</td>
263
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
264
<td>the window ID for the plug</td>
270
<div class="refsect2">
271
<a name="gtk-plug-get-embedded"></a><h3>gtk_plug_get_embedded ()</h3>
272
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_plug_get_embedded (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
274
Determines whether the plug is embedded in a socket.
276
<div class="variablelist"><table border="0" class="variablelist">
278
<col align="left" valign="top">
283
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
284
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>
288
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
290
<code class="literal">TRUE</code> if the plug is embedded in a socket</td>
294
<p class="since">Since 2.14</p>
297
<div class="refsect2">
298
<a name="gtk-plug-get-socket-window"></a><h3>gtk_plug_get_socket_window ()</h3>
299
<pre class="programlisting"><a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * gtk_plug_get_socket_window (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
301
Retrieves the socket the plug is embedded in.
303
<div class="variablelist"><table border="0" class="variablelist">
305
<col align="left" valign="top">
310
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
311
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>
315
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
316
<td>the window of the socket, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
321
<p class="since">Since 2.14</p>
324
<div class="refsect1">
325
<a name="GtkPlug.property-details"></a><h2>Property Details</h2>
326
<div class="refsect2">
327
<a name="GtkPlug--embedded"></a><h3>The <code class="literal">"embedded"</code> property</h3>
328
<pre class="programlisting"> "embedded" <span class="type">gboolean</span> : Read</pre>
330
<code class="literal">TRUE</code> if the plug is embedded in a socket.
332
<p>Default value: FALSE</p>
333
<p class="since">Since 2.12</p>
336
<div class="refsect2">
337
<a name="GtkPlug--socket-window"></a><h3>The <code class="literal">"socket-window"</code> property</h3>
338
<pre class="programlisting"> "socket-window" <a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>* : Read</pre>
340
The window of the socket the plug is embedded in.
342
<p class="since">Since 2.14</p>
345
<div class="refsect1">
346
<a name="GtkPlug.signal-details"></a><h2>Signal Details</h2>
347
<div class="refsect2">
348
<a name="GtkPlug-embedded"></a><h3>The <code class="literal">"embedded"</code> signal</h3>
349
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug,
350
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
352
Gets emitted when the plug becomes embedded in a socket.
354
<div class="variablelist"><table border="0" class="variablelist">
356
<col align="left" valign="top">
361
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
362
<td>the object on which the signal was emitted</td>
365
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
366
<td>user data set when the signal handler was connected.</td>
372
<div class="refsect1">
373
<a name="GtkPlug.see-also"></a><h2>See Also</h2>
374
<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>
379
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'
added
removed
share/gtk-doc/html/gtk2/GtkPlug.html
