~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-06-11 12:19:30 UTC
  • mfrom: (1.11.6 upstream)
  • mto: This revision was merged to the branch mainline in revision 175.
  • Revision ID: james.westby@ubuntu.com-20100611121930-n4pklvkoqdsg12vm
Tags: 2.21.2-1
* New upstream development release:
  + debian/rules,
    debian/libgtk2.0-0.symbols:
    - Update for new API symbols.
  + debian/patches/070_mandatory-relibtoolize.patch:
    - Regenerated for the new version.
  + debian/control.in:
    - Update GLib (build-) dependency to >= 2.25.8.

Show diffs side-by-side

added added

removed removed

Lines of Context:
55
55
<span class="returnvalue">void</span>                <a class="link" href="GtkTipsQuery.html#gtk-tips-query-set-caller" title="gtk_tips_query_set_caller ()">gtk_tips_query_set_caller</a>           (<em class="parameter"><code><a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> *tips_query</code></em>,
56
56
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *caller</code></em>);
57
57
<span class="returnvalue">void</span>                <a class="link" href="GtkTipsQuery.html#gtk-tips-query-set-labels" title="gtk_tips_query_set_labels ()">gtk_tips_query_set_labels</a>           (<em class="parameter"><code><a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> *tips_query</code></em>,
58
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_inactive</code></em>,
59
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_no_tip</code></em>);
 
58
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_inactive</code></em>,
 
59
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_no_tip</code></em>);
60
60
</pre>
61
61
</div>
62
62
<div class="refsect1" title="Object Hierarchy">
63
63
<a name="GtkTipsQuery.object-hierarchy"></a><h2>Object Hierarchy</h2>
64
64
<pre class="synopsis">
65
 
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
66
 
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
65
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
66
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
67
67
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
68
68
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
69
69
                     +----<a class="link" href="GtkMisc.html" title="GtkMisc">GtkMisc</a>
81
81
<a name="GtkTipsQuery.properties"></a><h2>Properties</h2>
82
82
<pre class="synopsis">
83
83
  "<a class="link" href="GtkTipsQuery.html#GtkTipsQuery--caller" title='The "caller" property'>caller</a>"                   <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>*            : Read / Write
84
 
  "<a class="link" href="GtkTipsQuery.html#GtkTipsQuery--emit-always" title='The "emit-always" property'>emit-always</a>"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
85
 
  "<a class="link" href="GtkTipsQuery.html#GtkTipsQuery--label-inactive" title='The "label-inactive" property'>label-inactive</a>"           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
86
 
  "<a class="link" href="GtkTipsQuery.html#GtkTipsQuery--label-no-tip" title='The "label-no-tip" property'>label-no-tip</a>"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
84
  "<a class="link" href="GtkTipsQuery.html#GtkTipsQuery--emit-always" title='The "emit-always" property'>emit-always</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
85
  "<a class="link" href="GtkTipsQuery.html#GtkTipsQuery--label-inactive" title='The "label-inactive" property'>label-inactive</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
86
  "<a class="link" href="GtkTipsQuery.html#GtkTipsQuery--label-no-tip" title='The "label-no-tip" property'>label-no-tip</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
87
87
</pre>
88
88
</div>
89
89
<div class="refsect1" title="Signals">
232
232
<div class="refsect2" title="gtk_tips_query_set_labels ()">
233
233
<a name="gtk-tips-query-set-labels"></a><h3>gtk_tips_query_set_labels ()</h3>
234
234
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tips_query_set_labels           (<em class="parameter"><code><a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> *tips_query</code></em>,
235
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_inactive</code></em>,
236
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_no_tip</code></em>);</pre>
 
235
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_inactive</code></em>,
 
236
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label_no_tip</code></em>);</pre>
237
237
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
238
238
<h3 class="title">Warning</h3>
239
239
<p><code class="literal">gtk_tips_query_set_labels</code> is deprecated and should not be used in newly-written code.</p>
280
280
<hr>
281
281
<div class="refsect2" title='The "emit-always" property'>
282
282
<a name="GtkTipsQuery--emit-always"></a><h3>The <code class="literal">"emit-always"</code> property</h3>
283
 
