Class
GtkTooltip
Description [src]
final class Gtk.Tooltip : GObject.Object
{
/* No available fields */
}
Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text()
or gtk_widget_set_tooltip_markup()
without any explicit tooltip object.
When you need a tooltip with a little more fancy contents, like adding an
image, or you want the tooltip to have different contents per GtkTreeView
row or cell, you will have to do a little more work:
-
Set the
GtkWidget:has-tooltip
property toTRUE
, this will make GTK+ monitor the widget for motion and related events which are needed to determine when and where to show a tooltip. -
Connect to the
GtkWidget::query-tooltip
signal. This signal will be emitted when a tooltip is supposed to be shown. One of the arguments passed to the signal handler is a GtkTooltip object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functions like gtk_tooltip_set_icon(). There are functions for setting the tooltip’s markup, setting an image from a named icon, or even putting in a custom widget.
Return TRUE
from your query-tooltip handler. This causes the tooltip to be
show. If you return FALSE
, it will not be shown.
In the probably rare case where you want to have even more control over the
tooltip that is about to be shown, you can set your own GtkWindow
which
will be used as tooltip window. This works as follows:
-
Set
GtkWidget:has-tooltip
and connect toGtkWidget::query-tooltip
as before. Usegtk_widget_set_tooltip_window()
to set aGtkWindow
created by you as tooltip window. -
In the
GtkWidget::query-tooltip
callback you can access your window usinggtk_widget_get_tooltip_window()
and manipulate as you wish. The semantics of the return value are exactly as before, returnTRUE
to show the window,FALSE
to not show it.
Functions
gtk_tooltip_trigger_tooltip_query
Triggers a new tooltip query on display
, in order to update the current
visible tooltip, or to show/hide the current tooltip. This function is
useful to call when, for example, the state of the widget changed by a
key press.
since: 2.12
Instance methods
gtk_tooltip_set_custom
Replaces the widget packed into the tooltip with
custom_widget
. custom_widget
does not get destroyed when the tooltip goes
away.
By default a box with a GtkImage
and GtkLabel
is embedded in
the tooltip, which can be configured using gtk_tooltip_set_markup()
and gtk_tooltip_set_icon().
since: 2.12
gtk_tooltip_set_icon
Sets the icon of the tooltip (which is in front of the text) to be
pixbuf
. If pixbuf
is NULL
, the image will be hidden.
since: 2.12
gtk_tooltip_set_icon_from_gicon
Sets the icon of the tooltip (which is in front of the text)
to be the icon indicated by gicon
with the size indicated
by size
. If gicon
is NULL
, the image will be hidden.
since: 2.20
gtk_tooltip_set_icon_from_icon_name
Sets the icon of the tooltip (which is in front of the text) to be
the icon indicated by icon_name
with the size indicated
by size
. If icon_name
is NULL
, the image will be hidden.
since: 2.14
gtk_tooltip_set_icon_from_stock
Sets the icon of the tooltip (which is in front of the text) to be
the stock item indicated by stock_id
with the size indicated
by size
. If stock_id
is NULL
, the image will be hidden.
deprecated: 3.10 since: 2.12
gtk_tooltip_set_markup
Sets the text of the tooltip to be markup
, which is marked up
with the [Pango text markup language][PangoMarkupFormat].
If markup
is NULL
, the label will be hidden.
since: 2.12
gtk_tooltip_set_text
Sets the text of the tooltip to be text
. If text
is NULL
, the label
will be hidden. See also gtk_tooltip_set_markup().
since: 2.12
gtk_tooltip_set_tip_area
Sets the area of the widget, where the contents of this tooltip apply,
to be rect
(in widget coordinates). This is especially useful for
properly setting tooltips on GtkTreeView
rows and cells, GtkIconViews
, etc.
since: 2.12
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.