GtkTipsQuery: GtkTipsQuery

Description

Displays help about widgets in the user interface

Arguments

Methods and Functions

gtkTipsQueryNew(show = TRUE) gtkTipsQueryStartQuery(object) gtkTipsQueryStopQuery(object) gtkTipsQuerySetCaller(object, caller) gtkTipsQuerySetLabels(object, label.inactive, label.no.tip) gtkTipsQuery(show = TRUE)

Hierarchy

GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkMisc +----GtkLabel +----GtkTipsQuery

Interfaces

GtkTipsQuery implements AtkImplementorIface and GtkBuildable.

Detailed Description

The GtkTipsQuery widget is a subclass of GtkLabel which is used to display help about widgets in a user interface. A query is started with a call to gtkTipsQueryStartQuery, usually when some kind of 'Help' button is pressed. The GtkTipsQuery then grabs all events, stopping the user interface from functioning normally. Then as the user moves the mouse over the widgets, the GtkTipsQuery displays each widget's tooltip text. By connecting to the "widget-entered" or "widget-selected" signals, it is possible to customize the GtkTipsQuery to perform other actions when widgets are entered or selected. For example, a help browser could be opened with documentation on the widget selected. At some point a call to gtkTipsQueryStopQuery must be made in order to stop the query and return the interface to its normal state. The gtkTipsQuerySetCaller 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).

Convenient Construction

gtkTipsQuery is the equivalent of gtkTipsQueryNew.

References

http://library.gnome.org/devel//gtk/GtkTipsQuery.html