<html> <head><title>Gtk-- Reference: Gtk::TipsQuery</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::TipsQuery</h1><p> <b> Displays help about widgets in the user interface.</b><br> Contained in: <a href="Gtk.html">Gtk</a><br> Derived from: <a href="Gtk%3A%3ALabel.html">Gtk::Label</a> <br> Derived by: <i>none</i> <p> #include <gtk--/tipsquery.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%3ATipsQuery.html#2981"><tt><font color=blue><b>TipsQuery</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>GtkTipsQuery</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2977"><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>GtkTipsQuery</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2978"><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%3ATipsQuery.html#2979"><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%3ATipsQuery.html#2984"><tt><font color=blue><b>set_caller</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>caller</font></tt>=0)</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%3ATipsQuery.html#2985"><tt><font color=blue><b>set_caller</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>caller</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%3ATipsQuery.html#2986"><tt><font color=blue><b>set_labels</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>string</font></tt>& <tt><font color=blue>label_inactive</font></tt>, <tt>const</tt> <tt><font color=navy>string</font></tt>& <tt><font color=blue>label_no_tip</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2982"><tt><font color=blue><b>start_query</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2983"><tt><font color=blue><b>stop_query</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2980"><tt><font color=blue><b>~TipsQuery</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>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2987"><tt><font color=blue><b>start_query_impl</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2988"><tt><font color=blue><b>stop_query_impl</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2989"><tt><font color=blue><b>widget_entered_impl</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>p0</font></tt>, <tt>const</tt> <tt><font color=purple>gchar</font></tt>* <tt><font color=blue>p1</font></tt>, <tt>const</tt> <tt><font color=purple>gchar</font></tt>* <tt><font color=blue>p2</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>gint</font></tt></tt> </td><td align=right><a href="Gtk%3A%3ATipsQuery.html#2990"><tt><font color=blue><b>widget_selected_impl</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>p0</font></tt>, <tt>const</tt> <tt><font color=purple>gchar</font></tt>* <tt><font color=blue>p1</font></tt>, <tt>const</tt> <tt><font color=purple>gchar</font></tt>* <tt><font color=blue>p2</font></tt>, <tt><font color=navy>GdkEventButton</font></tt>* <tt><font color=blue>p3</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> The <tt><font color=navy><b>Gtk::TipsQuery</b></font></tt> widget is a subclass of <tt><a href="Gtk.html"><tt><font color=navy><b>Gtk</b></font></tt></a>::<a href="Gtk%3A%3ALabel.html"><tt><font color=navy><b>Label</b></font></tt></a></tt> which is used to display help about widgets in a user interface. <P> A query is started with a call to <a href="Gtk%3A%3ATipsQuery.html#2982"><tt><font color=blue><b>start_query</b></font></tt></a>, usually when some kind of 'Help' button is pressed. The <tt><font color=navy><b>Gtk::TipsQuery</b></font></tt> then grabs all events, stopping the user interface from functioning normally. Then as the user moves the mouse over the widgets, the <tt><font color=navy><b>Gtk::TipsQuery</b></font></tt> displays each widget's tooltip text. <P> By connecting to the "widget-entered" or "widget-selected" signals, it is possible to customize the <tt><font color=navy><b>Gtk::TipsQuery</b></font></tt> to perform other actions when widgets are entered or selected. For example, a help browser could be opened with documentation on the widget selected. <P> At some point a call to <a href="Gtk%3A%3ATipsQuery.html#2983"><tt><font color=blue><b>stop_query</b></font></tt></a> must be made in order to stop the query and return the interface to its normal state. The <a href="Gtk%3A%3ATipsQuery.html#2985"><tt><font color=blue><b>set_caller</b></font></tt></a> function can be used to specify a widget which the user can select to stop the query (often the same button used to start the query).<br> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="2977"><font size=+1><b>Gtk::TipsQuery::gtkobj</b></font></a> - Returns the underlaying gtk+ object.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=navy>GtkTipsQuery</font></tt>*</tt> <a href="Gtk%3A%3ATipsQuery.html#2977"><tt><font color=blue><b>gtkobj</b></font></tt></a><tt>()</tt>;<br><br> <a name="2979"><font size=+1><b>Gtk::TipsQuery::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%3ATipsQuery.html#2979"><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="2984"><font size=+1><b>Gtk::TipsQuery::set_caller</b></font></a> - Emitted when a widget is entered by the pointer while the query is in effect. Emitted when a widget is selected during a query. Sets the widget which initiates the query, usually a button.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATipsQuery.html#2984"><tt><font color=blue><b>set_caller</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>caller</font></tt>=0)</tt>;<br><blockquote> If the caller is selected while the query is running, the query is automatically stopped. <P> <tt><font color=blue>caller</font></tt>: The widget which initiates the query.</blockquote> <br><br> <a name="2985"><font size=+1><b>Gtk::TipsQuery::set_caller</b></font></a> - Sets the widget which initiates the query, usually a button.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATipsQuery.html#2985"><tt><font color=blue><b>set_caller</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>caller</font></tt>)</tt>;<br><blockquote> If the caller is selected while the query is running, the query is automatically stopped. <P> <tt><font color=blue>caller</font></tt>: The widget which initiates the query.</blockquote> <br><br> <a name="2986"><font size=+1><b>Gtk::TipsQuery::set_labels</b></font></a> - Sets the text to display when the query is not in effect, and the text to display when the query is in effect but the widget beneath the pointer has no tooltip.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATipsQuery.html#2986"><tt><font color=blue><b>set_labels</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>string</font></tt>& <tt><font color=blue>label_inactive</font></tt>, <tt>const</tt> <tt><font color=navy>string</font></tt>& <tt><font color=blue>label_no_tip</font></tt>)</tt>;<br><blockquote> <tt><font color=blue>label_inactive</font></tt>: The text to display when the query is not running. <P> <tt><font color=blue>label_no_tip</font></tt>: The text to display when the query is running but the widget beneath the pointer has no tooltip.</blockquote> <br><br> <a name="2982"><font size=+1><b>Gtk::TipsQuery::start_query</b></font></a> - Emitted when the query is started.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATipsQuery.html#2982"><tt><font color=blue><b>start_query</b></font></tt></a><tt>()</tt>;<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATipsQuery.html#2987"><tt><font color=blue><b>start_query_impl</b></font></tt></a><tt>()</tt>;<br><br> <a name="2983"><font size=+1><b>Gtk::TipsQuery::stop_query</b></font></a> - Emitted when the query is stopped.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATipsQuery.html#2983"><tt><font color=blue><b>stop_query</b></font></tt></a><tt>()</tt>;<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3ATipsQuery.html#2988"><tt><font color=blue><b>stop_query_impl</b></font></tt></a><tt>()</tt>;<br><br> <hr noshade> </html>
distrib
>
Mandriva
>
9.1
>
ppc
>
media
>
main
>
by-pkgid
>
ca81b57b553ae75608ba0fc5e7925e4e
>
files
>
430
