Tooltip

class Tooltip(**properties: Any)

Superclasses: Object

GtkTooltip is an object representing a widget tooltip.

Basic tooltips can be realized simply by using set_tooltip_text or 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 has_tooltip property to True. 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 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 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.

Methods

class Tooltip

set_custom(custom_widget: Widget | None = None) → None

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 set_markup() and set_icon().

Parameters:

custom_widget – a GtkWidget, or None to unset the old custom widget.

set_icon(paintable: Paintable | None = None) → None

Sets the icon of the tooltip (which is in front of the text) to be paintable. If paintable is None, the image will be hidden.

Parameters:

paintable – a GdkPaintable

set_icon_from_gicon(gicon: Icon | None = None) → None

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 None, the image will be hidden.

Parameters:

gicon – a GIcon representing the icon

set_icon_from_icon_name(icon_name: str | None = None) → None

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 None, the image will be hidden.

Parameters:

icon_name – an icon name

set_markup(markup: str | None = None) → None

Sets the text of the tooltip to be markup.

The string must be marked up with Pango markup. If markup is None, the label will be hidden.

Parameters:

markup – a string with Pango markup or %NLL

set_text(text: str | None = None) → None

Sets the text of the tooltip to be text.

If text is None, the label will be hidden. See also set_markup.

Parameters:

text – a text string

set_tip_area(rect: Rectangle) → None

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.

For setting tooltips on GtkTreeView, please refer to the convenience functions for this: set_tooltip_row() and set_tooltip_cell().

Parameters:

rect – a GdkRectangle