class: Tooltip

[28:7] extends: object

Represents 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.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Tooltip (Handle = null)

  Creates a new Tooltip by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• set_custom (object 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 GtkImage and GtkLabel is embedded in the tooltip, which can be configured using gtk_tooltip_set_markup() and gtk_tooltip_set_icon().
  • @p custom_widget is a GtkWidget, or %NULL to unset the old custom widget..
  • @r None.

• set_icon (object paintable)

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

  • @paintable. If @paintable is %NULL, the image will be hidden.
  • @p paintable is a GdkPaintable.
  • @r None.

• set_icon_from_gicon (object 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. If @gicon is %NULL, the image will be hidden.

  • @p gicon is a GIcon representing the icon.
  • @r None.

• 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. If

  • @icon_name is %NULL, the image will be hidden.
  • @p icon_name is an icon name.
  • @r None.

• set_markup (string markup)

  Sets the text of the tooltip to be @markup. The string must be marked up with Pango markup. If @markup is %NULL, the label will be hidden.

  • @p markup is a string with Pango markup or %NLL.
  • @r None.

• set_text (string text)

  Sets the text of the tooltip to be @text. If @text is %NULL, the label will be hidden. See also [method@Gtk.Tooltip.set_markup].

  • @p text is a text string.
  • @r None.

• set_tip_area (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 GtkTreeView rows and cells, GtkIconViews, etc. For setting tooltips on GtkTreeView, please refer to the convenience functions for this: gtk_tree_view_set_tooltip_row() and gtk_tree_view_set_tooltip_cell().

  • @p rect is a GdkRectangle.
  • @r None.