~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkSocket.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-09-05 17:27:55 UTC
  • mfrom: (1.14.14)
  • Revision ID: package-import@ubuntu.com-20120905172755-14uyfpowr7elvr7m
Tags: 2.24.12-0ubuntu1
* New upstream bugfix release
* debian/patches/091_bugzilla_tooltip_refresh.patch:
  - Applied upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="PlugSocket.html" title="Cross-process Embedding">
9
9
<link rel="prev" href="GtkPlug.html" title="GtkPlug">
10
10
<link rel="next" href="SpecialObjects.html" title="Special-purpose features">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
49
49
struct              <a class="link" href="GtkSocket.html#GtkSocket-struct" title="struct GtkSocket">GtkSocket</a>;
50
50
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkSocket.html#gtk-socket-new" title="gtk_socket_new ()">gtk_socket_new</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
51
51
<span class="returnvalue">void</span>                <a class="link" href="GtkSocket.html#gtk-socket-steal" title="gtk_socket_steal ()">gtk_socket_steal</a>                    (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>,
52
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> wid</code></em>);
 
52
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> wid</code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()">gtk_socket_add_id</a>                   (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>,
54
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);
55
 
<a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a>     <a class="link" href="GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()">gtk_socket_get_id</a>                   (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);
56
 
<a href="../gdk/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         <a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()">gtk_socket_get_plug_window</a>          (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);
 
55
<a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a>     <a class="link" href="GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()">gtk_socket_get_id</a>                   (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);
 
56
<a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         <a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()">gtk_socket_get_plug_window</a>          (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);
57
57
</pre>
58
58
</div>
59
59
<div class="refsect1">
101
101
<p>
102
102
</p>
103
103
<div class="example">
104
 
<a name="id1232494"></a><p class="title"><b>Example 59. Obtaining the window ID of a socket.</b></p>
 
104
<a name="id1329033"></a><p class="title"><b>Example 59. Obtaining the window ID of a socket.</b></p>
105
105
<div class="example-contents">
106
106
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
107
107
    <tbody>
124
124
<span class="comment"> * the ancestors of the socket is not yet visible.</span>
125
125
<span class="comment"> */</span>
126
126
<span class="function"><a href="GtkWidget.html#gtk-widget-realize">gtk_widget_realize</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">socket</span><span class="symbol">);</span>
127
 
<span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"The ID of the sockets window is %&lt;GTKDOCLINK HREF="</span><span class="normal">x</span><span class="string">"&gt;x&lt;/GTKDOCLINK&gt;</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span>
 
127
<span class="function">g_print</span><span class="normal"> </span><span class="symbol">(</span><span class="string">"The ID of the sockets window is %&lt;GTKDOCLINK HREF="</span><span class="normal">x</span><span class="string">"&gt;x&lt;/GTKDOCLINK&gt;</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span>
128
128
<span class="normal">         </span><span class="function"><a href="GtkSocket.html#gtk-socket-get-id">gtk_socket_get_id</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">socket</span><span class="symbol">));</span></pre></td>
129
129
      </tr>
130
130
    </tbody>
143
143
consequence being that the plug will appear as a
144
144
separate toplevel window. You can check if the plug
145
145
has been created by using <a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()"><code class="function">gtk_socket_get_plug_window()</code></a>. If
146
 
it returns a non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value, then the plug has been
 
146
it returns a non-<a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> value, then the plug has been
147
147
successfully created inside of the socket.
148
148
</p>
149
149
<p>
207
207
<div class="refsect2">
208
208
<a name="gtk-socket-steal"></a><h3>gtk_socket_steal ()</h3>
209
209
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_socket_steal                    (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>,
210
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> wid</code></em>);</pre>
 
210
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> wid</code></em>);</pre>
211
211
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
212
212
<h3 class="title">Warning</h3>
213
213
<p><code class="literal">gtk_socket_steal</code> is deprecated and should not be used in newly-written code.</p>
244
244
<div class="refsect2">
245
245
<a name="gtk-socket-add-id"></a><h3>gtk_socket_add_id ()</h3>
246
246
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_socket_add_id                   (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>,
247
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);</pre>
 
247
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);</pre>
248
248
<p>
249
249
Adds an XEMBED client, such as a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, to the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.  The
250
250
client may be in the same process or in a different process. 
282
282
<hr>
283
283
<div class="refsect2">
284
284
<a name="gtk-socket-get-id"></a><h3>gtk_socket_get_id ()</h3>
285
 
<pre class="programlisting"><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a>     gtk_socket_get_id                   (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
 
285
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a>     gtk_socket_get_id                   (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
286
286
<p>
287
287
Gets the window ID of a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget, which can then
288
288
be used to create a client embedded inside the socket, for
312
312
<hr>
313
313
<div class="refsect2">
314
314
<a name="gtk-socket-get-plug-window"></a><h3>gtk_socket_get_plug_window ()</h3>
315
 
<pre class="programlisting"><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         gtk_socket_get_plug_window          (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
 
315
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         gtk_socket_get_plug_window          (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
316
316
<p>
317
317
Retrieves the window of the plug. Use this to check if the plug has
318
318
been created inside of the socket.
329
329
</tr>
330
330
<tr>
331
331
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
332
 
<td>the window of the plug if available, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.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>
 
332
<td>the window of the plug if available, or <a href="/home/mclasen/gnome/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>
333
333
</td>
334
334
</tr>
335
335
</tbody>
342
342
<div class="refsect2">
343
343
<a name="GtkSocket-plug-added"></a><h3>The <code class="literal">"plug-added"</code> signal</h3>
344
344
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_,
345
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
345
                                                        <span class="type">gpointer</span>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
346
346
<p>
347
347
This signal is emitted when a client is successfully
348
348
added to the socket.
367
367
<hr>
368
368
<div class="refsect2">
369
369
<a name="GtkSocket-plug-removed"></a><h3>The <code class="literal">"plug-removed"</code> signal</h3>
370
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_,
371
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
370
<pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_,
 
371
                                                        <span class="type">gpointer</span>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
372
372
<p>
373
373
This signal is emitted when a client is removed from the socket.
374
374
The default action is to destroy the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget, so if you 
375
 
want to reuse it you must add a signal handler that returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
 
375
want to reuse it you must add a signal handler that returns <code class="literal">TRUE</code>.
376
376
</p>
377
377
<div class="variablelist"><table border="0" class="variablelist">
378
378
<colgroup>
391
391
<tr>
392
392
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
393
393
<td>
394
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked.</td>
 
394
<code class="literal">TRUE</code> to stop other handlers from being invoked.</td>
395
395
</tr>
396
396
</tbody>
397
397
</table></div>
404
404
</div>
405
405
<div class="footer">
406
406
<hr>
407
 
          Generated by GTK-Doc V1.18</div>
 
407
          Generated by GTK-Doc V1.18.1</div>
408
408
</body>
409
409
</html>
 
 
b'\\ No newline at end of file'