Name
GtkTipsQuery -- displays help about widgets in the user interface.
Signal Prototypes
"start-query"
void user_function (GtkTipsQuery *tipsquery,
gpointer user_data);
"stop-query"
void user_function (GtkTipsQuery *tipsquery,
gpointer user_data);
"widget-entered"
void user_function (GtkTipsQuery *tipsquery,
GtkWidget *widget,
gchar *tip_text,
gchar *tip_private,
gpointer user_data);
"widget-selected"
gboolean user_function (GtkTipsQuery *tipsquery,
GtkWidget *widget,
gchar *tip_text,
gchar *tip_private,
GdkEventButton *event,
gpointer user_data); |
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 gtk_tips_query_start_query(), 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 gtk_tips_query_stop_query() must be made in order to
stop the query and return the interface to its normal state.
The gtk_tips_query_set_caller() 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).
Details
struct GtkTipsQuery
The GtkTipsQuery struct contains private data only, and
should be accessed using the functions below.
gtk_tips_query_start_query ()
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 ()
Stops a query.
gtk_tips_query_set_caller ()
Sets the widget which initiates the query, usually a button.
If the caller is selected while the query is running, the query is
automatically stopped.
gtk_tips_query_set_labels ()
void gtk_tips_query_set_labels (GtkTipsQuery *tips_query,
const gchar *label_inactive,
const gchar *label_no_tip); |
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.
Args
- "emit_always" (gboolean : Read / Write)
TRUE if the widget-entered and widget-selected signals are emitted even when
the widget has no tooltip set.
- "caller" (GtkWidget : Read / Write)
The widget that starts the tips query, usually a button.
If it is selected while the query is in effect the query is automatically
stopped.
- "label_inactive" (gchar* : Read / Write)
The text to display in the GtkTipsQuery widget when the query is not in
effect.
- "label_no_tip" (gchar* : Read / Write)
The text to display in the GtkTipsQuery widget when the query is running
and the widget that the pointer is over has no tooltip.
Signals
The "start-query" signal
Emitted when the query is started.
The "stop-query" signal
Emitted when the query is stopped.
The "widget-entered" signal
Emitted when a widget is entered by the pointer while the query is in effect.
The "widget-selected" signal
Emitted when a widget is selected during a query.