PHP Editor Review - Gtk Manual Gtk gtktipsquery

GtkTipsQuery

Displays help about widgets in the user interface.

Object Hierarchy

GtkObject
`-- GtkWidget
       `-- GtkMisc
              `-- GtkLabel
                     `-- GtkTipsQuery

Direct subclasses

None.

Description

The TipsQuery is a label which displays the tooltips of the widgets the mouse hovers. First it has to be activated with start_query() : The mouse cursor changes and the label comes to life, displaying the tooltips of the hovering widget. The query is automatically deactivated when the user clicks somewhere.

With the help of the "widget_entered" signal, one could display a small tool tip showing the extendet data of a tooltip or call a help browser. For this purpose, the private (extendet) tooltip data could contain location of the page the help browser should display.

GtkTipsQuery has been deprecated since GTK+ 2.0 and should not be used in newly written code.

Constructor

GtkTipsQuery (void);
-- Creates a new TipsQuery object.

Methods

start_query()
Activates the widget
stop_query()
Stops a started query
set_caller()
Sets the widget which initiates the query, usually a button.
set_labels()
Sets the tooltip label for non-active states.

Signals

"widget_entered"
Emitted when an active tips query enters a widget by hovering it.
"widget_selected"
Emitted when a widget is clicked while a tips query is active.