3 * Copyright (C) 2006-2007 Imendio AB
4 * Contact: Kristian Rietveld <kris@imendio.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 #include "gtktooltip.h"
25 #include "gtkwindow.h"
30 #include "gtkalignment.h"
39 #define GTK_TOOLTIP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLTIP, GtkTooltipClass))
40 #define GTK_IS_TOOLTIP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLTIP))
41 #define GTK_TOOLTIP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLTIP, GtkTooltipClass))
43 typedef struct _GtkTooltipClass GtkTooltipClass;
47 GObject parent_instance;
54 GtkWidget *custom_widget;
56 GtkWindow *current_window;
57 GtkWidget *keyboard_widget;
59 GtkWidget *tooltip_widget;
60 GdkWindow *toplevel_window;
64 GdkWindow *last_window;
67 guint browse_mode_timeout_id;
69 GdkRectangle tip_area;
71 guint browse_mode_enabled : 1;
72 guint keyboard_mode_enabled : 1;
73 guint tip_area_set : 1;
74 guint custom_was_reset : 1;
77 struct _GtkTooltipClass
79 GObjectClass parent_class;
82 #define GTK_TOOLTIP_VISIBLE(tooltip) ((tooltip)->current_window && GTK_WIDGET_VISIBLE ((tooltip)->current_window))
85 static void gtk_tooltip_class_init (GtkTooltipClass *klass);
86 static void gtk_tooltip_init (GtkTooltip *tooltip);
87 static void gtk_tooltip_dispose (GObject *object);
89 static void gtk_tooltip_window_style_set (GtkTooltip *tooltip);
90 static gboolean gtk_tooltip_paint_window (GtkTooltip *tooltip);
91 static void gtk_tooltip_window_hide (GtkWidget *widget,
93 static void gtk_tooltip_display_closed (GdkDisplay *display,
96 static void gtk_tooltip_set_last_window (GtkTooltip *tooltip,
100 G_DEFINE_TYPE (GtkTooltip, gtk_tooltip, G_TYPE_OBJECT);
103 gtk_tooltip_class_init (GtkTooltipClass *klass)
105 GObjectClass *object_class;
107 object_class = G_OBJECT_CLASS (klass);
109 object_class->dispose = gtk_tooltip_dispose;
113 gtk_tooltip_init (GtkTooltip *tooltip)
115 tooltip->timeout_id = 0;
116 tooltip->browse_mode_timeout_id = 0;
118 tooltip->browse_mode_enabled = FALSE;
119 tooltip->keyboard_mode_enabled = FALSE;
121 tooltip->current_window = NULL;
122 tooltip->keyboard_widget = NULL;
124 tooltip->tooltip_widget = NULL;
125 tooltip->toplevel_window = NULL;
127 tooltip->last_window = NULL;
129 tooltip->window = g_object_ref (gtk_window_new (GTK_WINDOW_POPUP));
130 gtk_window_set_type_hint (GTK_WINDOW (tooltip->window),
131 GDK_WINDOW_TYPE_HINT_TOOLTIP);
132 gtk_widget_set_app_paintable (tooltip->window, TRUE);
133 gtk_window_set_resizable (GTK_WINDOW (tooltip->window), FALSE);
134 gtk_widget_set_name (tooltip->window, "gtk-tooltip");
135 g_signal_connect (tooltip->window, "hide",
136 G_CALLBACK (gtk_tooltip_window_hide), tooltip);
138 tooltip->alignment = gtk_alignment_new (0.5, 0.5, 1.0, 1.0);
139 gtk_alignment_set_padding (GTK_ALIGNMENT (tooltip->alignment),
140 tooltip->window->style->ythickness,
141 tooltip->window->style->ythickness,
142 tooltip->window->style->xthickness,
143 tooltip->window->style->xthickness);
144 gtk_container_add (GTK_CONTAINER (tooltip->window), tooltip->alignment);
145 gtk_widget_show (tooltip->alignment);
147 g_signal_connect_swapped (tooltip->window, "style-set",
148 G_CALLBACK (gtk_tooltip_window_style_set), tooltip);
149 g_signal_connect_swapped (tooltip->window, "expose-event",
150 G_CALLBACK (gtk_tooltip_paint_window), tooltip);
152 tooltip->box = gtk_hbox_new (FALSE, tooltip->window->style->xthickness);
153 gtk_container_add (GTK_CONTAINER (tooltip->alignment), tooltip->box);
154 gtk_widget_show (tooltip->box);
156 tooltip->image = gtk_image_new ();
157 gtk_box_pack_start (GTK_BOX (tooltip->box), tooltip->image,
160 tooltip->label = gtk_label_new ("");
161 gtk_label_set_line_wrap (GTK_LABEL (tooltip->label), TRUE);
162 gtk_box_pack_start (GTK_BOX (tooltip->box), tooltip->label,
165 tooltip->custom_widget = NULL;
169 gtk_tooltip_dispose (GObject *object)
171 GtkTooltip *tooltip = GTK_TOOLTIP (object);
173 if (tooltip->timeout_id)
175 g_source_remove (tooltip->timeout_id);
176 tooltip->timeout_id = 0;
179 if (tooltip->browse_mode_timeout_id)
181 g_source_remove (tooltip->browse_mode_timeout_id);
182 tooltip->browse_mode_timeout_id = 0;
185 gtk_tooltip_set_custom (tooltip, NULL);
186 gtk_tooltip_set_last_window (tooltip, NULL);
192 display = gtk_widget_get_display (tooltip->window);
193 g_signal_handlers_disconnect_by_func (display,
194 gtk_tooltip_display_closed,
196 gtk_widget_destroy (tooltip->window);
197 tooltip->window = NULL;
200 G_OBJECT_CLASS (gtk_tooltip_parent_class)->dispose (object);
206 * gtk_tooltip_set_markup:
207 * @tooltip: a #GtkTooltip
208 * @markup: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>) or %NULL
210 * Sets the text of the tooltip to be @markup, which is marked up
212 * linkend="PangoMarkupFormat">Pango text markup language</link>.
213 * If @markup is %NULL, the label will be hidden.
218 gtk_tooltip_set_markup (GtkTooltip *tooltip,
221 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
223 gtk_label_set_markup (GTK_LABEL (tooltip->label), markup);
226 gtk_widget_show (tooltip->label);
228 gtk_widget_hide (tooltip->label);
232 * gtk_tooltip_set_text:
233 * @tooltip: a #GtkTooltip
234 * @text: a text string or %NULL
236 * Sets the text of the tooltip to be @text. If @text is %NULL, the label
237 * will be hidden. See also gtk_tooltip_set_markup().
242 gtk_tooltip_set_text (GtkTooltip *tooltip,
245 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
247 gtk_label_set_text (GTK_LABEL (tooltip->label), text);
250 gtk_widget_show (tooltip->label);
252 gtk_widget_hide (tooltip->label);
256 * gtk_tooltip_set_icon:
257 * @tooltip: a #GtkTooltip
258 * @pixbuf: a #GdkPixbuf, or %NULL
260 * Sets the icon of the tooltip (which is in front of the text) to be
261 * @pixbuf. If @pixbuf is %NULL, the image will be hidden.
266 gtk_tooltip_set_icon (GtkTooltip *tooltip,
269 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
271 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
273 gtk_image_set_from_pixbuf (GTK_IMAGE (tooltip->image), pixbuf);
276 gtk_widget_show (tooltip->image);
278 gtk_widget_hide (tooltip->image);
282 * gtk_tooltip_set_icon_from_stock:
283 * @tooltip: a #GtkTooltip
284 * @stock_id: a stock id, or %NULL
285 * @size: (type int): a stock icon size
287 * Sets the icon of the tooltip (which is in front of the text) to be
288 * the stock item indicated by @stock_id with the size indicated
289 * by @size. If @stock_id is %NULL, the image will be hidden.
294 gtk_tooltip_set_icon_from_stock (GtkTooltip *tooltip,
295 const gchar *stock_id,
298 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
300 gtk_image_set_from_stock (GTK_IMAGE (tooltip->image), stock_id, size);
303 gtk_widget_show (tooltip->image);
305 gtk_widget_hide (tooltip->image);
309 * gtk_tooltip_set_icon_from_icon_name:
310 * @tooltip: a #GtkTooltip
311 * @icon_name: an icon name, or %NULL
312 * @size: (type int): a stock icon size
314 * Sets the icon of the tooltip (which is in front of the text) to be
315 * the icon indicated by @icon_name with the size indicated
316 * by @size. If @icon_name is %NULL, the image will be hidden.
321 gtk_tooltip_set_icon_from_icon_name (GtkTooltip *tooltip,
322 const gchar *icon_name,
325 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
327 gtk_image_set_from_icon_name (GTK_IMAGE (tooltip->image), icon_name, size);
330 gtk_widget_show (tooltip->image);
332 gtk_widget_hide (tooltip->image);
336 * gtk_tooltip_set_icon_from_gicon:
337 * @tooltip: a #GtkTooltip
338 * @gicon: a #GIcon representing the icon, or %NULL
339 * @size: (type int): a stock icon size
341 * Sets the icon of the tooltip (which is in front of the text)
342 * to be the icon indicated by @gicon with the size indicated
343 * by @size. If @gicon is %NULL, the image will be hidden.
348 gtk_tooltip_set_icon_from_gicon (GtkTooltip *tooltip,
352 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
354 gtk_image_set_from_gicon (GTK_IMAGE (tooltip->image), gicon, size);
357 gtk_widget_show (tooltip->image);
359 gtk_widget_hide (tooltip->image);
363 * gtk_tooltip_set_custom:
364 * @tooltip: a #GtkTooltip
365 * @custom_widget: a #GtkWidget, or %NULL to unset the old custom widget.
367 * Replaces the widget packed into the tooltip with
368 * @custom_widget. @custom_widget does not get destroyed when the tooltip goes
370 * By default a box with a #GtkImage and #GtkLabel is embedded in
371 * the tooltip, which can be configured using gtk_tooltip_set_markup()
372 * and gtk_tooltip_set_icon().
378 gtk_tooltip_set_custom (GtkTooltip *tooltip,
379 GtkWidget *custom_widget)
381 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
383 g_return_if_fail (GTK_IS_WIDGET (custom_widget));
385 /* The custom widget has been updated from the query-tooltip
386 * callback, so we do not want to reset the custom widget later on.
388 tooltip->custom_was_reset = TRUE;
390 /* No need to do anything if the custom widget stays the same */
391 if (tooltip->custom_widget == custom_widget)
394 if (tooltip->custom_widget)
396 GtkWidget *custom = tooltip->custom_widget;
397 /* Note: We must reset tooltip->custom_widget first,
398 * since gtk_container_remove() will recurse into
399 * gtk_tooltip_set_custom()
401 tooltip->custom_widget = NULL;
402 gtk_container_remove (GTK_CONTAINER (tooltip->box), custom);
403 g_object_unref (custom);
408 tooltip->custom_widget = g_object_ref (custom_widget);
410 gtk_container_add (GTK_CONTAINER (tooltip->box), custom_widget);
411 gtk_widget_show (custom_widget);
416 * gtk_tooltip_set_tip_area:
417 * @tooltip: a #GtkTooltip
418 * @rect: a #GdkRectangle
420 * Sets the area of the widget, where the contents of this tooltip apply,
421 * to be @rect (in widget coordinates). This is especially useful for
422 * properly setting tooltips on #GtkTreeView rows and cells, #GtkIconViews,
425 * For setting tooltips on #GtkTreeView, please refer to the convenience
426 * functions for this: gtk_tree_view_set_tooltip_row() and
427 * gtk_tree_view_set_tooltip_cell().
432 gtk_tooltip_set_tip_area (GtkTooltip *tooltip,
433 const GdkRectangle *rect)
435 g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
438 tooltip->tip_area_set = FALSE;
441 tooltip->tip_area_set = TRUE;
442 tooltip->tip_area = *rect;
447 * gtk_tooltip_trigger_tooltip_query:
448 * @display: a #GdkDisplay
450 * Triggers a new tooltip query on @display, in order to update the current
451 * visible tooltip, or to show/hide the current tooltip. This function is
452 * useful to call when, for example, the state of the widget changed by a
458 gtk_tooltip_trigger_tooltip_query (GdkDisplay *display)
464 /* Trigger logic as if the mouse moved */
465 window = gdk_display_get_window_at_pointer (display, &x, &y);
469 event.type = GDK_MOTION_NOTIFY;
470 event.motion.window = window;
473 event.motion.is_hint = FALSE;
475 gdk_window_get_origin (window, &x, &y);
476 event.motion.x_root = event.motion.x + x;
477 event.motion.y_root = event.motion.y + y;
479 _gtk_tooltip_handle_event (&event);
482 /* private functions */
485 gtk_tooltip_reset (GtkTooltip *tooltip)
487 gtk_tooltip_set_markup (tooltip, NULL);
488 gtk_tooltip_set_icon (tooltip, NULL);
489 gtk_tooltip_set_tip_area (tooltip, NULL);
491 /* See if the custom widget is again set from the query-tooltip
494 tooltip->custom_was_reset = FALSE;
498 gtk_tooltip_window_style_set (GtkTooltip *tooltip)
500 gtk_alignment_set_padding (GTK_ALIGNMENT (tooltip->alignment),
501 tooltip->window->style->ythickness,
502 tooltip->window->style->ythickness,
503 tooltip->window->style->xthickness,
504 tooltip->window->style->xthickness);
505 gtk_box_set_spacing (GTK_BOX (tooltip->box),
506 tooltip->window->style->xthickness);
508 gtk_widget_queue_draw (tooltip->window);
512 gtk_tooltip_paint_window (GtkTooltip *tooltip)
514 gtk_paint_flat_box (tooltip->window->style,
515 tooltip->window->window,
522 tooltip->window->allocation.width,
523 tooltip->window->allocation.height);
529 gtk_tooltip_window_hide (GtkWidget *widget,
532 GtkTooltip *tooltip = GTK_TOOLTIP (user_data);
534 gtk_tooltip_set_custom (tooltip, NULL);
537 /* event handling, etc */
542 GtkWidget *container;
549 child_location_foreach (GtkWidget *child,
553 struct ChildLocation *child_loc = data;
555 /* Ignore invisible widgets */
556 if (!GTK_WIDGET_DRAWABLE (child))
562 /* (child_loc->x, child_loc->y) are relative to
563 * child_loc->container's allocation.
566 if (!child_loc->child &&
567 gtk_widget_translate_coordinates (child_loc->container, child,
568 child_loc->x, child_loc->y,
572 g_print ("candidate: %s alloc=[(%d,%d) %dx%d] (%d, %d)->(%d, %d)\n",
573 gtk_widget_get_name (child),
576 child->allocation.width,
577 child->allocation.height,
578 child_loc->x, child_loc->y,
580 #endif /* DEBUG_TOOLTIP */
582 /* (x, y) relative to child's allocation. */
583 if (x >= 0 && x < child->allocation.width
584 && y >= 0 && y < child->allocation.height)
586 if (GTK_IS_CONTAINER (child))
588 struct ChildLocation tmp = { NULL, NULL, 0, 0 };
590 /* Take (x, y) relative the child's allocation and
595 tmp.container = child;
597 gtk_container_forall (GTK_CONTAINER (child),
598 child_location_foreach, &tmp);
601 child_loc->child = tmp.child;
603 child_loc->child = child;
606 child_loc->child = child;
611 /* Translates coordinates from dest_widget->window relative (src_x, src_y),
612 * to allocation relative (dest_x, dest_y) of dest_widget.
615 window_to_alloc (GtkWidget *dest_widget,
621 /* Translate from window relative to allocation relative */
622 if (gtk_widget_get_has_window (dest_widget) && dest_widget->parent)
625 gdk_window_get_position (dest_widget->window, &wx, &wy);
627 /* Offset coordinates if widget->window is smaller than
628 * widget->allocation.
630 src_x += wx - dest_widget->allocation.x;
631 src_y += wy - dest_widget->allocation.y;
635 src_x -= dest_widget->allocation.x;
636 src_y -= dest_widget->allocation.y;
645 /* Translates coordinates from window relative (x, y) to
646 * allocation relative (x, y) of the returned widget.
649 find_widget_under_pointer (GdkWindow *window,
653 GtkWidget *event_widget;
654 struct ChildLocation child_loc = { NULL, NULL, 0, 0 };
656 gdk_window_get_user_data (window, (void **)&event_widget);
662 g_print ("event window %p (belonging to %p (%s)) (%d, %d)\n",
663 window, event_widget, gtk_widget_get_name (event_widget),
667 /* Coordinates are relative to event window */
671 /* We go down the window hierarchy to the widget->window,
672 * coordinates stay relative to the current window.
673 * We end up with window == widget->window, coordinates relative to that.
675 while (window && window != event_widget->window)
679 gdk_window_get_position (window, &px, &py);
683 window = gdk_window_get_parent (window);
686 /* Failing to find widget->window can happen for e.g. a detached handle box;
687 * chaining ::query-tooltip up to its parent probably makes little sense,
688 * and users better implement tooltips on handle_box->child.
689 * so we simply ignore the event for tooltips here.
694 /* Convert the window relative coordinates to allocation
695 * relative coordinates.
697 window_to_alloc (event_widget,
698 child_loc.x, child_loc.y,
699 &child_loc.x, &child_loc.y);
701 if (GTK_IS_CONTAINER (event_widget))
703 GtkWidget *container = event_widget;
705 child_loc.container = event_widget;
706 child_loc.child = NULL;
708 gtk_container_forall (GTK_CONTAINER (event_widget),
709 child_location_foreach, &child_loc);
711 /* Here we have a widget, with coordinates relative to
712 * child_loc.container's allocation.
716 event_widget = child_loc.child;
717 else if (child_loc.container)
718 event_widget = child_loc.container;
720 /* Translate to event_widget's allocation */
721 gtk_widget_translate_coordinates (container, event_widget,
722 child_loc.x, child_loc.y,
723 &child_loc.x, &child_loc.y);
727 /* We return (x, y) relative to the allocation of event_widget. */
736 /* Ignores (x, y) on input, translates event coordinates to
737 * allocation relative (x, y) of the returned widget.
740 find_topmost_widget_coords_from_event (GdkEvent *event,
748 gdk_event_get_coords (event, &dx, &dy);
752 /* Returns coordinates relative to tmp's allocation. */
753 tmp = find_widget_under_pointer (event->any.window, &tx, &ty);
758 /* Make sure the pointer can actually be on the widget returned. */
759 if (tx < 0 || tx >= tmp->allocation.width ||
760 ty < 0 || ty >= tmp->allocation.height)
772 tooltip_browse_mode_expired (gpointer data)
776 tooltip = GTK_TOOLTIP (data);
778 tooltip->browse_mode_enabled = FALSE;
779 tooltip->browse_mode_timeout_id = 0;
781 /* destroy tooltip */
782 g_object_set_data (G_OBJECT (gtk_widget_get_display (tooltip->window)),
783 "gdk-display-current-tooltip", NULL);
789 gtk_tooltip_display_closed (GdkDisplay *display,
793 g_object_set_data (G_OBJECT (display), "gdk-display-current-tooltip", NULL);
797 gtk_tooltip_set_last_window (GtkTooltip *tooltip,
800 if (tooltip->last_window == window)
803 if (tooltip->last_window)
804 g_object_remove_weak_pointer (G_OBJECT (tooltip->last_window),
805 (gpointer *) &tooltip->last_window);
807 tooltip->last_window = window;
810 g_object_add_weak_pointer (G_OBJECT (tooltip->last_window),
811 (gpointer *) &tooltip->last_window);
815 gtk_tooltip_run_requery (GtkWidget **widget,
820 gboolean has_tooltip = FALSE;
821 gboolean return_value = FALSE;
823 gtk_tooltip_reset (tooltip);
827 g_object_get (*widget,
828 "has-tooltip", &has_tooltip,
832 g_signal_emit_by_name (*widget,
835 tooltip->keyboard_mode_enabled,
841 GtkWidget *parent = (*widget)->parent;
844 gtk_widget_translate_coordinates (*widget, parent, *x, *y, x, y);
853 /* If the custom widget was not reset in the query-tooltip
854 * callback, we clear it here.
856 if (!tooltip->custom_was_reset)
857 gtk_tooltip_set_custom (tooltip, NULL);
863 gtk_tooltip_position (GtkTooltip *tooltip,
865 GtkWidget *new_tooltip_widget)
870 tooltip->tooltip_widget = new_tooltip_widget;
872 /* Position the tooltip */
873 /* FIXME: should we swap this when RTL is enabled? */
874 if (tooltip->keyboard_mode_enabled)
876 gdk_window_get_origin (new_tooltip_widget->window, &x, &y);
877 if (!gtk_widget_get_has_window (new_tooltip_widget))
879 x += new_tooltip_widget->allocation.x;
880 y += new_tooltip_widget->allocation.y;
883 /* For keyboard mode we position the tooltip below the widget,
884 * right of the center of the widget.
886 x += new_tooltip_widget->allocation.width / 2;
887 y += new_tooltip_widget->allocation.height + 4;
896 /* For mouse mode, we position the tooltip right of the cursor,
897 * a little below the cursor's center.
899 cursor_size = gdk_display_get_default_cursor_size (display);
900 x += cursor_size / 2;
901 y += cursor_size / 2;
904 screen = gtk_widget_get_screen (new_tooltip_widget);
907 if (tooltip->current_window)
910 GdkRectangle monitor;
911 GtkRequisition requisition;
913 gtk_widget_size_request (GTK_WIDGET (tooltip->current_window),
916 monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
917 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
919 if (x + requisition.width > monitor.x + monitor.width)
920 x -= x - (monitor.x + monitor.width) + requisition.width;
921 else if (x < monitor.x)
924 if (y + requisition.height > monitor.y + monitor.height)
925 y -= y - (monitor.y + monitor.height) + requisition.height;
927 if (!tooltip->keyboard_mode_enabled)
929 /* don't pop up under the pointer */
930 if (x <= tooltip->last_x && tooltip->last_x < x + requisition.width &&
931 y <= tooltip->last_y && tooltip->last_y < y + requisition.height)
932 y = tooltip->last_y - requisition.height - 2;
935 gtk_window_move (GTK_WINDOW (tooltip->current_window), x, y);
936 gtk_widget_show (GTK_WIDGET (tooltip->current_window));
941 gtk_tooltip_show_tooltip (GdkDisplay *display)
947 GtkWidget *tooltip_widget;
948 GtkWidget *pointer_widget;
950 gboolean has_tooltip;
951 gboolean return_value = FALSE;
953 tooltip = g_object_get_data (G_OBJECT (display),
954 "gdk-display-current-tooltip");
956 if (tooltip->keyboard_mode_enabled)
959 pointer_widget = tooltip_widget = tooltip->keyboard_widget;
963 window = tooltip->last_window;
965 if (!GDK_IS_WINDOW (window))
968 gdk_window_get_origin (window, &x, &y);
969 x = tooltip->last_x - x;
970 y = tooltip->last_y - y;
972 pointer_widget = tooltip_widget = find_widget_under_pointer (window,
979 g_object_get (tooltip_widget, "has-tooltip", &has_tooltip, NULL);
981 return_value = gtk_tooltip_run_requery (&tooltip_widget, tooltip, &x, &y);
985 if (!tooltip->current_window)
987 if (gtk_widget_get_tooltip_window (tooltip_widget))
988 tooltip->current_window = gtk_widget_get_tooltip_window (tooltip_widget);
990 tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
993 screen = gtk_widget_get_screen (tooltip_widget);
995 /* FIXME: should use tooltip->current_window iso tooltip->window */
996 if (screen != gtk_widget_get_screen (tooltip->window))
998 g_signal_handlers_disconnect_by_func (display,
999 gtk_tooltip_display_closed,
1002 gtk_window_set_screen (GTK_WINDOW (tooltip->window), screen);
1004 g_signal_connect (display, "closed",
1005 G_CALLBACK (gtk_tooltip_display_closed), tooltip);
1008 gtk_tooltip_position (tooltip, display, tooltip_widget);
1010 /* Now a tooltip is visible again on the display, make sure browse
1013 tooltip->browse_mode_enabled = TRUE;
1014 if (tooltip->browse_mode_timeout_id)
1016 g_source_remove (tooltip->browse_mode_timeout_id);
1017 tooltip->browse_mode_timeout_id = 0;
1022 gtk_tooltip_hide_tooltip (GtkTooltip *tooltip)
1027 if (tooltip->timeout_id)
1029 g_source_remove (tooltip->timeout_id);
1030 tooltip->timeout_id = 0;
1033 if (!GTK_TOOLTIP_VISIBLE (tooltip))
1036 tooltip->tooltip_widget = NULL;
1038 if (!tooltip->keyboard_mode_enabled)
1041 GtkSettings *settings;
1043 settings = gtk_widget_get_settings (GTK_WIDGET (tooltip->window));
1045 g_object_get (settings,
1046 "gtk-tooltip-browse-mode-timeout", &timeout,
1049 /* The tooltip is gone, after (by default, should be configurable) 500ms
1050 * we want to turn off browse mode
1052 if (!tooltip->browse_mode_timeout_id)
1053 tooltip->browse_mode_timeout_id =
1054 gdk_threads_add_timeout_full (0, timeout,
1055 tooltip_browse_mode_expired,
1056 g_object_ref (tooltip),
1061 if (tooltip->browse_mode_timeout_id)
1063 g_source_remove (tooltip->browse_mode_timeout_id);
1064 tooltip->browse_mode_timeout_id = 0;
1068 if (tooltip->current_window)
1070 gtk_widget_hide (GTK_WIDGET (tooltip->current_window));
1071 tooltip->current_window = NULL;
1076 tooltip_popup_timeout (gpointer data)
1078 GdkDisplay *display;
1079 GtkTooltip *tooltip;
1081 display = GDK_DISPLAY_OBJECT (data);
1082 tooltip = g_object_get_data (G_OBJECT (display),
1083 "gdk-display-current-tooltip");
1085 /* This usually does not happen. However, it does occur in language
1086 * bindings were reference counting of objects behaves differently.
1091 gtk_tooltip_show_tooltip (display);
1093 tooltip->timeout_id = 0;
1099 gtk_tooltip_start_delay (GdkDisplay *display)
1102 GtkTooltip *tooltip;
1103 GtkSettings *settings;
1105 tooltip = g_object_get_data (G_OBJECT (display),
1106 "gdk-display-current-tooltip");
1108 if (!tooltip || GTK_TOOLTIP_VISIBLE (tooltip))
1111 if (tooltip->timeout_id)
1112 g_source_remove (tooltip->timeout_id);
1114 settings = gtk_widget_get_settings (GTK_WIDGET (tooltip->window));
1116 if (tooltip->browse_mode_enabled)
1117 g_object_get (settings, "gtk-tooltip-browse-timeout", &timeout, NULL);
1119 g_object_get (settings, "gtk-tooltip-timeout", &timeout, NULL);
1121 tooltip->timeout_id = gdk_threads_add_timeout_full (0, timeout,
1122 tooltip_popup_timeout,
1123 g_object_ref (display),
1128 _gtk_tooltip_focus_in (GtkWidget *widget)
1131 gboolean return_value = FALSE;
1132 GdkDisplay *display;
1133 GtkTooltip *tooltip;
1135 /* Get current tooltip for this display */
1136 display = gtk_widget_get_display (widget);
1137 tooltip = g_object_get_data (G_OBJECT (display),
1138 "gdk-display-current-tooltip");
1140 /* Check if keyboard mode is enabled at this moment */
1141 if (!tooltip || !tooltip->keyboard_mode_enabled)
1144 if (tooltip->keyboard_widget)
1145 g_object_unref (tooltip->keyboard_widget);
1147 tooltip->keyboard_widget = g_object_ref (widget);
1149 gdk_window_get_pointer (widget->window, &x, &y, NULL);
1151 return_value = gtk_tooltip_run_requery (&widget, tooltip, &x, &y);
1154 gtk_tooltip_hide_tooltip (tooltip);
1158 if (!tooltip->current_window)
1160 if (gtk_widget_get_tooltip_window (widget))
1161 tooltip->current_window = gtk_widget_get_tooltip_window (widget);
1163 tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
1166 gtk_tooltip_show_tooltip (display);
1170 _gtk_tooltip_focus_out (GtkWidget *widget)
1172 GdkDisplay *display;
1173 GtkTooltip *tooltip;
1175 /* Get current tooltip for this display */
1176 display = gtk_widget_get_display (widget);
1177 tooltip = g_object_get_data (G_OBJECT (display),
1178 "gdk-display-current-tooltip");
1180 if (!tooltip || !tooltip->keyboard_mode_enabled)
1183 if (tooltip->keyboard_widget)
1185 g_object_unref (tooltip->keyboard_widget);
1186 tooltip->keyboard_widget = NULL;
1189 gtk_tooltip_hide_tooltip (tooltip);
1193 _gtk_tooltip_toggle_keyboard_mode (GtkWidget *widget)
1195 GdkDisplay *display;
1196 GtkTooltip *tooltip;
1198 display = gtk_widget_get_display (widget);
1199 tooltip = g_object_get_data (G_OBJECT (display),
1200 "gdk-display-current-tooltip");
1204 tooltip = g_object_new (GTK_TYPE_TOOLTIP, NULL);
1205 g_object_set_data_full (G_OBJECT (display),
1206 "gdk-display-current-tooltip",
1207 tooltip, g_object_unref);
1208 g_signal_connect (display, "closed",
1209 G_CALLBACK (gtk_tooltip_display_closed),
1213 tooltip->keyboard_mode_enabled ^= 1;
1215 if (tooltip->keyboard_mode_enabled)
1217 tooltip->keyboard_widget = g_object_ref (widget);
1218 _gtk_tooltip_focus_in (widget);
1222 if (tooltip->keyboard_widget)
1224 g_object_unref (tooltip->keyboard_widget);
1225 tooltip->keyboard_widget = NULL;
1228 gtk_tooltip_hide_tooltip (tooltip);
1233 _gtk_tooltip_hide (GtkWidget *widget)
1235 GtkWidget *toplevel;
1236 GdkDisplay *display;
1237 GtkTooltip *tooltip;
1239 display = gtk_widget_get_display (widget);
1240 tooltip = g_object_get_data (G_OBJECT (display),
1241 "gdk-display-current-tooltip");
1243 if (!tooltip || !GTK_TOOLTIP_VISIBLE (tooltip) || !tooltip->tooltip_widget)
1246 toplevel = gtk_widget_get_toplevel (widget);
1248 if (widget == tooltip->tooltip_widget
1249 || toplevel->window == tooltip->toplevel_window)
1250 gtk_tooltip_hide_tooltip (tooltip);
1254 tooltips_enabled (GdkWindow *window)
1257 gboolean touchscreen;
1259 GtkSettings *settings;
1261 screen = gdk_drawable_get_screen (window);
1262 settings = gtk_settings_get_for_screen (screen);
1264 g_object_get (settings,
1265 "gtk-touchscreen-mode", &touchscreen,
1266 "gtk-enable-tooltips", &enabled,
1269 return (!touchscreen && enabled);
1273 _gtk_tooltip_handle_event (GdkEvent *event)
1276 gboolean return_value = FALSE;
1277 GtkWidget *has_tooltip_widget = NULL;
1278 GdkDisplay *display;
1279 GtkTooltip *current_tooltip;
1281 if (!tooltips_enabled (event->any.window))
1284 /* Returns coordinates relative to has_tooltip_widget's allocation. */
1285 has_tooltip_widget = find_topmost_widget_coords_from_event (event, &x, &y);
1286 display = gdk_drawable_get_display (event->any.window);
1287 current_tooltip = g_object_get_data (G_OBJECT (display),
1288 "gdk-display-current-tooltip");
1290 if (current_tooltip)
1292 gtk_tooltip_set_last_window (current_tooltip, event->any.window);
1293 gdk_event_get_root_coords (event,
1294 ¤t_tooltip->last_x,
1295 ¤t_tooltip->last_y);
1298 if (current_tooltip && current_tooltip->keyboard_mode_enabled)
1300 has_tooltip_widget = current_tooltip->keyboard_widget;
1301 if (!has_tooltip_widget)
1304 return_value = gtk_tooltip_run_requery (&has_tooltip_widget,
1309 gtk_tooltip_hide_tooltip (current_tooltip);
1311 gtk_tooltip_start_delay (display);
1316 #ifdef DEBUG_TOOLTIP
1317 if (has_tooltip_widget)
1318 g_print ("%p (%s) at (%d, %d) %dx%d pointer: (%d, %d)\n",
1319 has_tooltip_widget, gtk_widget_get_name (has_tooltip_widget),
1320 has_tooltip_widget->allocation.x,
1321 has_tooltip_widget->allocation.y,
1322 has_tooltip_widget->allocation.width,
1323 has_tooltip_widget->allocation.height,
1325 #endif /* DEBUG_TOOLTIP */
1327 /* Always poll for a next motion event */
1328 gdk_event_request_motions (&event->motion);
1330 /* Hide the tooltip when there's no new tooltip widget */
1331 if (!has_tooltip_widget)
1333 if (current_tooltip)
1334 gtk_tooltip_hide_tooltip (current_tooltip);
1339 switch (event->type)
1341 case GDK_BUTTON_PRESS:
1342 case GDK_2BUTTON_PRESS:
1343 case GDK_3BUTTON_PRESS:
1345 case GDK_DRAG_ENTER:
1346 case GDK_GRAB_BROKEN:
1347 gtk_tooltip_hide_tooltip (current_tooltip);
1350 case GDK_MOTION_NOTIFY:
1351 case GDK_ENTER_NOTIFY:
1352 case GDK_LEAVE_NOTIFY:
1354 if (current_tooltip)
1356 gboolean tip_area_set;
1357 GdkRectangle tip_area;
1358 gboolean hide_tooltip;
1360 tip_area_set = current_tooltip->tip_area_set;
1361 tip_area = current_tooltip->tip_area;
1363 return_value = gtk_tooltip_run_requery (&has_tooltip_widget,
1367 /* Requested to be hidden? */
1368 hide_tooltip = !return_value;
1370 /* Leave notify should override the query function */
1371 hide_tooltip = (event->type == GDK_LEAVE_NOTIFY);
1373 /* Is the pointer above another widget now? */
1374 if (GTK_TOOLTIP_VISIBLE (current_tooltip))
1375 hide_tooltip |= has_tooltip_widget != current_tooltip->tooltip_widget;
1377 /* Did the pointer move out of the previous "context area"? */
1379 hide_tooltip |= (x <= tip_area.x
1380 || x >= tip_area.x + tip_area.width
1382 || y >= tip_area.y + tip_area.height);
1385 gtk_tooltip_hide_tooltip (current_tooltip);
1387 gtk_tooltip_start_delay (display);
1391 /* Need a new tooltip for this display */
1392 current_tooltip = g_object_new (GTK_TYPE_TOOLTIP, NULL);
1393 g_object_set_data_full (G_OBJECT (display),
1394 "gdk-display-current-tooltip",
1395 current_tooltip, g_object_unref);
1396 g_signal_connect (display, "closed",
1397 G_CALLBACK (gtk_tooltip_display_closed),
1400 gtk_tooltip_set_last_window (current_tooltip, event->any.window);
1401 gdk_event_get_root_coords (event,
1402 ¤t_tooltip->last_x,
1403 ¤t_tooltip->last_y);
1405 gtk_tooltip_start_delay (display);
1415 #define __GTK_TOOLTIP_C__
1416 #include "gtkaliasdef.c"