Class: Gtk::Tooltip

Inherits:

Object

• Object
• Gtk::Tooltip

Defined in:

(unknown)

Overview

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

• Set Gtk::Widget:has-tooltip and connect to #GtkWidget::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.

Instance Method Summary

• #custom=(custom_widget) ⇒ nil

  Replaces the widget packed into the tooltip with custom_widget.

• #icon=(pixbuf) ⇒ nil

  Sets the icon of the tooltip (which is in front of the text) to be pixbuf.

• #markup=(markup) ⇒ nil

  Sets the text of the tooltip to be markup, which is marked up with the [Pango text markup language].

• #set_icon_from_gicon(gicon, size) ⇒ nil

  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.

• #set_icon_from_icon_name(icon_name, size) ⇒ nil

  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.

• #set_icon_from_stock(stock_id, size) ⇒ nil

  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.

• #text=(text) ⇒ nil

  Sets the text of the tooltip to be text.

• #tip_area=(rect) ⇒ nil

  Sets the area of the widget, where the contents of this tooltip apply, to be rect (in widget coordinates).

Instance Method Details

#custom=(custom_widget) ⇒ nil

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 #GtkLabel is embedded in the tooltip, which can be configured using gtk_tooltip_set_markup() and gtk_tooltip_set_icon().

Parameters:

• custom_widget (Gtk::Widget) —

  a Gtk::Widget, or nil to unset the old custom widget.

Returns:

• (nil)

#icon=(pixbuf) ⇒ nil

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

Parameters:

• pixbuf (GdkPixbuf::Pixbuf) —

  a Gdk::Pixbuf, or nil

Returns:

• (nil)

#markup=(markup) ⇒ nil

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

Parameters:

• markup (String) —

  a markup string (see [Pango markup format]) or nil

Returns:

• (nil)

#set_icon_from_gicon(gicon, size) ⇒ nil

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

Parameters:

• gicon (Gio::Icon) —

  a #GIcon representing the icon, or nil

• size (Integer) —

  a stock icon size (Gtk::IconSize)

Returns:

• (nil)

#set_icon_from_icon_name(icon_name, size) ⇒ nil

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

Parameters:

• icon_name (String) —

  an icon name, or nil

• size (Integer) —

  a stock icon size (Gtk::IconSize)

Returns:

• (nil)

#set_icon_from_stock(stock_id, size) ⇒ nil

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

Parameters:

• stock_id (String) —

  a stock id, or nil

• size (Integer) —

  a stock icon size (Gtk::IconSize)

Returns:

• (nil)

#text=(text) ⇒ nil

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

Parameters:

• text (String) —

  a text string or nil

Returns:

• (nil)

#tip_area=(rect) ⇒ nil

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, #GtkIconViews, etc.

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

Parameters:

• rect (Gdk::Rectangle) —

  a Gdk::Rectangle

Returns:

• (nil)