← Back to branch summary

~bratsche/ubuntu/maverick/gtk+2.0/menu-activation-fix

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-06-11 11:48:48 UTC
  • mfrom: (1.11.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20100611114848-dkrsp735aof0oqme
Tags: 2.21.2-0ubuntu1
https://launchpad.net/bugs/590374
* New upstream version:
  - The newly added gdk_drag_context_get_action function has been
    renamed to gdk_drag_context_get_selected_action to make the
    name less confusing.
  - Introspection annotations have been added in many places
  - New accessors for sealed struct members:
    gtk_viewport_get_view_window
    gdk_drag_context_get_source_window
  - Bug fixes:
    608218 GtkOffscreenWindow causes bad window with GtkEntry
    611709 Add gtk_statusbar_remove_all
    596428 GtkAssistant: Support ending with a progress page
    620511 Use g_source_set_name for all custom GSources in GTK+
    608537 Make the file chooser's sort arrows consistent (lp:#509656)
    620863 Unable to select GtkMenu item above the current one (lp: #590374)
* debian/control.in:
  - updated glib requirement
* debian/patches/065_build_introspection_file.patch:
  - dropped, the fix is in the new version
* debian/libgtk2.0-0.symbols:
  - new version update
* debian/patches/070_mandatory-relibtoolize.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/html/GtkSocket.html
49
49
                    <a class="link" href="GtkSocket.html#GtkSocket-struct" title="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="/usr/share/gtk-doc/html/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/gdk/unstable/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="/usr/share/gtk-doc/html/gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);
55
 
<a href="/usr/share/gtk-doc/html/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="/usr/share/gtk-doc/html/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/gdk/unstable/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);
 
55
<a href="http://library.gnome.org/devel/gdk/unstable/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/gdk/unstable/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" title="Object Hierarchy">
60
60
<a name="GtkSocket.object-hierarchy"></a><h2>Object Hierarchy</h2>
61
61
<pre class="synopsis">
62
 
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
63
 
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
62
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
63
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
64
64
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
65
65
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
66
66
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
101
101
<p>
102
102
</p>
103
103
<div class="example">
104
 
<a name="id1276313"></a><p class="title"><b>Example 56. Obtaining the window ID of a socket.</b></p>
 
104
<a name="id1167288"></a><p class="title"><b>Example 56. 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>
116
116
8
117
117
9
118
118
10</pre></td>
119
 
        <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="GtkWidget.html">GtkWidget</a> </span><span class="symbol">*</span><span class="normal">socket </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkSocket.html#gtk-socket-new">gtk_socket_new</a></span><span class="normal"> </span><span class="symbol">();</span>
 
119
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">socket </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkSocket.html#gtk-socket-new">gtk_socket_new</a></span><span class="normal"> </span><span class="symbol">();</span>
120
120
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">socket</span><span class="symbol">);</span>
121
121
<span class="function"><a href="GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">parent</span><span class="symbol">),</span><span class="normal"> socket</span><span class="symbol">);</span>
122
122
 
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="/usr/share/gtk-doc/html/glib/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"><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>
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="/usr/share/gtk-doc/html/glib/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="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
147
147
successfully created inside of the socket.
148
148
</p>
149
149
<p>
205
205
<div class="refsect2" title="gtk_socket_steal ()">
206
206
<a name="gtk-socket-steal"></a><h3>gtk_socket_steal ()</h3>
207
207
<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>,
208
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> wid</code></em>);</pre>
 
208
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> wid</code></em>);</pre>
209
209
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
210
210
<h3 class="title">Warning</h3>
211
211
<p><code class="literal">gtk_socket_steal</code> is deprecated and should not be used in newly-written code.</p>
240
240
<div class="refsect2" title="gtk_socket_add_id ()">
241
241
<a name="gtk-socket-add-id"></a><h3>gtk_socket_add_id ()</h3>
242
242
<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>,
243
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);</pre>
 
243
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> window_id</code></em>);</pre>
244
244
<p>
245
245
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
246
246
client may be in the same process or in a different process. 
276
276
<hr>
277
277
<div class="refsect2" title="gtk_socket_get_id ()">
278
278
<a name="gtk-socket-get-id"></a><h3>gtk_socket_get_id ()</h3>
279
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/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>
 
279
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk/unstable/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>
280
280
<p>
281
281
Gets the window ID of a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget, which can then
282
282
be used to create a client embedded inside the socket, for
305
305
<hr>
306
306
<div class="refsect2" title="gtk_socket_get_plug_window ()">
307
307
<a name="gtk-socket-get-plug-window"></a><h3>gtk_socket_get_plug_window ()</h3>
308
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/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>
 
308
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk/unstable/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>
309
309
<p>
310
310
Retrieves the window of the plug. Use this to check if the plug has
311
311
been created inside of the socket.
320
320
</tr>
321
321
<tr>
322
322
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
323
 
<td> the window of the plug if available, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
323
<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>
324
324
 
325
325
</td>
326
326
</tr>
334
334
<div class="refsect2" title='The "plug-added" signal'>
335
335
<a name="GtkSocket-plug-added"></a><h3>The <code class="literal">"plug-added"</code> signal</h3>
336
336
<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_,
337
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last</pre>
 
337
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last</pre>
338
338
<p>
339
339
This signal is emitted when a client is successfully
340
340
added to the socket.
357
357
<hr>
358
358
<div class="refsect2" title='The "plug-removed" signal'>
359
359
<a name="GtkSocket-plug-removed"></a><h3>The <code class="literal">"plug-removed"</code> signal</h3>
360
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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_,
361
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last</pre>
 
360
<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_,
 
361
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last</pre>
362
362
<p>
363
363
This signal is emitted when a client is removed from the socket.
364
364
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 
365
 
want to reuse it you must add a signal handler that returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
 
365
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>.
366
366
</p>
367
367
<div class="variablelist"><table border="0">
368
368
<col align="left" valign="top">
378
378
</tr>
379
379
<tr>
380
380
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
381
 
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked.
 
381
<td> <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.
382
382
</td>
383
383
</tr>
384
384
</tbody>