CtkTooltip: CTK+ 3 Reference Manual

CtkTooltip

CtkTooltip — Add tips to your widgets

Functions

void	ctk_tooltip_set_markup ()
void	ctk_tooltip_set_text ()
void	ctk_tooltip_set_icon ()
void	ctk_tooltip_set_icon_from_stock ()
void	ctk_tooltip_set_icon_from_icon_name ()
void	ctk_tooltip_set_icon_from_gicon ()
void	ctk_tooltip_set_custom ()
void	ctk_tooltip_trigger_tooltip_query ()
void	ctk_tooltip_set_tip_area ()

Types and Values

CtkTooltip

Object Hierarchy

    GObject
    ╰── CtkTooltip

Includes

#include <ctk/ctk.h>

Description

Basic tooltips can be realized simply by using ctk_widget_set_tooltip_text() or ctk_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 CtkTreeView row or cell, you will have to do a little more work:

Set the “has-tooltip” property to TRUE, this will make CTK+ 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 CtkTooltip object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functions like ctk_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 CtkWindow which will be used as tooltip window. This works as follows:

Set “has-tooltip” and connect to “query-tooltip” as before. Use ctk_widget_set_tooltip_window() to set a CtkWindow created by you as tooltip window.
In the “query-tooltip” callback you can access your window using ctk_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.

Functions

ctk_tooltip_set_markup ()

void
ctk_tooltip_set_markup (CtkTooltip *tooltip,
                        const gchar *markup);

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

Parameters

tooltip	a CtkTooltip
markup	a markup string (see Pango markup format) or `NULL`.	[allow-none]

Since: 2.12

ctk_tooltip_set_text ()

void
ctk_tooltip_set_text (CtkTooltip *tooltip,
                      const gchar *text);

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

Parameters

tooltip	a CtkTooltip
text	a text string or `NULL`.	[allow-none]

Since: 2.12

ctk_tooltip_set_icon ()

void
ctk_tooltip_set_icon (CtkTooltip *tooltip,
                      GdkPixbuf *pixbuf);

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

Parameters

tooltip	a CtkTooltip
pixbuf	a GdkPixbuf, or `NULL`.	[allow-none]

Since: 2.12

ctk_tooltip_set_icon_from_stock ()

void
ctk_tooltip_set_icon_from_stock (CtkTooltip *tooltip,
                                 const gchar *stock_id,
                                 CtkIconSize size);

ctk_tooltip_set_icon_from_stock has been deprecated since version 3.10 and should not be used in newly-written code.

Use ctk_tooltip_set_icon_from_icon_name() instead.

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

Parameters

tooltip	a CtkTooltip
stock_id	a stock id, or `NULL`.	[allow-none]
size	a stock icon size (CtkIconSize).	[type int]

Since: 2.12

ctk_tooltip_set_icon_from_icon_name ()

void
ctk_tooltip_set_icon_from_icon_name (CtkTooltip *tooltip,
                                     const gchar *icon_name,
                                     CtkIconSize size);

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

Parameters

tooltip	a CtkTooltip
icon_name	an icon name, or `NULL`.	[allow-none]
size	a stock icon size (CtkIconSize).	[type int]

Since: 2.14

ctk_tooltip_set_icon_from_gicon ()

void
ctk_tooltip_set_icon_from_gicon (CtkTooltip *tooltip,
                                 GIcon *gicon,
                                 CtkIconSize size);

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

Parameters

tooltip	a CtkTooltip
gicon	a GIcon representing the icon, or `NULL`.	[allow-none]
size	a stock icon size (CtkIconSize).	[type int]

Since: 2.20

ctk_tooltip_set_custom ()

void
ctk_tooltip_set_custom (CtkTooltip *tooltip,
                        CtkWidget *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 CtkImage and CtkLabel is embedded in the tooltip, which can be configured using ctk_tooltip_set_markup() and ctk_tooltip_set_icon().

Parameters

tooltip	a CtkTooltip
custom_widget	a CtkWidget, or `NULL` to unset the old custom widget.	[allow-none]

Since: 2.12

ctk_tooltip_trigger_tooltip_query ()

void
ctk_tooltip_trigger_tooltip_query (CdkDisplay *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.

Parameters

display

a CdkDisplay

Since: 2.12

ctk_tooltip_set_tip_area ()

void
ctk_tooltip_set_tip_area (CtkTooltip *tooltip,
                          const CdkRectangle *rect);

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 CtkTreeView rows and cells, CtkIconViews, etc.

For setting tooltips on CtkTreeView, please refer to the convenience functions for this: ctk_tree_view_set_tooltip_row() and ctk_tree_view_set_tooltip_cell().

Parameters

tooltip	a CtkTooltip
rect	a CdkRectangle

Since: 2.12

Types and Values

CtkTooltip

typedef struct _CtkTooltip CtkTooltip;