Gtk.Tooltip

Gtk.Tooltip — Add tips to your widgets

Object Hierarchy:

    GObject
    ╰── Gtk.Tooltip

Functions:

Description:

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:

Use Gtk.Widget::set_tooltip_window() to set a Gtk.Window created by you as tooltip window.

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.

Function Details:

set_markup()

set_markup (self, markup:str=None)

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

  • Since: 2.12

set_text()

set_text (self, text:str=None)

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

  • Since: 2.12

set_icon()

set_icon (self, pixbuf:GdkPixbuf.Pixbuf=None)

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

  • Since: 2.12

set_icon_from_stock()

set_icon_from_stock (self, stock_id:str=None, size:int)

Gtk.Tooltip:set_icon_from_stock has been deprecated since version 3.10 and should not be used in newly-written code. Use Gtk.Tooltip:set_icon_from_icon_name() instead. Sets the icon of the tooltip (which is in front of the text) to bethe stock item indicated by stock_id with the size indicatedby size. If stock_id is None, the image will be hidden.

  • Since: 2.12

set_icon_from_icon_name()

set_icon_from_icon_name (self, icon_name:str=None, size:int)

Sets the icon of the tooltip (which is in front of the text) to bethe icon indicated by icon_name with the size indicatedby size. If icon_name is None, the image will be hidden.

  • Since: 2.14

set_icon_from_gicon()

set_icon_from_gicon (self, gicon:Gio.Icon=None, size:int)

Sets the icon of the tooltip (which is in front of the text)to be the icon indicated by gicon with the size indicatedby size. If gicon is None, the image will be hidden.

  • Since: 2.20

set_custom()

set_custom (self, custom_widget:Gtk.Widget=None)

Replaces the widget packed into the tooltip withcustom_widget. custom_widget does not get destroyed when the tooltip goesaway.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().

  • Since: 2.12

trigger_tooltip_query()

trigger_tooltip_query (display:Gdk.Display)

Triggers a new tooltip query on display, in order to update the currentvisible tooltip, or to show/hide the current tooltip. This function isuseful to call when, for example, the state of the widget changed by akey press.

  • Since: 2.12

set_tip_area()

set_tip_area (self, rect: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 forproperly setting tooltips on Gtk.TreeView rows and cells, Gtk.IconViews,etc. For setting tooltips on Gtk.TreeView, please refer to the conveniencefunctions for this: Gtk.TreeView:set_tooltip_row`()` andGtk.TreeView:set_tooltip_cell().

  • Since: 2.12

results matching ""

    No results matching ""