From 372c4d2627e4cb15a3bec51d051f4cc30afc5138 Mon Sep 17 00:00:00 2001 From: Damon Chaplin Date: Wed, 22 Sep 1999 21:30:57 +0000 Subject: ran make templates, to fix problems with structs. 1999-09-22 Damon Chaplin * gtk/tmpl/*.sgml: ran make templates, to fix problems with structs. * gtk/gtk-sections.txt: rearranged GtkCombo section. * gtk/tmpl/gtkvseparator.sgml: * gtk/tmpl/gtkhseparator.sgml: * gtk/tmpl/gtkgc.sgml: * gtk/tmpl/gtkfeatures.sgml: * gtk/tmpl/gtktipsquery.sgml: * gtk/tmpl/gtkitem.sgml: * gtk/tmpl/gtkinvisible.sgml: * gtk/tmpl/gtkgamma.sgml: * gtk/tmpl/gtkdata.sgml: * gtk/tmpl/gtkcurve.sgml: * gtk/tmpl/gtkcombo.sgml: * gtk/tmpl/gtkaccellabel.sgml: documented. --- docs/reference/gtk/tmpl/gtktipsquery.sgml | 113 +++++++++++++++++++----------- 1 file changed, 72 insertions(+), 41 deletions(-) (limited to 'docs/reference/gtk/tmpl/gtktipsquery.sgml') diff --git a/docs/reference/gtk/tmpl/gtktipsquery.sgml b/docs/reference/gtk/tmpl/gtktipsquery.sgml index 0bc6abfaac..7f7949a1db 100644 --- a/docs/reference/gtk/tmpl/gtktipsquery.sgml +++ b/docs/reference/gtk/tmpl/gtktipsquery.sgml @@ -2,128 +2,159 @@ GtkTipsQuery - +displays help about widgets in the user interface. - +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). - + + +#GtkTooltips +the object which handles tooltips. + + - +The #GtkTipsQuery-struct struct contains private data only, and +should be accessed using the functions below. -@label: -@emit_always: -@in_query: -@label_inactive: -@label_no_tip: -@caller: -@last_crossed: -@query_cursor: - +Creates a new #GtkTipsQuery. -@Returns: +@Returns: a new #GtkTipsQuery. - +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. -@tips_query: +@tips_query: a #GtkTipsQuery. - +Stops a query. -@tips_query: +@tips_query: a #GtkTipsQuery. - +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. -@tips_query: -@caller: +@tips_query: a #GtkTipsQuery. +@caller: the widget which initiates the query. - +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. -@tips_query: -@label_inactive: -@label_no_tip: +@tips_query: a #GtkTipsQuery. +@label_inactive: the text to display when the query is not running. +@label_no_tip: the text to display when the query is running but the widget +beneath the pointer has no tooltip. - +Emitted when the query is started. @tipsquery: the object which received the signal. - +Emitted when the query is stopped. @tipsquery: the object which received the signal. - +Emitted when a widget is entered by the pointer while the query is in effect. @tipsquery: the object which received the signal. -@widget: -@tip_text: -@tip_private: +@widget: the widget that was entered by the pointer. +@tip_text: the widget's tooltip. +@tip_private: the widget's private tooltip (see gtk_tooltips_set_tip()). - +Emitted when a widget is selected during a query. @tipsquery: the object which received the signal. -@widget: -@tip_text: -@tip_private: -@event: -@Returns: +@widget: the widget that was selected. +@tip_text: the widget's tooltip. +@tip_private: the widget's private tooltip (see gtk_tooltips_set_tip()). +@event: the button press or button release event. +@Returns: TRUE if the query should be stopped. - +TRUE if the widget-entered and widget-selected signals are emitted even when +the widget has no tooltip set. - +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. - +The text to display in the #GtkTipsQuery widget when the query is not in +effect. - +The text to display in the #GtkTipsQuery widget when the query is running +and the widget that the pointer is over has no tooltip. -- cgit v1.2.1