gtk4/org.gtkkn.bindings.gtk/Tooltip

Tooltip

open class Tooltip(pointer: <Error class: unknown class><<Error class: unknown class>>)

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::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 ::query-tooltip handler. This causes the tooltip to be show. If you return false, it will not be shown.

Constructors

Tooltip

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gtkTooltipPointer

val gtkTooltipPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

setCustom

open fun setCustom(customWidget: Widget? = null)

Replaces the widget packed into the tooltip with

setIcon

open fun setIcon(paintable: <Error class: unknown class>? = null)

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

setIconFromGicon

open fun setIconFromGicon(gicon: <Error class: unknown class>? = null)

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.

setIconFromIconName

open fun setIconFromIconName(iconName: String? = null)

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.

setMarkup

open fun setMarkup(markup: String? = null)

Sets the text of the tooltip to be @markup.

setText

open fun setText(text: String? = null)

Sets the text of the tooltip to be @text.

setTipArea

open fun setTipArea(rect: <Error class: unknown class>)

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 GtkTreeView rows and cells, GtkIconViews, etc.