type Gtk_Tooltip_Record is new Glib.Object.GObject_Record with private;
type Gtk_Tooltip is access all Gtk_Tooltip_Record'Class;
function Get_Type return GType;
procedure Set_Custom
( | Tooltip | : access Gtk_Tooltip_Record; |
Custom_Widget | : access Gtk_Widget_Record'Class); |
procedure Set_Icon
( | Tooltip | : access Gtk_Tooltip_Record; |
Pixbuf | : Gdk.Pixbuf.Gdk_Pixbuf); |
procedure Set_Icon_From_Icon_Name
( | Tooltip | : access Gtk_Tooltip_Record; |
Icon_Name | : String; | |
Size | : Gtk.Enums.Gtk_Icon_Size); |
procedure Set_Icon_From_Stock
( | Tooltip | : access Gtk_Tooltip_Record; |
Stock_Id | : String; | |
Size | : Gtk.Enums.Gtk_Icon_Size); |
procedure Set_Markup
( | Tooltip | : access Gtk_Tooltip_Record; |
Markup | : UTF8_String); |
procedure Set_Text
( | Tooltip | : access Gtk_Tooltip_Record; |
Text | : UTF8_String); |
procedure Set_Tip_Area
( | Tooltip | : access Gtk_Tooltip_Record; |
Rect | : Gdk.Rectangle.Gdk_Rectangle); |
procedure Trigger_Tooltip_Query
( | Display | : access Gdk.Display.Gdk_Display_Record); |
Gtk.Tooltip belongs to the new tooltips API that was introduced in GTK+ 2.12 and which deprecates the old Gtk.Tooltips API.
Basic tooltips can be realized simply by using Set_Tooltip_Text or 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 Gtk_Tree_View row or cell, you will have to do a little more work: Set the "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 "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 Gtk_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 Set_Icon. There are functions for setting the tooltip's markup, setting an image from a stock icon, or even putting in a custom widget.
Return True from your query-tooltip handler. This causes the tooltip to be shown. 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 Gtk_Window which will be used as tooltip window. This works as follows: Set "has-tooltip" and connect to "query-tooltip" as before.
Use Gtk.Widget.Set_Tooltip_Window to set a Gtk_Window created by you as tooltip window.
In the ::query-tooltip callback you can access your window using Gtk.Widget.Get_Tooltip_Window 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.
Binding from C File version 2.16.6