Add tips to your widgets

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

• Set the has-tooltip property to 1, 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 Gnome::Gtk3::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 1 from your query-tooltip handler. This causes the tooltip to be show. If you return 0, 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 Gnome::Gtk3::Window which will be used as tooltip window. This works as follows:

• Set has-tooltip and connect to query-tooltip as before. Use gtk_widget_set_tooltip_window() to set a Gnome::Gtk3::Window created by you as tooltip window.

• In the 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 1 to show the window, 0 to not show it.

Synopsis

Declaration

unit class Gnome::Gtk3::Tooltip;
also is Gnome::GObject::Object;

Uml Diagram

Inheriting this class

Inheriting is done in a special way in that it needs a call from new() to get the native object created by the class you are inheriting from.

use Gnome::Gtk3::Tooltip:api<1>;

unit class MyGuiClass;
also is Gnome::Gtk3::Tooltip;

submethod new ( |c ) {
  # let the Gnome::Gtk3::Tooltip class process the options
  self.bless( :GtkTooltip, |c);
}

submethod BUILD ( ... ) {
  ...
}

Methods

[[gtk_] tooltip_] get_type

method gtk_tooltip_get_type ( --> UInt )

[[gtk_] tooltip_] set_markup

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

method gtk_tooltip_set_markup ( Str $markup )

• Str $markup; (allow-none): a markup string (see [Pango markup format][PangoMarkupFormat]) or Any

[[gtk_] tooltip_] set_text

Sets the text of the tooltip to be $text. If $text is undefined, the label will be hidden. See also gtk_tooltip_set_markup().

method gtk_tooltip_set_text ( Str $text )

• Str $text; a text string or Any

[[gtk_] tooltip_] set_icon

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

method gtk_tooltip_set_icon ( N-GObject $pixbuf )

• N-GObject $pixbuf; (allow-none): a Gnome::Gdk3::Pixbuf, or Any

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

method gtk_tooltip_set_icon_from_icon_name ( Str $icon_name, GtkIconSize $size )

• Str $icon_name; (allow-none): an icon name, or Any

• GtkIconSize $size; (type int): a stock icon size (Gnome::Gtk3::IconSize)

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

method gtk_tooltip_set_icon_from_gicon ( GIcon $gicon, GtkIconSize $size )

• GIcon $gicon; (allow-none): a GIcon representing the icon, or Any

• GtkIconSize $size; (type int): a stock icon size (Gnome::Gtk3::IconSize)

[[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 Gnome::Gtk3::Image and Gnome::Gtk3::Label is embedded in the tooltip, which can be configured using gtk_tooltip_set_markup() and gtk_tooltip_set_icon().

method gtk_tooltip_set_custom ( N-GObject $custom_widget )

• N-GObject $custom_widget; (allow-none): a Gnome::Gtk3::Widget, or Any to unset the old custom widget.

[[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 Gnome::Gtk3::TreeView rows and cells, Gnome::Gtk3::IconViews, etc. For setting tooltips on Gnome::Gtk3::TreeView, please refer to the convenience functions for this: gtk_tree_view_set_tooltip_row() and gtk_tree_view_set_tooltip_cell().

method gtk_tooltip_set_tip_area ( N-GObject $rect )

• N-GObject $rect; a Gnome::Gdk3::Rectangle

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

method gtk_tooltip_trigger_tooltip_query ( N-GObject $display )

• N-GObject $display; a Gnome::Gdk3::Display