Package ch.bailu.gtk.gtk

Class Tooltip

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gtk.Tooltip
All Implemented Interfaces:
PointerInterface
public class Tooltip extends 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::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.

https://docs.gtk.org/gtk4/class.Tooltip.html

  • Constructor Details

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • setCustom

      public void setCustom(@Nullable Widget 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().
      Parameters:
      custom_widget - a `GtkWidget`, or %NULL to unset the old custom widget.

    • setIcon

      public void setIcon(@Nullable Paintable 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.
      Parameters:
      paintable - a `GdkPaintable`

    • setIconFromGicon

      public void setIconFromGicon(@Nullable 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. If @gicon is %NULL, the image will be hidden.
      Parameters:
      gicon - a `GIcon` representing the icon

    • setIconFromIconName

      public void setIconFromIconName(@Nullable Str 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.
      Parameters:
      icon_name - an icon name

    • setIconFromIconName

      public void setIconFromIconName(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.
      Parameters:
      icon_name - an icon name

    • setMarkup

      public void setMarkup(@Nullable Str 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.
      Parameters:
      markup - a string with Pango markup or %NLL

    • setMarkup

      public void setMarkup(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.
      Parameters:
      markup - a string with Pango markup or %NLL

    • setText

      public void setText(@Nullable Str 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].
      Parameters:
      text - a text string

    • setText

      public void setText(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].
      Parameters:
      text - a text string

    • setTipArea

      public void setTipArea(@Nonnull Rectangle 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().
      Parameters:
      rect - a `GdkRectangle`

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()