<pre class="programlisting">  "emit-always"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
283
<pre class="programlisting">  "emit-always"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
284
284
<p>
285
 
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the widget-entered and widget-selected signals are emitted even when
 
285
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the widget-entered and widget-selected signals are emitted even when
286
286
the widget has no tooltip set.
287
287
</p>
288
288
<p>Default value: FALSE</p>
290
290
<hr>
291
291
<div class="refsect2" title='The "label-inactive" property'>
292
292
<a name="GtkTipsQuery--label-inactive"></a><h3>The <code class="literal">"label-inactive"</code> property</h3>
293
 
<pre class="programlisting">  "label-inactive"           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
293
<pre class="programlisting">  "label-inactive"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
294
294
<p>
295
295
The text to display in the <a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> widget when the query is not in
296
296
effect.
300
300
<hr>
301
301
<div class="refsect2" title='The "label-no-tip" property'>
302
302
<a name="GtkTipsQuery--label-no-tip"></a><h3>The <code class="literal">"label-no-tip"</code> property</h3>
303
 
<pre class="programlisting">  "label-no-tip"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
303
<pre class="programlisting">  "label-no-tip"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
304
304
<p>
305
305
The text to display in the <a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> widget when the query is running
306
306
and the widget that the pointer is over has no tooltip.
313
313
<div class="refsect2" title='The "start-query" signal'>
314
314
<a name="GtkTipsQuery-start-query"></a><h3>The <code class="literal">"start-query"</code> signal</h3>
315
315
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> *tipsquery,
316
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run First</pre>
 
316
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run First</pre>
317
317
<p>
318
318
Emitted when the query is started.
319
319
</p>
336
336
<div class="refsect2" title='The "stop-query" signal'>
337
337
<a name="GtkTipsQuery-stop-query"></a><h3>The <code class="literal">"stop-query"</code> signal</h3>
338
338
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> *tipsquery,
339
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run First</pre>
 
339
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run First</pre>
340
340
<p>
341
341
Emitted when the query is stopped.
342
342
</p>
360
360
<a name="GtkTipsQuery-widget-entered"></a><h3>The <code class="literal">"widget-entered"</code> signal</h3>
361
361
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a> *tipsquery,
362
362
                                                        <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>    *widget,
363
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *tip_text,
364
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *tip_private,
365
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)        : Run Last</pre>
 
363
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *tip_text,
 
364
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *tip_private,
 
365
                                                        <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>
366
366
<p>
367
367
Emitted when a widget is entered by the pointer while the query is in effect.
368
368
</p>
399
399
<hr>
400
400
<div class="refsect2" title='The "widget-selected" signal'>
401
401
<a name="GtkTipsQuery-widget-selected"></a><h3>The <code class="literal">"widget-selected"</code> signal</h3>
402
 
<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="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a>   *tipsquery,
 
402
<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="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a>   *tipsquery,
403
403
                                                        <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>      *widget,
404
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>          *tip_text,
405
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>          *tip_private,
406
 
                                                        <a href="/usr/share/gtk-doc/html/gdk/gdk-Event-Structures.html#GdkEventButton"><span class="type">GdkEventButton</span></a> *event,
407
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)        : Run Last</pre>
 
404
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>          *tip_text,
 
405
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>          *tip_private,
 
406
                                                        <a href="http://library.gnome.org/devel/gdk/unstable/gdk-Event-Structures.html#GdkEventButton"><span class="type">GdkEventButton</span></a> *event,
 
407
                                                        <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>
408
408
<p>
409
409
Emitted when a widget is selected during a query.
410
410
</p>
443
443
<tr>
444
444
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
445
445
<td>
446
 
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query should be stopped.
 
446
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query should be stopped.
447
447
</td>
448
448
</tr>
449
449
</tbody>