Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.Tooltip

Contents

Exported types
Methods

Description

Basic tooltips can be realized simply by using widgetSetTooltipText or widgetSetTooltipMarkup 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 TreeView row or cell, you will have to do a little more work:

Set the 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 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 tooltipSetIcon. 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.

In the probably rare case where you want to have even more control over the tooltip that is about to be shown, you can set your own Window which will be used as tooltip window. This works as follows:

Set Widget:has-tooltip and connect to Widget::query-tooltip as before. Use widgetSetTooltipWindow to set a Window created by you as tooltip window.
In the Widget::query-tooltip callback you can access your window using widgetGetTooltipWindow and manipulate as you wish. The semantics of the return value are exactly as before, return True to show the window, False to not show it.

Synopsis

newtype Tooltip = Tooltip (ManagedPtr Tooltip)
class (GObject o, IsDescendantOf Tooltip o) => IsTooltip o
toTooltip :: (MonadIO m, IsTooltip o) => o -> m Tooltip
noTooltip :: Maybe Tooltip
tooltipSetCustom :: (HasCallStack, MonadIO m, IsTooltip a, IsWidget b) => a -> Maybe b -> m ()
tooltipSetIcon :: (HasCallStack, MonadIO m, IsTooltip a, IsPixbuf b) => a -> Maybe b -> m ()
tooltipSetIconFromGicon :: (HasCallStack, MonadIO m, IsTooltip a, IsIcon b) => a -> Maybe b -> Int32 -> m ()
tooltipSetIconFromIconName :: (HasCallStack, MonadIO m, IsTooltip a) => a -> Maybe Text -> Int32 -> m ()
tooltipSetIconFromStock :: (HasCallStack, MonadIO m, IsTooltip a) => a -> Maybe Text -> Int32 -> m ()
tooltipSetMarkup :: (HasCallStack, MonadIO m, IsTooltip a) => a -> Maybe Text -> m ()
tooltipSetText :: (HasCallStack, MonadIO m, IsTooltip a) => a -> Maybe Text -> m ()
tooltipSetTipArea :: (HasCallStack, MonadIO m, IsTooltip a) => a -> Rectangle -> m ()
tooltipTriggerTooltipQuery :: (HasCallStack, MonadIO m, IsDisplay a) => a -> m ()

Exported types

newtype Tooltip Source #

Memory-managed wrapper type.

Constructors

Tooltip (ManagedPtr Tooltip)

Instances

GObject Tooltip Source #
Instance details Defined in GI.Gtk.Objects.Tooltip Methods gobjectType :: IO GType #
HasParentTypes Tooltip Source #
Instance details Defined in GI.Gtk.Objects.Tooltip
type ParentTypes Tooltip Source #
Instance details Defined in GI.Gtk.Objects.Tooltip type ParentTypes Tooltip = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf Tooltip o) => IsTooltip o Source #

Type class for types which can be safely cast to Tooltip, for instance with toTooltip.

Instances

(GObject o, IsDescendantOf Tooltip o) => IsTooltip o Source #
Instance details Defined in GI.Gtk.Objects.Tooltip

toTooltip :: (MonadIO m, IsTooltip o) => o -> m Tooltip Source #

Cast to Tooltip, for types for which this is known to be safe. For general casts, use castTo.

noTooltip :: Maybe Tooltip Source #

A convenience alias for Nothing :: Maybe Tooltip.

Methods

setCustom

tooltipSetCustom Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a, IsWidget b)
=> a	`tooltip`: a `Tooltip`
-> Maybe b	`customWidget`: a `Widget`, or `Nothing` to unset the old custom widget.
-> m ()

Replaces the widget packed into the tooltip with customWidget. customWidget does not get destroyed when the tooltip goes away. By default a box with a Image and Label is embedded in the tooltip, which can be configured using tooltipSetMarkup and tooltipSetIcon.

Since: 2.12

setIcon

tooltipSetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a, IsPixbuf b)
=> a	`tooltip`: a `Tooltip`
-> Maybe b	`pixbuf`: a `Pixbuf`, or `Nothing`
-> m ()

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

Since: 2.12

setIconFromGicon

tooltipSetIconFromGicon Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a, IsIcon b)
=> a	`tooltip`: a `Tooltip`
-> Maybe b	`gicon`: a `Icon` representing the icon, or `Nothing`
-> Int32	`size`: a stock icon size (`IconSize`)
-> m ()

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

Since: 2.20

setIconFromIconName

tooltipSetIconFromIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a)
=> a	`tooltip`: a `Tooltip`
-> Maybe Text	`iconName`: an icon name, or `Nothing`
-> Int32	`size`: a stock icon size (`IconSize`)
-> m ()

Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by iconName with the size indicated by size. If iconName is Nothing, the image will be hidden.

Since: 2.14

setIconFromStock

tooltipSetIconFromStock Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a)
=> a	`tooltip`: a `Tooltip`
-> Maybe Text	`stockId`: a stock id, or `Nothing`
-> Int32	`size`: a stock icon size (`IconSize`)
-> m ()

Deprecated: (Since version 3.10)Use tooltipSetIconFromIconName instead.

Sets the icon of the tooltip (which is in front of the text) to be the stock item indicated by stockId with the size indicated by size. If stockId is Nothing, the image will be hidden.

Since: 2.12

setMarkup

tooltipSetMarkup Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a)
=> a	`tooltip`: a `Tooltip`
-> Maybe Text	`markup`: a markup string (see [Pango markup format][PangoMarkupFormat]) or `Nothing`
-> m ()

Sets the text of the tooltip to be markup, which is marked up with the [Pango text markup language][PangoMarkupFormat]. If markup is Nothing, the label will be hidden.

Since: 2.12

setText

tooltipSetText Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a)
=> a	`tooltip`: a `Tooltip`
-> Maybe Text	`text`: a text string or `Nothing`
-> m ()

Sets the text of the tooltip to be text. If text is Nothing, the label will be hidden. See also tooltipSetMarkup.

Since: 2.12

setTipArea

tooltipSetTipArea Source #

Arguments

:: (HasCallStack, MonadIO m, IsTooltip a)
=> a	`tooltip`: a `Tooltip`
-> Rectangle	`rect`: a `Rectangle`
-> m ()

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

For setting tooltips on TreeView, please refer to the convenience functions for this: treeViewSetTooltipRow and treeViewSetTooltipCell.

Since: 2.12

triggerTooltipQuery

tooltipTriggerTooltipQuery Source #

Arguments

:: (HasCallStack, MonadIO m, IsDisplay a)
=> a	`display`: a `Display`
-> m ()

Triggers a new tooltip query on display, in order to update the current visible tooltip, or to show/hide the current tooltip. This function is useful to call when, for example, the state of the widget changed by a key press.

Since: 2.12