GtkTipsQuery: GTK+ 2 Reference Manual

## GtkTipsQuery GtkTipsQuery — Displays help about widgets in the user interface |

## Functions

GtkWidget * | gtk_tips_query_new ()
void | gtk_tips_query_start_query ()
void | gtk_tips_query_stop_query ()
void | gtk_tips_query_set_caller ()
void | gtk_tips_query_set_labels ()

## Properties

GtkWidget * | caller | Read / Write
gboolean | emit-always | Read / Write
gchar * | label-inactive | Read / Write
gchar * | label-no-tip | Read / Write

## Signals

void | start-query | Run First
void | stop-query | Run First
void | widget-entered | Run Last
gboolean | widget-selected | Run Last

## Types and Values

struct | GtkTipsQuery

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkObject
                ╰── GtkWidget
                    ╰── GtkMisc
                        ╰── GtkLabel
                            ╰── GtkTipsQuery

## Implemented Interfaces

GtkTipsQuery implements AtkImplementorIface and GtkBuildable.

## Includes

    #include <gtk/gtk.h>

## 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).

## Functions

### gtk_tips_query_new ()

    GtkWidget *
    gtk_tips_query_new (void);

`gtk_tips_query_new` is deprecated and should not be used in newly-written code.

Creates a new GtkTipsQuery.

#### Returns

a new GtkTipsQuery.

### gtk_tips_query_start_query ()

    void
    gtk_tips_query_start_query (GtkTipsQuery *tips_query);

`gtk_tips_query_start_query` is deprecated and should not be used in newly-written code.

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.

#### Parameters

tips_query | a GtkTipsQuery. |

### gtk_tips_query_stop_query ()

    void
    gtk_tips_query_stop_query (GtkTipsQuery *tips_query);

`gtk_tips_query_stop_query` is deprecated and should not be used in newly-written code.

Stops a query.

#### Parameters

tips_query | a GtkTipsQuery. |

### gtk_tips_query_set_caller ()

    void
    gtk_tips_query_set_caller (GtkTipsQuery *tips_query,
                               GtkWidget *caller);

`gtk_tips_query_set_caller` is deprecated and should not be used in newly-written code.

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.

#### Parameters

tips_query | a GtkTipsQuery. |
caller | the widget which initiates the query. |

### gtk_tips_query_set_labels ()

    void
    gtk_tips_query_set_labels (GtkTipsQuery *tips_query,
                               const gchar *label_inactive,
                               const gchar *label_no_tip);

`gtk_tips_query_set_labels` is deprecated and should not be used in newly-written code.

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.

#### Parameters

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. |

## Types and Values

### struct GtkTipsQuery

    struct GtkTipsQuery;

`GtkTipsQuery` is deprecated and should not be used in newly-written code.

The GtkTipsQuery struct contains private data only, and should be accessed using the functions below.

## Property Details

### The `“caller”` property

      “caller”                   GtkWidget *

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.

Flags: Read / Write

### The `“emit-always”` property

      “emit-always”              gboolean

`TRUE` if the widget-entered and widget-selected signals are emitted even when the widget has no tooltip set.

Flags: Read / Write

Default value: FALSE

### The `“label-inactive”` property

      “label-inactive”           gchar *

The text to display in the GtkTipsQuery widget when the query is not in effect.

Flags: Read / Write

Default value: NULL

### The `“label-no-tip”` property

      “label-no-tip”             gchar *

The text to display in the GtkTipsQuery widget when the query is running and the widget that the pointer is over has no tooltip.

Flags: Read / Write

Default value: NULL

## Signal Details

### The `“start-query”` signal

    void
    user_function (GtkTipsQuery *tipsquery,
                   gpointer      user_data)

Emitted when the query is started.

#### Parameters

tipsquery | the object which received the signal. |
user_data | user data set when the signal handler was connected. |

Flags: Run First

### The `“stop-query”` signal

    void
    user_function (GtkTipsQuery *tipsquery,
                   gpointer      user_data)

Emitted when the query is stopped.

#### Parameters

tipsquery | the object which received the signal. |
user_data | user data set when the signal handler was connected. |

Flags: Run First

### The `“widget-entered”` signal

    void
    user_function (GtkTipsQuery *tipsquery,
                   GtkWidget    *widget,
                   gchar        *arg1,
                   gchar        *arg2,
                   gpointer      user_data)

Emitted when a widget is entered by the pointer while the query is in effect.

#### Parameters

tipsquery | the object which received the signal. |
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()`). |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

### The `“widget-selected”` signal

    gboolean
    user_function (GtkTipsQuery *tipsquery,
                   GtkWidget    *widget,
                   gchar        *arg1,
                   gchar        *arg2,
                   GdkEvent     *arg3,
                   gpointer      user_data)

Emitted when a widget is selected during a query.

#### Parameters

tipsquery | the object which received the signal. |
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. |
user_data | user data set when the signal handler was connected. |

#### Returns

`TRUE` if the query should be stopped.

Flags: Run Last

## See Also

GtkTooltips | the object which handles tooltips.