gtk.tooltip

Module for [Tooltip] class

class Tooltip TooltipGidBuilder TooltipGidBuilderImpl

Types 3

classTooltip : gobject.object.ObjectWrap

gtk.tooltip.Tooltip is an object representing a widget tooltip.

Basic tooltips can be realized simply by using gtk.widget.Widget.setTooltipText or gtk.widget.Widget.setTooltipMarkup 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.tree_view.TreeView row or cell, you will have to do a little more work:

  • Set the gtk.widget.Widget.hasTooltip 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.Widget.queryTooltip 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 gtk.tooltip.Tooltip 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.Tooltip.setIcon. 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.
Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
Tooltip self() nothrowReturns `this`, for use in `with` statements.
TooltipGidBuilder builder() static nothrowGet builder for [gtk.tooltip.Tooltip] Returns: New builder object
void setCustom(gtk.widget.Widget customWidget = null) nothrowReplaces 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.Image] and [gtk.label.Label] is e...
void setIcon(gdk.paintable.Paintable paintable = null) nothrowSets the icon of the tooltip (which is in front of the text) to be paintable. If paintable is null, the image will be hidden.
void setIconFromGicon(gio.icon.Icon gicon = null) nothrowSets 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.
void setIconFromIconName(string iconName = null) nothrowSets 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.
void setMarkup(string markup = null) nothrowSets the text of the tooltip to be markup.
void setText(string text = null) nothrowSets the text of the tooltip to be text.
void setTipArea(gdk.rectangle.Rectangle rect) nothrowSets 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.tree_view.TreeView] rows ...
Constructors
this(void * ptr, Flag!"Take" take)
classTooltipGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for gtk.tooltip.Tooltip

classTooltipGidBuilder : TooltipGidBuilderImpl!TooltipGidBuilder

Fluent builder for gtk.tooltip.Tooltip

Methods
Tooltip build() nothrowCreate object from builder. Returns: New object