Tooltip

Object Hierarchy:

Gtk.Tooltip Gtk.Tooltip Gtk.Tooltip GLib.Object GLib.Object GLib.Object->Gtk.Tooltip

Description:

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

`GtkTooltip` is an object representing a widget tooltip.

Basic tooltips can be realized simply by using [method@Gtk.Widget.set_tooltip_text] or [method@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 `GtkTreeView` row or cell, you will have to do a little more work:

  • Set the [property@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 [signal@Gtk.Widget:GtkTooltip: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 [method@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 GtkTooltip::query-tooltip handler. This causes the tooltip to be show. If you return false, it will not be shown.

Namespace: Gtk
Package: gtk4

Content:

Creation methods:

Methods:

  • public void set_custom (Widget? custom_widget)
    Replaces the widget packed into the tooltip with custom_widget.
  • public void set_icon (Paintable? paintable)
    Sets the icon of the tooltip (which is in front of the text) to be paintable.
  • public void set_icon_from_gicon (Icon? 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.
  • public void set_icon_from_icon_name (string? 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.
  • public void set_markup (string? markup)
    Sets the text of the tooltip to be markup.
  • 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