<html> <head><title>Gtk-- Reference: Gtk::Tooltips</title></head> <body bgcolor="#F0F0F0" text="#000000" link="#0000FF" vlink="#000077" alink="#FF0000"> <table align=center border=0 cellspacing=10> <tr> <td><a href="class_index.html">Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="name_index.html">Namespace Index</a></td> </table> <h1 align=center>Class Gtk::Tooltips</h1><p> <b> Tooltip group</b><br> Contained in: <a href="Gtk.html">Gtk</a><br> Derived from: <a href="Gtk%3A%3AData.html">Gtk::Data</a> <br> Derived by: <i>none</i> <p> #include <gtk--/tooltips.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3118"><tt><font color=blue><b>Tooltips</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3120"><tt><font color=blue><b>disable</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3119"><tt><font color=blue><b>enable</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3125"><tt><font color=blue><b>force_window</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>GtkTooltips</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3114"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>GtkTooltips</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3115"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3116"><tt><font color=blue><b>isA</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3123"><tt><font color=blue><b>set_colors</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>Gdk_Color</font></tt>& <tt><font color=blue>background</font></tt>, <tt>const</tt> <tt><font color=navy>Gdk_Color</font></tt>& <tt><font color=blue>foreground</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3121"><tt><font color=blue><b>set_delay</b></font></tt></a></td><td><tt>(<tt><font color=purple>guint</font></tt> <tt><font color=blue>delay</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3122"><tt><font color=blue><b>set_tip</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>widget</font></tt>, <tt>const</tt> <a href="Gtk%3A%3Anstring.html"><tt><font color=navy><b>nstring</b></font></tt></a>& <tt><font color=blue>tip_text</font></tt>=0, <tt>const</tt> <a href="Gtk%3A%3Anstring.html"><tt><font color=navy><b>nstring</b></font></tt></a>& <tt><font color=blue>tip_private</font></tt>=0)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3117"><tt><font color=blue><b>~Tooltips</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td><tr><td colspan=3><h3>protected function member index:</h3></td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=navy>GtkTooltipsData</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3ATooltips.html#3124"><tt><font color=blue><b>data_get</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>widget</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> 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 description of things such as buttons in a toolbar. <P> An individual tooltip belongs to a group of tooltips. Every tooltip in the group can then be turned off with a call to <a href="Gtk%3A%3ATooltips.html#3120"><tt><font color=blue><b>disable</b></font></tt></a> and enabled with <a href="Gtk%3A%3ATooltips.html#3119"><tt><font color=blue><b>enable</b></font></tt></a>. <P> The length of time the user must keep the mouse over a widget before the tip is shown, can be altered with <a href="Gtk%3A%3ATooltips.html#3121"><tt><font color=blue><b>set_delay</b></font></tt></a>. This is set on a 'per group of tooltips' basis. <P> To assign a tip to a particular <tt><a href="Gtk.html"><tt><font color=navy><b>Gtk</b></font></tt></a>::<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a></tt>, <a href="Gtk%3A%3ATooltips.html#3122"><tt><font color=blue><b>set_tip</b></font></tt></a> is used. <P> <b>Note:</b> Tooltips can only be set on widgets which have their own X window. To add a tooltip to a widget that doesn't have its own window, place the widget inside a <tt><a href="Gtk.html"><tt><font color=navy><b>Gtk</b></font></tt></a>::<a href="Gtk%3A%3AEventBox.html"><tt><font color=navy><b>EventBox</b></font></tt></a></tt> and add a tooltip to that instead. <P> The default appearance of all tooltips in a program is determined by the current gtk theme that the user has selected. <P> Information about the tooltip (if any) associated with an arbitrary widget can be retrieved using <a href="Gtk%3A%3ATooltips.html#3124"><tt><font color=blue><b>data_get</b></font></tt></a>.<br> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="3124"><font size=+1><b>Gtk::Tooltips::data_get</b></font></a> - get tips data from a widget <i>(internal)</i><br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>static</tt> <tt><font color=navy>GtkTooltipsData</font></tt>*</tt> <a href="Gtk%3A%3ATooltips.html#3124"><tt><font color=blue><b>data_get</b></font></tt></a><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>widget</font></tt>)</tt>;<br><br> <a name="3120"><font size=+1><b>Gtk::Tooltips::disable</b></font></a> - Disable this tooltip group.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATooltips.html#3120"><tt><font color=blue><b>disable</b></font></tt></a><tt>()</tt>;<br><br> <a name="3119"><font size=+1><b>Gtk::Tooltips::enable</b></font></a> - Enable this tooltip group.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATooltips.html#3119"><tt><font color=blue><b>enable</b></font></tt></a><tt>()</tt>;<br><br> <a name="3114"><font size=+1><b>Gtk::Tooltips::gtkobj</b></font></a> - Returns the underlaying gtk+ object.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=navy>GtkTooltips</font></tt>*</tt> <a href="Gtk%3A%3ATooltips.html#3114"><tt><font color=blue><b>gtkobj</b></font></tt></a><tt>()</tt>;<br><br> <a name="3116"><font size=+1><b>Gtk::Tooltips::isA</b></font></a> - Returns true if object is this type.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> <a href="Gtk%3A%3ATooltips.html#3116"><tt><font color=blue><b>isA</b></font></tt></a><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;<br><br> <a name="3123"><font size=+1><b>Gtk::Tooltips::set_colors</b></font></a> - This function is unimplemented because tooltip colors are instead determined by the theme.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATooltips.html#3123"><tt><font color=blue><b>set_colors</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>Gdk_Color</font></tt>& <tt><font color=blue>background</font></tt>, <tt>const</tt> <tt><font color=navy>Gdk_Color</font></tt>& <tt><font color=blue>foreground</font></tt>)</tt>;<br><br> <a name="3121"><font size=+1><b>Gtk::Tooltips::set_delay</b></font></a> - Set the time before tooltips are displayed.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATooltips.html#3121"><tt><font color=blue><b>set_delay</b></font></tt></a><tt>(<tt><font color=purple>guint</font></tt> <tt><font color=blue>delay</font></tt>)</tt>;<br><blockquote> <tt><font color=blue>delay</font></tt> is in seconds.</blockquote> <br><br> <a name="3122"><font size=+1><b>Gtk::Tooltips::set_tip</b></font></a> - Set a tip for a widget.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATooltips.html#3122"><tt><font color=blue><b>set_tip</b></font></tt></a><tt>(<tt>const</tt> <a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>widget</font></tt>, <tt>const</tt> <a href="Gtk%3A%3Anstring.html"><tt><font color=navy><b>nstring</b></font></tt></a>& <tt><font color=blue>tip_text</font></tt>=0, <tt>const</tt> <a href="Gtk%3A%3Anstring.html"><tt><font color=navy><b>nstring</b></font></tt></a>& <tt><font color=blue>tip_private</font></tt>=0)</tt>;<br><br> <hr noshade> </html>