← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkTooltips.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:
docs/reference/gtk/html/GtkTooltips.html
48
48
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-enable" title="gtk_tooltips_enable ()">gtk_tooltips_enable</a>                 (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);
49
49
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-disable" title="gtk_tooltips_disable ()">gtk_tooltips_disable</a>                (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);
50
50
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-set-delay" title="gtk_tooltips_set_delay ()">gtk_tooltips_set_delay</a>              (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
51
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> delay</code></em>);
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> delay</code></em>);
52
52
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-set-tip" title="gtk_tooltips_set_tip ()">gtk_tooltips_set_tip</a>                (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
53
53
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
54
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_text</code></em>,
55
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_private</code></em>);
 
54
                                                         <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> *tip_text</code></em>,
 
55
                                                         <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> *tip_private</code></em>);
56
56
<a class="link" href="GtkTooltips.html#GtkTooltipsData" title="GtkTooltipsData"><span class="returnvalue">GtkTooltipsData</span></a>*    <a class="link" href="GtkTooltips.html#gtk-tooltips-data-get" title="gtk_tooltips_data_get ()">gtk_tooltips_data_get</a>               (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);
57
57
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-force-window" title="gtk_tooltips_force_window ()">gtk_tooltips_force_window</a>           (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);
58
 
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkTooltips.html#gtk-tooltips-get-info-from-tip-window" title="gtk_tooltips_get_info_from_tip_window ()">gtk_tooltips_get_info_from_tip_window</a>
 
58
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkTooltips.html#gtk-tooltips-get-info-from-tip-window" title="gtk_tooltips_get_info_from_tip_window ()">gtk_tooltips_get_info_from_tip_window</a>
59
59
                                                        (<em class="parameter"><code><a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> *tip_window</code></em>,
60
60
                                                         <em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> **tooltips</code></em>,
61
61
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> **current_widget</code></em>);
64
64
<div class="refsect1" title="Object Hierarchy">
65
65
<a name="GtkTooltips.object-hierarchy"></a><h2>Object Hierarchy</h2>
66
66
<pre class="synopsis">
67
 
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
68
 
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
67
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
68
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
69
69
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
70
70
               +----GtkTooltips
71
71
</pre>
107
107
<p>
108
108
</p>
109
109
<div class="example">
110
 
<a name="id1372004"></a><p class="title"><b>Example 62. Adding tooltips to buttons.</b></p>
 
110
<a name="id1337876"></a><p class="title"><b>Example 62. Adding tooltips to buttons.</b></p>
111
111
<div class="example-contents">
112
112
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
113
113
    <tbody>
137
137
23
138
138
24
139
139
25</pre></td>
140
 
        <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="GtkWidget.html">GtkWidget</a> </span><span class="symbol">*</span><span class="normal">load_button</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">save_button</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">hbox</span><span class="symbol">;</span>
141
 
<span class="normal"><a href="GtkTooltips.html">GtkTooltips</a> </span><span class="symbol">*</span><span class="normal">button_bar_tips</span><span class="symbol">;</span>
 
140
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">load_button</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">save_button</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">hbox</span><span class="symbol">;</span>
 
141
<span class="usertype">GtkTooltips</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">button_bar_tips</span><span class="symbol">;</span>
142
142
<span class="normal">button_bar_tips </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkTooltips.html#gtk-tooltips-new">gtk_tooltips_new</a></span><span class="normal"> </span><span class="symbol">();</span>
143
143
<span class="comment">/* Create the buttons and pack them into a GtkHBox */</span>
144
 
<span class="normal">hbox </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkHBox.html#gtk-hbox-new">gtk_hbox_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
 
144
<span class="normal">hbox </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkHBox.html#gtk-hbox-new">gtk_hbox_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
145
145
<span class="normal">load_button </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkButton.html#gtk-button-new-with-label">gtk_button_new_with_label</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Load a file"</span><span class="symbol">);</span>
146
 
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> load_button</span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
 
146
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> load_button</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
147
147
<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">load_button</span><span class="symbol">);</span>
148
148
<span class="normal">save_button </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkButton.html#gtk-button-new-with-label">gtk_button_new_with_label</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Save a file"</span><span class="symbol">);</span>
149
 
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> save_button</span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
 
149
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> save_button</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
150
150
<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">save_button</span><span class="symbol">);</span>
151
151
<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">hbox</span><span class="symbol">);</span>
152
152
<span class="comment">/* Add the tips */</span>
153
153
<span class="function"><a href="GtkTooltips.html#gtk-tooltips-set-tip">gtk_tooltips_set_tip</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOOLTIPS</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">button_bar_tips</span><span class="symbol">),</span><span class="normal"> load_button</span><span class="symbol">,</span>
154
 
<span class="normal">                            </span><span class="string">"Load a new document into this window"</span><span class="symbol">,</span>
155
 
<span class="normal">                            </span><span class="string">"Requests the filename of a document.</span>
156
 
