Gtk.Tooltip¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`trigger_tooltip_query` (display)
	`set_custom` (custom_widget)
	`set_icon` (pixbuf)
	`set_icon_from_gicon` (gicon, size)
	`set_icon_from_icon_name` (icon_name, size)
	`set_icon_from_stock` (stock_id, size)
	`set_markup` (markup)
	`set_text` (text)
	`set_tip_area` (rect)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Gtk.Tooltip(**kwargs)¶

Bases:: GObject.Object
Abstract:: No

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 Gtk.TreeView row or cell, you will have to do a little more work:

Set the Gtk.Widget :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 Gtk.Widget ::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 Gtk.Tooltip 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 Gtk.Window which will be used as tooltip window. This works as follows:

Set Gtk.Widget :has-tooltip and connect to Gtk.Widget ::query-tooltip as before. Use Gtk.Widget.set_tooltip_window() to set a Gtk.Window created by you as tooltip window.
In the Gtk.Widget ::query-tooltip callback you can access your window using Gtk.Widget.get_tooltip_window() and manipulate as you wish. The semantics of the return value are exactly as before, return True to show the window, False to not show it.

classmethod trigger_tooltip_query(display)[source]¶

Parameters:: display (Gdk.Display) – a Gdk.Display

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.

New in version 2.12.

set_custom(custom_widget)[source]¶

Parameters:: custom_widget (Gtk.Widget or None) – a Gtk.Widget, or None to unset the old custom widget.

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 Gtk.Image and Gtk.Label is embedded in the tooltip, which can be configured using Gtk.Tooltip.set_markup() and Gtk.Tooltip.set_icon().

New in version 2.12.

set_icon(pixbuf)[source]¶

Parameters:: pixbuf (GdkPixbuf.Pixbuf or None) – a GdkPixbuf.Pixbuf, or None

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

New in version 2.12.

set_icon_from_gicon(gicon, size)[source]¶

Parameters:

gicon (Gio.Icon or None) – a Gio.Icon representing the icon, or None
size (int) – a stock icon size (Gtk.IconSize)

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.

New in version 2.20.

set_icon_from_icon_name(icon_name, size)[source]¶

Parameters:

icon_name (str or None) – an icon name, or None
size (int) – a stock icon size (Gtk.IconSize)

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.

New in version 2.14.

set_icon_from_stock(stock_id, size)[source]¶

Parameters:

stock_id (str or None) – a stock id, or None
size (int) – a stock icon size (Gtk.IconSize)

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

New in version 2.12.

Deprecated since version 3.10: Use Gtk.Tooltip.set_icon_from_icon_name() instead.

set_markup(markup)[source]¶

Parameters:: markup (str or None) – a markup string (see Pango markup format) or None

Sets the text of the tooltip to be markup, which is marked up with the Pango text markup language. If markup is None, the label will be hidden.

New in version 2.12.

set_text(text)[source]¶

Parameters:: text (str or None) – a text string or None

Sets the text of the tooltip to be text. If text is None, the label will be hidden. See also Gtk.Tooltip.set_markup().

New in version 2.12.

set_tip_area(rect)[source]¶

Parameters:: rect (Gdk.Rectangle) – a Gdk.Rectangle

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 Gtk.TreeView rows and cells, Gtk.IconViews, etc.

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

New in version 2.12.