TooltipProtocol

public protocol TooltipProtocol : ObjectProtocol

GtkTooltip is an object representing a widget tooltip.

Basic tooltips can be realized simply by using [methodGtk.Widget.set_tooltip_text] or [methodGtk.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 [propertyGtk.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 [signalGtk.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 [methodGtk.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.

The TooltipProtocol protocol exposes the methods and properties of an underlying GtkTooltip instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see Tooltip. Alternatively, use TooltipRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkTooltip instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • tooltip_ptr Default implementation

    Typed pointer to the underlying GtkTooltip instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkTooltip instance.

    Declaration

    Swift

    var tooltip_ptr: UnsafeMutablePointer<GtkTooltip>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to TooltipProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Tooltip Class: TooltipProtocol extension (methods and fields)

  • setCustom(customWidget:) Extension method

    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().

    Declaration

    Swift

    @inlinable
func setCustom(customWidget: WidgetRef? = nil)
    Show on GitHub
  • setCustom(customWidget:) Extension method

    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().

    Declaration

    Swift

    @inlinable
func setCustom<WidgetT>(customWidget: WidgetT?) where WidgetT : WidgetProtocol
    Show on GitHub
  • setIcon(paintable:) Extension method

    Sets the icon of the tooltip (which is in front of the text) to be paintable. If paintable is nil, the image will be hidden.

    Declaration

    Swift

    @inlinable
func setIcon(paintable: Gdk.PaintableRef? = nil)
    Show on GitHub
  • setIcon(paintable:) Extension method

    Sets the icon of the tooltip (which is in front of the text) to be paintable. If paintable is nil, the image will be hidden.

    Declaration

    Swift

    @inlinable
func setIcon<PaintableT>(paintable: PaintableT?) where PaintableT : PaintableProtocol
    Show on GitHub
  • setIconFrom(gicon:) Extension method

    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 nil, the image will be hidden.

    Declaration

    Swift

    @inlinable
func setIconFrom(gicon: GIO.IconRef? = nil)
    Show on GitHub
  • setIconFrom(gicon:) Extension method

    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 nil, the image will be hidden.

    Declaration

    Swift

    @inlinable
func setIconFrom<IconT>(gicon: IconT?) where IconT : IconProtocol
    Show on GitHub
  • setIconFrom(iconName:) Extension method

    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 nil, the image will be hidden.

    Declaration

    Swift

    @inlinable
func setIconFrom(iconName: UnsafePointer<CChar>? = nil)
    Show on GitHub
  • set(markup:) Extension method

    Sets the text of the tooltip to be markup.

    The string must be marked up with Pango markup. If markup is nil, the label will be hidden.

    Declaration

    Swift

    @inlinable
func set(markup: UnsafePointer<CChar>? = nil)
    Show on GitHub
  • set(text:) Extension method

    Sets the text of the tooltip to be text.

    If text is nil, the label will be hidden. See also [methodGtk.Tooltip.set_markup].

    Declaration

    Swift

    @inlinable
func set(text: UnsafePointer<CChar>? = nil)
    Show on GitHub
  • setTipArea(rect:) Extension method

    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().

    Declaration

    Swift

    @inlinable
func setTipArea<RectangleT>(rect: RectangleT) where RectangleT : RectangleProtocol
    Show on GitHub