1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
34 #include "gtkmenuitem.h"
35 #include "gtkprivate.h"
36 #include "gtkwidget.h"
37 #include "gtkwindow.h"
39 #include "gtktooltips.h"
44 #define DEFAULT_DELAY 500 /* Default delay in ms */
45 #define STICKY_DELAY 0 /* Delay before popping up next tip
48 #define STICKY_REVERT_DELAY 1000 /* Delay before sticky tooltips revert
51 #define GTK_TOOLTIPS_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOOLTIPS, GtkTooltipsPrivate))
53 typedef struct _GtkTooltipsPrivate GtkTooltipsPrivate;
55 struct _GtkTooltipsPrivate
57 GHashTable *tips_data_table;
61 static void gtk_tooltips_finalize (GObject *object);
62 static void gtk_tooltips_destroy (GtkObject *object);
64 static void gtk_tooltips_destroy_data (GtkTooltipsData *tooltipsdata);
66 static void gtk_tooltips_event_handler (GtkWidget *widget,
68 static void gtk_tooltips_widget_unmap (GtkWidget *widget,
70 static void gtk_tooltips_widget_remove (GtkWidget *widget,
72 static void gtk_tooltips_set_active_widget (GtkTooltips *tooltips,
74 static gint gtk_tooltips_timeout (gpointer data);
76 static gint gtk_tooltips_paint_window (GtkTooltips *tooltips);
77 static void gtk_tooltips_draw_tips (GtkTooltips *tooltips);
78 static void gtk_tooltips_unset_tip_window (GtkTooltips *tooltips);
80 static gboolean get_keyboard_mode (GtkWidget *widget);
82 static const gchar tooltips_data_key[] = "_GtkTooltipsData";
83 static const gchar tooltips_info_key[] = "_GtkTooltipsInfo";
85 G_DEFINE_TYPE (GtkTooltips, gtk_tooltips, GTK_TYPE_OBJECT)
88 gtk_tooltips_class_init (GtkTooltipsClass *class)
90 GtkObjectClass *object_class = (GtkObjectClass *) class;
91 GObjectClass *gobject_class = (GObjectClass *) class;
93 gobject_class->finalize = gtk_tooltips_finalize;
95 object_class->destroy = gtk_tooltips_destroy;
97 g_type_class_add_private (gobject_class, sizeof (GtkTooltipsPrivate));
101 gtk_tooltips_init (GtkTooltips *tooltips)
103 GtkTooltipsPrivate *private = GTK_TOOLTIPS_GET_PRIVATE (tooltips);
105 tooltips->tip_window = NULL;
106 tooltips->active_tips_data = NULL;
107 tooltips->_tips_data_list = NULL;
109 tooltips->delay = DEFAULT_DELAY;
110 tooltips->enabled = TRUE;
111 tooltips->timer_tag = 0;
112 tooltips->use_sticky_delay = FALSE;
113 tooltips->last_popdown.tv_sec = -1;
114 tooltips->last_popdown.tv_usec = -1;
116 private->tips_data_table =
117 g_hash_table_new_full (NULL, NULL, NULL,
118 (GDestroyNotify) gtk_tooltips_destroy_data);
122 gtk_tooltips_finalize (GObject *object)
124 GtkTooltipsPrivate *private = GTK_TOOLTIPS_GET_PRIVATE (object);
126 g_hash_table_destroy (private->tips_data_table);
128 G_OBJECT_CLASS (gtk_tooltips_parent_class)->finalize (object);
132 gtk_tooltips_new (void)
134 return g_object_new (GTK_TYPE_TOOLTIPS, NULL);
138 gtk_tooltips_destroy_data (GtkTooltipsData *tooltipsdata)
140 gtk_tooltips_widget_unmap (tooltipsdata->widget, tooltipsdata);
142 g_free (tooltipsdata->tip_text);
143 g_free (tooltipsdata->tip_private);
145 g_signal_handlers_disconnect_by_func (tooltipsdata->widget,
146 gtk_tooltips_event_handler,
148 g_signal_handlers_disconnect_by_func (tooltipsdata->widget,
149 gtk_tooltips_widget_unmap,
151 g_signal_handlers_disconnect_by_func (tooltipsdata->widget,
152 gtk_tooltips_widget_remove,
155 g_object_set_data (G_OBJECT (tooltipsdata->widget), I_(tooltips_data_key), NULL);
156 g_object_unref (tooltipsdata->widget);
157 g_free (tooltipsdata);
161 tip_window_display_closed (GdkDisplay *display,
163 GtkTooltips *tooltips)
165 gtk_tooltips_unset_tip_window (tooltips);
169 disconnect_tip_window_display_closed (GtkTooltips *tooltips)
171 g_signal_handlers_disconnect_by_func (gtk_widget_get_display (tooltips->tip_window),
172 (gpointer) tip_window_display_closed,
177 gtk_tooltips_unset_tip_window (GtkTooltips *tooltips)
179 if (tooltips->tip_window)
181 disconnect_tip_window_display_closed (tooltips);
183 gtk_widget_destroy (tooltips->tip_window);
184 tooltips->tip_window = NULL;
189 gtk_tooltips_destroy (GtkObject *object)
191 GtkTooltips *tooltips = GTK_TOOLTIPS (object);
192 GtkTooltipsPrivate *private = GTK_TOOLTIPS_GET_PRIVATE (tooltips);
194 g_return_if_fail (tooltips != NULL);
196 if (tooltips->timer_tag)
198 g_source_remove (tooltips->timer_tag);
199 tooltips->timer_tag = 0;
202 g_hash_table_remove_all (private->tips_data_table);
204 gtk_tooltips_unset_tip_window (tooltips);
206 GTK_OBJECT_CLASS (gtk_tooltips_parent_class)->destroy (object);
210 gtk_tooltips_update_screen (GtkTooltips *tooltips,
213 gboolean screen_changed = FALSE;
215 if (tooltips->active_tips_data &&
216 tooltips->active_tips_data->widget)
218 GdkScreen *screen = gtk_widget_get_screen (tooltips->active_tips_data->widget);
220 screen_changed = (screen != gtk_widget_get_screen (tooltips->tip_window));
225 disconnect_tip_window_display_closed (tooltips);
227 gtk_window_set_screen (GTK_WINDOW (tooltips->tip_window), screen);
231 if (screen_changed || new_window)
232 g_signal_connect (gtk_widget_get_display (tooltips->tip_window), "closed",
233 G_CALLBACK (tip_window_display_closed), tooltips);
238 gtk_tooltips_force_window (GtkTooltips *tooltips)
240 g_return_if_fail (GTK_IS_TOOLTIPS (tooltips));
242 if (!tooltips->tip_window)
244 tooltips->tip_window = gtk_window_new (GTK_WINDOW_POPUP);
245 gtk_window_set_type_hint (GTK_WINDOW (tooltips->tip_window), GDK_WINDOW_TYPE_HINT_TOOLTIP);
246 gtk_tooltips_update_screen (tooltips, TRUE);
247 gtk_widget_set_app_paintable (tooltips->tip_window, TRUE);
248 gtk_window_set_resizable (GTK_WINDOW (tooltips->tip_window), FALSE);
249 gtk_widget_set_name (tooltips->tip_window, "gtk-tooltips");
250 gtk_container_set_border_width (GTK_CONTAINER (tooltips->tip_window), 4);
252 g_signal_connect_swapped (tooltips->tip_window,
254 G_CALLBACK (gtk_tooltips_paint_window),
257 tooltips->tip_label = gtk_label_new (NULL);
258 gtk_label_set_line_wrap (GTK_LABEL (tooltips->tip_label), TRUE);
259 gtk_misc_set_alignment (GTK_MISC (tooltips->tip_label), 0.5, 0.5);
260 gtk_widget_show (tooltips->tip_label);
262 gtk_container_add (GTK_CONTAINER (tooltips->tip_window), tooltips->tip_label);
264 g_signal_connect (tooltips->tip_window,
266 G_CALLBACK (gtk_widget_destroyed),
267 &tooltips->tip_window);
272 gtk_tooltips_enable (GtkTooltips *tooltips)
274 g_return_if_fail (tooltips != NULL);
276 tooltips->enabled = TRUE;
280 gtk_tooltips_disable (GtkTooltips *tooltips)
282 g_return_if_fail (tooltips != NULL);
284 gtk_tooltips_set_active_widget (tooltips, NULL);
286 tooltips->enabled = FALSE;
290 gtk_tooltips_set_delay (GtkTooltips *tooltips,
293 g_return_if_fail (tooltips != NULL);
295 tooltips->delay = delay;
299 gtk_tooltips_data_get (GtkWidget *widget)
301 g_return_val_if_fail (widget != NULL, NULL);
303 return g_object_get_data (G_OBJECT (widget), tooltips_data_key);
307 gtk_tooltips_set_tip (GtkTooltips *tooltips,
309 const gchar *tip_text,
310 const gchar *tip_private)
312 GtkTooltipsData *tooltipsdata;
314 g_return_if_fail (GTK_IS_TOOLTIPS (tooltips));
315 g_return_if_fail (widget != NULL);
317 tooltipsdata = gtk_tooltips_data_get (widget);
322 gtk_tooltips_widget_remove (tooltipsdata->widget, tooltipsdata);
326 if (tooltips->active_tips_data
327 && tooltips->active_tips_data->widget == widget
328 && GTK_WIDGET_DRAWABLE (tooltips->active_tips_data->widget))
330 g_free (tooltipsdata->tip_text);
331 g_free (tooltipsdata->tip_private);
333 tooltipsdata->tip_text = g_strdup (tip_text);
334 tooltipsdata->tip_private = g_strdup (tip_private);
336 gtk_tooltips_draw_tips (tooltips);
340 g_object_ref (widget);
343 gtk_tooltips_widget_remove (tooltipsdata->widget, tooltipsdata);
345 tooltipsdata = g_new0 (GtkTooltipsData, 1);
347 tooltipsdata->tooltips = tooltips;
348 tooltipsdata->widget = widget;
350 tooltipsdata->tip_text = g_strdup (tip_text);
351 tooltipsdata->tip_private = g_strdup (tip_private);
353 g_hash_table_insert (GTK_TOOLTIPS_GET_PRIVATE (tooltips)->tips_data_table,
354 widget, tooltipsdata);
356 g_signal_connect_after (widget, "event_after",
357 G_CALLBACK (gtk_tooltips_event_handler),
360 g_object_set_data (G_OBJECT (widget), I_(tooltips_data_key),
363 g_signal_connect (widget, "unmap",
364 G_CALLBACK (gtk_tooltips_widget_unmap),
367 g_signal_connect (widget, "unrealize",
368 G_CALLBACK (gtk_tooltips_widget_unmap),
371 g_signal_connect (widget, "destroy",
372 G_CALLBACK (gtk_tooltips_widget_remove),
378 gtk_tooltips_paint_window (GtkTooltips *tooltips)
382 gtk_widget_size_request (tooltips->tip_window, &req);
383 gtk_paint_flat_box (tooltips->tip_window->style, tooltips->tip_window->window,
384 GTK_STATE_NORMAL, GTK_SHADOW_OUT,
385 NULL, GTK_WIDGET(tooltips->tip_window), "tooltip",
386 0, 0, req.width, req.height);
392 gtk_tooltips_draw_tips (GtkTooltips *tooltips)
394 GtkRequisition requisition;
397 GtkTooltipsData *data;
398 gboolean keyboard_mode;
400 GdkScreen *pointer_screen;
401 gint monitor_num, px, py;
402 GdkRectangle monitor;
405 if (!tooltips->tip_window)
406 gtk_tooltips_force_window (tooltips);
407 else if (GTK_WIDGET_VISIBLE (tooltips->tip_window))
408 g_get_current_time (&tooltips->last_popdown);
410 gtk_widget_ensure_style (tooltips->tip_window);
412 widget = tooltips->active_tips_data->widget;
413 g_object_set_data (G_OBJECT (tooltips->tip_window), I_(tooltips_info_key),
416 keyboard_mode = get_keyboard_mode (widget);
418 gtk_tooltips_update_screen (tooltips, FALSE);
420 screen = gtk_widget_get_screen (widget);
422 data = tooltips->active_tips_data;
424 gtk_label_set_text (GTK_LABEL (tooltips->tip_label), data->tip_text);
426 gtk_widget_size_request (tooltips->tip_window, &requisition);
427 w = requisition.width;
428 h = requisition.height;
430 gdk_window_get_origin (widget->window, &x, &y);
431 if (GTK_WIDGET_NO_WINDOW (widget))
433 x += widget->allocation.x;
434 y += widget->allocation.y;
437 x += widget->allocation.width / 2;
440 gdk_window_get_pointer (gdk_screen_get_root_window (screen),
445 gdk_display_get_pointer (gdk_screen_get_display (screen),
446 &pointer_screen, &px, &py, NULL);
447 if (pointer_screen != screen)
452 monitor_num = gdk_screen_get_monitor_at_point (screen, px, py);
453 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
455 if ((x + w) > monitor.x + monitor.width)
456 x -= (x + w) - (monitor.x + monitor.width);
457 else if (x < monitor.x)
460 if ((y + h + widget->allocation.height + 4) > monitor.y + monitor.height)
463 y = y + widget->allocation.height + 4;
465 toplevel = GTK_WINDOW (gtk_widget_get_toplevel (widget));
466 if (toplevel && GTK_IS_WINDOW (toplevel))
467 gtk_window_set_transient_for (GTK_WINDOW (tooltips->tip_window), toplevel);
469 gtk_window_move (GTK_WINDOW (tooltips->tip_window), x, y);
470 gtk_widget_show (tooltips->tip_window);
474 gtk_tooltips_timeout (gpointer data)
476 GtkTooltips *tooltips = (GtkTooltips *) data;
478 if (tooltips->active_tips_data != NULL &&
479 GTK_WIDGET_DRAWABLE (tooltips->active_tips_data->widget))
480 gtk_tooltips_draw_tips (tooltips);
482 tooltips->timer_tag = 0;
488 gtk_tooltips_set_active_widget (GtkTooltips *tooltips,
491 if (tooltips->tip_window)
493 if (GTK_WIDGET_VISIBLE (tooltips->tip_window))
494 g_get_current_time (&tooltips->last_popdown);
495 gtk_widget_hide (tooltips->tip_window);
497 if (tooltips->timer_tag)
499 g_source_remove (tooltips->timer_tag);
500 tooltips->timer_tag = 0;
503 tooltips->active_tips_data = NULL;
505 if (widget && GTK_WIDGET_DRAWABLE (widget))
507 GtkTooltipsPrivate *private = GTK_TOOLTIPS_GET_PRIVATE (tooltips);
508 GtkTooltipsData *tooltipsdata;
510 tooltipsdata = g_hash_table_lookup (private->tips_data_table, widget);
513 tooltips->active_tips_data = tooltipsdata;
517 tooltips->use_sticky_delay = FALSE;
522 gtk_tooltips_show_tip (GtkWidget *widget)
524 GtkTooltipsData *tooltipsdata;
526 tooltipsdata = gtk_tooltips_data_get (widget);
529 (!tooltipsdata->tooltips->active_tips_data ||
530 tooltipsdata->tooltips->active_tips_data->widget != widget))
532 gtk_tooltips_set_active_widget (tooltipsdata->tooltips, widget);
533 gtk_tooltips_draw_tips (tooltipsdata->tooltips);
538 gtk_tooltips_hide_tip (GtkWidget *widget)
540 GtkTooltipsData *tooltipsdata;
542 tooltipsdata = gtk_tooltips_data_get (widget);
545 (tooltipsdata->tooltips->active_tips_data &&
546 tooltipsdata->tooltips->active_tips_data->widget == widget))
547 gtk_tooltips_set_active_widget (tooltipsdata->tooltips, NULL);
551 gtk_tooltips_recently_shown (GtkTooltips *tooltips)
556 g_get_current_time (&now);
557 msec = (now.tv_sec - tooltips->last_popdown.tv_sec) * 1000 +
558 (now.tv_usec - tooltips->last_popdown.tv_usec) / 1000;
559 return (msec < STICKY_REVERT_DELAY);
563 get_keyboard_mode (GtkWidget *widget)
565 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
566 if (GTK_IS_WINDOW (toplevel))
567 return GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (toplevel), "gtk-tooltips-keyboard-mode"));
573 start_keyboard_mode (GtkWidget *widget)
575 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
576 if (GTK_IS_WINDOW (toplevel))
578 GtkWidget *focus = GTK_WINDOW (toplevel)->focus_widget;
580 g_object_set_data (G_OBJECT (toplevel), I_("gtk-tooltips-keyboard-mode"), GUINT_TO_POINTER (TRUE));
583 gtk_tooltips_show_tip (focus);
588 stop_keyboard_mode (GtkWidget *widget)
590 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
591 if (GTK_IS_WINDOW (toplevel))
593 GtkWidget *focus = GTK_WINDOW (toplevel)->focus_widget;
595 gtk_tooltips_hide_tip (focus);
597 g_object_set_data (G_OBJECT (toplevel), I_("gtk-tooltips-keyboard-mode"), GUINT_TO_POINTER (FALSE));
602 tooltips_enabled (GtkTooltips *tooltips, GtkWidget *w)
604 GtkSettings *settings;
605 gboolean touchscreen;
607 if (!tooltips->enabled)
610 settings = gtk_widget_get_settings (w);
611 g_object_get (settings, "gtk-touchscreen-mode", &touchscreen, NULL);
617 gtk_tooltips_start_delay (GtkTooltips *tooltips,
620 GtkTooltipsData *old_tips_data;
622 old_tips_data = tooltips->active_tips_data;
623 if (tooltips_enabled (tooltips, widget) &&
624 (!old_tips_data || old_tips_data->widget != widget))
628 gtk_tooltips_set_active_widget (tooltips, widget);
630 if (tooltips->use_sticky_delay &&
631 gtk_tooltips_recently_shown (tooltips))
632 delay = STICKY_DELAY;
634 delay = tooltips->delay;
635 tooltips->timer_tag = gdk_threads_add_timeout (delay,
636 gtk_tooltips_timeout,
637 (gpointer) tooltips);
642 gtk_tooltips_event_handler (GtkWidget *widget,
645 GtkTooltips *tooltips;
646 GtkTooltipsData *old_tips_data;
647 GtkWidget *event_widget;
648 gboolean keyboard_mode = get_keyboard_mode (widget);
650 if ((event->type == GDK_LEAVE_NOTIFY || event->type == GDK_ENTER_NOTIFY) &&
651 event->crossing.detail == GDK_NOTIFY_INFERIOR)
654 old_tips_data = gtk_tooltips_data_get (widget);
655 tooltips = old_tips_data->tooltips;
661 case GDK_FOCUS_CHANGE:
662 if (event->focus_change.in)
663 gtk_tooltips_show_tip (widget);
665 gtk_tooltips_hide_tip (widget);
673 if (event->type != GDK_KEY_PRESS && event->type != GDK_KEY_RELEASE)
675 event_widget = gtk_get_event_widget (event);
676 if (event_widget != widget)
685 case GDK_ENTER_NOTIFY:
686 if (!(GTK_IS_MENU_ITEM (widget) && GTK_MENU_ITEM (widget)->submenu))
687 gtk_tooltips_start_delay (tooltips, widget);
690 case GDK_LEAVE_NOTIFY:
692 gboolean use_sticky_delay;
694 use_sticky_delay = tooltips->tip_window &&
695 GTK_WIDGET_VISIBLE (tooltips->tip_window);
696 gtk_tooltips_set_active_widget (tooltips, NULL);
697 tooltips->use_sticky_delay = use_sticky_delay;
701 case GDK_MOTION_NOTIFY:
702 /* Handle menu items specially ... pend popup for each motion
703 * on other widgets, we ignore motion.
705 if (GTK_IS_MENU_ITEM (widget) && !GTK_MENU_ITEM (widget)->submenu)
707 /* Completely evil hack to make sure we get the LEAVE_NOTIFY
709 GTK_PRIVATE_SET_FLAG (widget, GTK_LEAVE_PENDING);
710 gtk_tooltips_set_active_widget (tooltips, NULL);
711 gtk_tooltips_start_delay (tooltips, widget);
715 case GDK_BUTTON_PRESS:
716 case GDK_BUTTON_RELEASE:
718 case GDK_KEY_RELEASE:
719 case GDK_PROXIMITY_IN:
721 gtk_tooltips_set_active_widget (tooltips, NULL);
730 gtk_tooltips_widget_unmap (GtkWidget *widget,
733 GtkTooltipsData *tooltipsdata = (GtkTooltipsData *)data;
734 GtkTooltips *tooltips = tooltipsdata->tooltips;
736 if (tooltips->active_tips_data &&
737 (tooltips->active_tips_data->widget == widget))
738 gtk_tooltips_set_active_widget (tooltips, NULL);
742 gtk_tooltips_widget_remove (GtkWidget *widget,
745 GtkTooltipsData *tooltipsdata = (GtkTooltipsData*) data;
746 GtkTooltips *tooltips = tooltipsdata->tooltips;
747 GtkTooltipsPrivate *private = GTK_TOOLTIPS_GET_PRIVATE (tooltips);
749 g_hash_table_remove (private->tips_data_table, tooltipsdata->widget);
753 _gtk_tooltips_toggle_keyboard_mode (GtkWidget *widget)
755 if (get_keyboard_mode (widget))
756 stop_keyboard_mode (widget);
758 start_keyboard_mode (widget);
762 * gtk_tooltips_get_info_from_tip_window:
763 * @tip_window: a #GtkWindow
764 * @tooltips: the return location for the tooltips which are displayed
765 * in @tip_window, or %NULL
766 * @current_widget: the return location for the widget whose tooltips
767 * are displayed, or %NULL
769 * Determines the tooltips and the widget they belong to from the window in
770 * which they are displayed.
772 * This function is mostly intended for use by accessibility technologies;
773 * applications should have little use for it.
775 * Return value: %TRUE if @tip_window is displaying tooltips, otherwise %FALSE.
782 gtk_tooltips_get_info_from_tip_window (GtkWindow *tip_window,
783 GtkTooltips **tooltips,
784 GtkWidget **current_widget)
786 GtkTooltips *current_tooltips;
789 g_return_val_if_fail (GTK_IS_WINDOW (tip_window), FALSE);
791 current_tooltips = g_object_get_data (G_OBJECT (tip_window), tooltips_info_key);
793 has_tips = current_tooltips != NULL;
796 *tooltips = current_tooltips;
798 *current_widget = (has_tips && current_tooltips->active_tips_data) ? current_tooltips->active_tips_data->widget : NULL;
803 #define __GTK_TOOLTIPS_C__
804 #include "gtkaliasdef.c"