Synopsis#include <gtk/gtk.h> GtkTipsQuery; GtkWidget* gtk_tips_query_new (void); void gtk_tips_query_start_query (GtkTipsQuery *tips_query); void gtk_tips_query_stop_query (GtkTipsQuery *tips_query); void gtk_tips_query_set_caller (GtkTipsQuery *tips_query, GtkWidget *caller); void gtk_tips_query_set_labels (GtkTipsQuery *tips_query, const gchar *label_inactive, const gchar *label_no_tip); Object HierarchyGObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkMisc +----GtkLabel +----GtkTipsQuery Properties"caller" GtkWidget* : Read / Write "emit-always" gboolean : Read / Write "label-inactive" gchar* : Read / Write "label-no-tip" gchar* : Read / Write Signals"start-query" : Run First "stop-query" : Run First "widget-entered" : Run Last "widget-selected" : Run Last DescriptionThe 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 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 DetailsGtkTipsQuerytypedef struct _GtkTipsQuery GtkTipsQuery; Warning
The GtkTipsQuery struct contains private data only, and should be accessed using the functions below. gtk_tips_query_new ()GtkWidget* gtk_tips_query_new (void); Warning
Creates a new GtkTipsQuery.
gtk_tips_query_start_query ()void gtk_tips_query_start_query (GtkTipsQuery *tips_query); Warning
Starts a query. The GtkTipsQuery widget will take control of the mouse and as the mouse moves it will display the tooltip of the widget beneath the mouse.
gtk_tips_query_stop_query ()void gtk_tips_query_stop_query (GtkTipsQuery *tips_query); Warning
Stops a query.
gtk_tips_query_set_caller ()void gtk_tips_query_set_caller (GtkTipsQuery *tips_query, GtkWidget *caller); Warning
Sets the widget which initiates the query, usually a button.
If the
gtk_tips_query_set_labels ()void gtk_tips_query_set_labels (GtkTipsQuery *tips_query, const gchar *label_inactive, const gchar *label_no_tip); Warning
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.
Property DetailsThe
|
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"stop-query"
signalvoid user_function (GtkTipsQuery *tipsquery, gpointer user_data) : Run First
Emitted when the query is stopped.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"widget-entered"
signalvoid user_function (GtkTipsQuery *tipsquery, GtkWidget *widget, gchar *tip_text, gchar *tip_private, gpointer user_data) : Run Last
Emitted when a widget is entered by the pointer while the query is in effect.
|
the object which received the signal. |
|
the widget that was entered by the pointer. |
|
the widget's tooltip. |
|
the widget's private tooltip (see gtk_tooltips_set_tip() ).
|
|
user data set when the signal handler was connected. |
"widget-selected"
signalgboolean user_function (GtkTipsQuery *tipsquery, GtkWidget *widget, gchar *tip_text, gchar *tip_private, GdkEventButton *event, gpointer user_data) : Run Last
Emitted when a widget is selected during a query.
|
the object which received the signal. |
|
the widget that was selected. |
|
the widget's tooltip. |
|
the widget's private tooltip (see gtk_tooltips_set_tip() ).
|
|
the button press or button release event. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the query should be stopped.
|