<span class="string">                             This will then be loaded into the current</span>
157
 
<span class="string">                             window, replacing the contents of whatever</span>
158
 
<span class="string">                             is already loaded."</span><span class="symbol">);</span>
 
154
<span class="normal">                 </span><span class="string">"Load a new document into this window"</span><span class="symbol">,</span>
 
155
<span class="normal">                 </span><span class="string">"Requests the filename of a document.</span>
 
156
<span class="string">                  This will then be loaded into the current</span>
 
157
<span class="string">                  window, replacing the contents of whatever</span>
 
158
<span class="string">                  is already loaded."</span><span class="symbol">);</span>
159
159
<span class="function"><a href="GtkTooltips.html#gtk-tooltips-set-tip">gtk_tooltips_set_tip</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOOLTIPS</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">button_bar_tips</span><span class="symbol">),</span><span class="normal"> save_button</span><span class="symbol">,</span>
160
 
<span class="normal">                            </span><span class="string">"Saves the current document to a file"</span><span class="symbol">,</span>
161
 
<span class="normal">                            </span><span class="string">"If you have saved the document previously,</span>
162
 
<span class="string">                             then the new version will be saved over the</span>
163
 
<span class="string">                             old one. Otherwise, you will be prompted for</span>
164
 
<span class="string">                             a filename."</span><span class="symbol">);</span></pre></td>
 
160
<span class="normal">                 </span><span class="string">"Saves the current document to a file"</span><span class="symbol">,</span>
 
161
<span class="normal">                 </span><span class="string">"If you have saved the document previously,</span>
 
162
<span class="string">                  then the new version will be saved over the</span>
 
163
<span class="string">                  old one. Otherwise, you will be prompted for</span>
 
164
<span class="string">                  a filename."</span><span class="symbol">);</span></pre></td>
165
165
      </tr>
166
166
    </tbody>
167
167
  </table>
267
267
<div class="refsect2" title="gtk_tooltips_set_delay ()">
268
268
<a name="gtk-tooltips-set-delay"></a><h3>gtk_tooltips_set_delay ()</h3>
269
269
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tooltips_set_delay              (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
270
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> delay</code></em>);</pre>
 
270
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> delay</code></em>);</pre>
271
271
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
272
272
<h3 class="title">Warning</h3>
273
273
<p><code class="literal">gtk_tooltips_set_delay</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
296
296
<a name="gtk-tooltips-set-tip"></a><h3>gtk_tooltips_set_tip ()</h3>
297
297
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tooltips_set_tip                (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
298
298
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
299
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_text</code></em>,
300
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_private</code></em>);</pre>
 
299
                                                         <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> *tip_text</code></em>,
 
300
                                                         <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> *tip_private</code></em>);</pre>
301
301
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
302
302
<h3 class="title">Warning</h3>
303
303
<p><code class="literal">gtk_tooltips_set_tip</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
352
352
</tr>
353
353
<tr>
354
354
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
355
 
<td>a <a class="link" href="GtkTooltips.html#GtkTooltipsData" title="GtkTooltipsData"><span class="type">GtkTooltipsData</span></a> struct, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the widget has no tooltip.
 
355
<td>a <a class="link" href="GtkTooltips.html#GtkTooltipsData" title="GtkTooltipsData"><span class="type">GtkTooltipsData</span></a> struct, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the widget has no tooltip.
356
356
</td>
357
357
</tr>
358
358
</tbody>
385
385
<hr>
386
386
<div class="refsect2" title="gtk_tooltips_get_info_from_tip_window ()">
387
387
<a name="gtk-tooltips-get-info-from-tip-window"></a><h3>gtk_tooltips_get_info_from_tip_window ()</h3>
388
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_tooltips_get_info_from_tip_window
 
388
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_tooltips_get_info_from_tip_window
389
389
                                                        (<em class="parameter"><code><a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> *tip_window</code></em>,
390
390
                                                         <em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> **tooltips</code></em>,
391
391
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> **current_widget</code></em>);</pre>
412
412
<tr>
413
413
<td><p><span class="term"><em class="parameter"><code>tooltips</code></em> :</span></p></td>
414
414
<td>the return location for the tooltips which are displayed 
415
 
   in <em class="parameter"><code>tip_window</code></em>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
415
   in <em class="parameter"><code>tip_window</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
416
416
</td>
417
417
</tr>
418
418
<tr>
419
419
<td><p><span class="term"><em class="parameter"><code>current_widget</code></em> :</span></p></td>
420
420
<td>the return location for the widget whose tooltips 
421
 
   are displayed, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
421
   are displayed, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
422
422
</td>
423
423
</tr>
424
424
<tr>
425
425
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
426
 
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>tip_window</code></em> is displaying tooltips, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
 
426
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>tip_window</code></em> is displaying tooltips, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
427
427
 
428
428
</td>
429
429
</tr>