/usr/share/gtk-doc/html/pygtk/class-gtktooltips.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Tooltips</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtktooltip.html" title="gtk.Tooltip"><link rel="next" href="class-gtktreedragdest.html" title="gtk.TreeDragDest"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Tooltips</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktooltip.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtktreedragdest.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Tooltips"><a name="class-gtktooltips"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Tooltips</h2><p>gtk.Tooltips — add tips to your widgets.</p></div><div class="refsect1" title="Synopsis"><a name="id4015611"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Tooltips</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtktooltips.html#constructor-gtktooltips" title="Constructor">gtk.Tooltips</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktooltips.html#method-gtktooltips--enable" title="gtk.Tooltips.enable">enable</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktooltips.html#method-gtktooltips--disable" title="gtk.Tooltips.disable">disable</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktooltips.html#method-gtktooltips--set-tip" title="gtk.Tooltips.set_tip">set_tip</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tip_text</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tip_private</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktooltips.html#method-gtktooltips--force-window" title="gtk.Tooltips.force_window">force_window</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktooltips.html#function-gtk--tooltips-data-get" title="gtk.tooltips_data_get">gtk.tooltips_data_get</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id4015817"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtktooltips.html" title="gtk.Tooltips">gtk.Tooltips</a>
</pre></div><div class="refsect1" title="gtk.Tooltips Properties"><a name="properties-gtktooltips"></a><h2>gtk.Tooltips Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p></div><div class="refsect1" title="Attributes"><a name="id4015868"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"tip_window"</td><td valign="top">Read</td><td valign="top">The window that the tooltip is displayed in.</td></tr><tr valign="top"><td valign="top">"tip_label"</td><td valign="top">Read</td><td valign="top">The label that displays the tooltip text.</td></tr><tr valign="top"><td valign="top">"active_tips_data"</td><td valign="top">Read</td><td valign="top">The data associated with the active tooltip.</td></tr><tr valign="top"><td valign="top">"tips_data_list"</td><td valign="top">Read</td><td valign="top">A list containing the data associated with the tooltips in a tooltips group. For each tooltip the data is a tuple containing:
the tooltip object, the associated widget, the tooltip text and the tooltip
private text.</td></tr><tr valign="top"><td valign="top">"delay"</td><td valign="top">Read</td><td valign="top">The delay between the mouse pausing over the widget and
the display of the tooltip in msec.</td></tr><tr valign="top"><td valign="top">"enabled"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> the tooltips are
enabled</td></tr><tr valign="top"><td valign="top">"use_sticky_delay"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> shorten the delay for
showing a tooltip on another widget is already showing a tooltip.</td></tr><tr valign="top"><td valign="top">"timer_tag"</td><td valign="top">Read</td><td valign="top">The tag of the timeout handler used for the
delay.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Tooltips Signal Prototypes"><a name="signal-prototypes-gtktooltips"></a><h2>gtk.Tooltips Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p></div><div class="refsect1" title="Description"><a name="id4016110"></a><h2>Description</h2><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.12 and above</p></div><p>Tooltips are the messages that appear next to a widget when the
mouse pointer is held over it for a short amount of time. They are
especially helpful for adding more verbose descriptions of things such as
buttons in a toolbar. An individual tooltip belongs to a group of tooltips.
A group is created with a call to the <a class="link" href="class-gtktooltips.html#constructor-gtktooltips" title="Constructor">gtk.Tooltips</a>() constructor. Every
tooltip in the group can then be turned off with a call to the <a class="link" href="class-gtktooltips.html#method-gtktooltips--disable" title="gtk.Tooltips.disable"><code class="methodname">disable</code>()</a>
method and enabled with the <a class="link" href="class-gtktooltips.html#method-gtktooltips--enable" title="gtk.Tooltips.enable"><code class="methodname">enable</code>()</a>
method. To assign a tip to a particular <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a>, use the
<a class="link" href="class-gtktooltips.html#method-gtktooltips--set-tip" title="gtk.Tooltips.set_tip"><code class="methodname">set_tip</code>()</a>
method.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Tooltips can only be set on widgets which have their own X
window. To check if a widget has its own window use
<code class="literal">widget.flags()&gtk.NO_WINDOW</code>. To add a tooltip to a
widget that doesn't have its own window, place the widget inside a <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a> and
add a tooltip to the eventbox instead.</p></div><p>The default appearance of all tooltips in a program is determined
by the current theme that the user has selected. Information about the
tooltip (if any) associated with an arbitrary widget can be retrieved using
the <a class="link" href="class-gtktooltips.html#function-gtk--tooltips-data-get" title="gtk.tooltips_data_get"><code class="function">gtk.tooltips_data_get</code>()</a>
function.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtktooltips"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Tooltips</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtktooltips.html" title="gtk.Tooltips"><code class="classname">gtk.Tooltips</code></a>
object</td></tr></tbody></table><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.12 and above</p></div><p>Creates an empty <a class="link" href="class-gtktooltips.html" title="gtk.Tooltips"><code class="classname">gtk.Tooltips</code></a>
group.</p></div><div class="refsect1" title="Methods"><a name="id4016297"></a><h2>Methods</h2><div class="refsect2" title="gtk.Tooltips.enable"><a name="method-gtktooltips--enable"></a><h3>gtk.Tooltips.enable</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">enable</span>(<span class="methodparam"></span>)</code></pre><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.12 and above</p></div><p>The <code class="methodname">enable</code>() method enables a group of
tooltips. A tooltip will be displayed over its associated widget when
the mouse pointer pauses over the widget.</p></div><div class="refsect2" title="gtk.Tooltips.disable"><a name="method-gtktooltips--disable"></a><h3>gtk.Tooltips.disable</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">disable</span>(<span class="methodparam"></span>)</code></pre><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.12 and above</p></div><p>The <code class="methodname">disable</code>() method disables a group
of tooltips. A tooltip will not be displayed over its associated widget when
the mouse pointer pauses over the widget.</p></div><div class="refsect2" title="gtk.Tooltips.set_tip"><a name="method-gtktooltips--set-tip"></a><h3>gtk.Tooltips.set_tip</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_tip</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tip_text</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tip_private</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>widget</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>tip_text</code></strong> :</span></p></td><td>the tooltip text</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>tip_private</code></strong> :</span></p></td><td>the tooltip private text for context sensitive display</td></tr></tbody></table><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.12 and above</p></div><p>The <code class="methodname">set_tips</code>() method creates a tooltip
for the specified <em class="parameter"><code>widget</code></em>. The text specified by
<em class="parameter"><code>tooltip_text</code></em> will be displayed when the mouse pointer
pauses over <em class="parameter"><code>widget</code></em> if the tooltips are
enabled..</p></div><div class="refsect2" title="gtk.Tooltips.force_window"><a name="method-gtktooltips--force-window"></a><h3>gtk.Tooltips.force_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">force_window</span>(<span class="methodparam"></span>)</code></pre><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.12 and above</p></div><p>The <code class="methodname">force_window</code>() method ensures that
the window used for displaying the given tooltips is created. Applications
should never have to call this function, since PyGTK takes care of
this.</p></div></div><div class="refsect1" title="Functions"><a name="id4016628"></a><h2>Functions</h2><div class="refsect2" title="gtk.tooltips_data_get"><a name="function-gtk--tooltips-data-get"></a><h3>gtk.tooltips_data_get</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.tooltips_data_get</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>widget</code></strong> :</span></p></td><td>a widget</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing the tooltip data associated
with <em class="parameter"><code>widget</code></em> or
<code class="literal">None</code></td></tr></tbody></table><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.12 and above</p></div><p>The <code class="function">gtk.tooltips_data_get</code>() function
returns a tuple containing the tooltip data associated with
<em class="parameter"><code>widget</code></em>. The tuple contains:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">the <a class="link" href="class-gtktooltips.html" title="gtk.Tooltips"><code class="classname">gtk.Tooltips</code></a> group
containing the tooltip</li><li class="listitem">the widget</li><li class="listitem">the tooltip text string</li><li class="listitem">the tooltip private text string or
<code class="literal">None</code></li></ul></div><p>If <em class="parameter"><code>widget</code></em> does not have an associated
tooltip this function returns <code class="literal">None</code>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtktooltip.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtktreedragdest.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Tooltip </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.TreeDragDest</td></tr></table></div></body></html>
|