Gtk.Tooltip – gtk+-3.0 – Vala Binding Reference

Description:

[ CCode ( type_id = "gtk_tooltip_get_type ()" ) ]
public class Tooltip : Object

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

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

Set has_tooltip and connect to query_tooltip as before. Use set_tooltip_window to set a Window created by you as tooltip window.
In the query_tooltip callback you can access your window using 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.

Namespace: Gtk

Package: gtk+-3.0

Content:

Static methods:

public static void trigger_tooltip_query (Display display)

Triggers a new tooltip query on display, in order to update the current visible tooltip, or to show/hide the current tooltip.

Creation methods:

protected Tooltip ()

Methods:

public void set_custom (Widget? custom_widget)

Replaces the widget packed into the tooltip with

custom_widget

public void set_icon (Pixbuf? pixbuf)

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

public void set_icon_from_gicon (Icon? gicon, int 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.

public void set_icon_from_icon_name (string? icon_name, int 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.

public void set_icon_from_stock (string? stock_id, int size)

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.

public void set_markup (string? markup)

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

public void set_text (string? text)

Sets the text of the tooltip to be text.

public void set_tip_area (Rectangle rect)

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

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref