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/.
33 #include "gtkmenuitem.h"
34 #include "gtkprivate.h"
35 #include "gtkwidget.h"
36 #include "gtkwindow.h"
38 #include "gtktooltips.h"
41 #define DEFAULT_DELAY 500 /* Default delay in ms */
42 #define STICKY_DELAY 0 /* Delay before popping up next tip
45 #define STICKY_REVERT_DELAY 1000 /* Delay before sticky tooltips revert
49 static void gtk_tooltips_class_init (GtkTooltipsClass *klass);
50 static void gtk_tooltips_init (GtkTooltips *tooltips);
51 static void gtk_tooltips_destroy (GtkObject *object);
53 static void gtk_tooltips_event_handler (GtkWidget *widget,
55 static void gtk_tooltips_widget_unmap (GtkWidget *widget,
57 static void gtk_tooltips_widget_remove (GtkWidget *widget,
59 static void gtk_tooltips_set_active_widget (GtkTooltips *tooltips,
61 static gint gtk_tooltips_timeout (gpointer data);
63 static gint gtk_tooltips_paint_window (GtkTooltips *tooltips);
64 static void gtk_tooltips_draw_tips (GtkTooltips *tooltips);
65 static void gtk_tooltips_unset_tip_window (GtkTooltips *tooltips);
67 static gboolean get_keyboard_mode (GtkWidget *widget);
69 static GtkObjectClass *parent_class;
70 static const gchar *tooltips_data_key = "_GtkTooltipsData";
73 gtk_tooltips_get_type (void)
75 static GType tooltips_type = 0;
79 static const GTypeInfo tooltips_info =
81 sizeof (GtkTooltipsClass),
83 NULL, /* base_finalize */
84 (GClassInitFunc) gtk_tooltips_class_init,
85 NULL, /* class_finalize */
86 NULL, /* class_data */
89 (GInstanceInitFunc) gtk_tooltips_init,
92 tooltips_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkTooltips",
100 gtk_tooltips_class_init (GtkTooltipsClass *class)
102 GtkObjectClass *object_class;
104 object_class = (GtkObjectClass*) class;
106 parent_class = g_type_class_peek_parent (class);
108 object_class->destroy = gtk_tooltips_destroy;
112 gtk_tooltips_init (GtkTooltips *tooltips)
114 tooltips->tip_window = NULL;
115 tooltips->active_tips_data = NULL;
116 tooltips->tips_data_list = NULL;
118 tooltips->delay = DEFAULT_DELAY;
119 tooltips->enabled = TRUE;
120 tooltips->timer_tag = 0;
121 tooltips->use_sticky_delay = FALSE;
122 tooltips->last_popdown.tv_sec = -1;
123 tooltips->last_popdown.tv_usec = -1;
127 gtk_tooltips_new (void)
129 return g_object_new (GTK_TYPE_TOOLTIPS, NULL);
133 gtk_tooltips_destroy_data (GtkTooltipsData *tooltipsdata)
135 g_free (tooltipsdata->tip_text);
136 g_free (tooltipsdata->tip_private);
138 g_signal_handlers_disconnect_by_func (tooltipsdata->widget,
139 gtk_tooltips_event_handler,
141 g_signal_handlers_disconnect_by_func (tooltipsdata->widget,
142 gtk_tooltips_widget_unmap,
144 g_signal_handlers_disconnect_by_func (tooltipsdata->widget,
145 gtk_tooltips_widget_remove,
148 g_object_set_data (G_OBJECT (tooltipsdata->widget), tooltips_data_key, NULL);
149 g_object_unref (tooltipsdata->widget);
150 g_free (tooltipsdata);
154 tip_window_display_closed (GdkDisplay *display,
156 GtkTooltips *tooltips)
158 gtk_tooltips_unset_tip_window (tooltips);
162 disconnect_tip_window_display_closed (GtkTooltips *tooltips)
164 g_signal_handlers_disconnect_by_func (gtk_widget_get_display (tooltips->tip_window),
165 (gpointer) tip_window_display_closed,
170 gtk_tooltips_unset_tip_window (GtkTooltips *tooltips)
172 if (tooltips->tip_window)
174 disconnect_tip_window_display_closed (tooltips);
176 gtk_widget_destroy (tooltips->tip_window);
177 tooltips->tip_window = NULL;
182 gtk_tooltips_destroy (GtkObject *object)
184 GtkTooltips *tooltips = GTK_TOOLTIPS (object);
186 GtkTooltipsData *tooltipsdata;
188 g_return_if_fail (tooltips != NULL);
190 if (tooltips->timer_tag)
192 gtk_timeout_remove (tooltips->timer_tag);
193 tooltips->timer_tag = 0;
196 if (tooltips->tips_data_list != NULL)
198 current = g_list_first (tooltips->tips_data_list);
199 while (current != NULL)
201 tooltipsdata = (GtkTooltipsData*) current->data;
202 current = current->next;
203 gtk_tooltips_widget_remove (tooltipsdata->widget, tooltipsdata);
207 gtk_tooltips_unset_tip_window (tooltips);
211 gtk_tooltips_update_screen (GtkTooltips *tooltips,
214 gboolean screen_changed = FALSE;
216 if (tooltips->active_tips_data &&
217 tooltips->active_tips_data->widget)
219 GdkScreen *screen = gtk_widget_get_screen (tooltips->active_tips_data->widget);
221 screen_changed = (screen != gtk_widget_get_screen (tooltips->tip_window));
226 disconnect_tip_window_display_closed (tooltips);
228 gtk_window_set_screen (GTK_WINDOW (tooltips->tip_window), screen);
232 if (screen_changed || new_window)
233 g_signal_connect (gtk_widget_get_display (tooltips->tip_window), "closed",
234 G_CALLBACK (tip_window_display_closed), tooltips);
239 gtk_tooltips_force_window (GtkTooltips *tooltips)
241 g_return_if_fail (GTK_IS_TOOLTIPS (tooltips));
243 if (!tooltips->tip_window)
245 tooltips->tip_window = gtk_window_new (GTK_WINDOW_POPUP);
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 tooltips->tips_data_list = g_list_append (tooltips->tips_data_list,
355 g_signal_connect_after (widget, "event-after",
356 G_CALLBACK (gtk_tooltips_event_handler),
359 g_object_set_data (G_OBJECT (widget), tooltips_data_key,
362 g_signal_connect (widget, "unmap",
363 G_CALLBACK (gtk_tooltips_widget_unmap),
366 g_signal_connect (widget, "unrealize",
367 G_CALLBACK (gtk_tooltips_widget_unmap),
370 g_signal_connect (widget, "destroy",
371 G_CALLBACK (gtk_tooltips_widget_remove),
377 gtk_tooltips_paint_window (GtkTooltips *tooltips)
379 gtk_paint_flat_box (tooltips->tip_window->style, tooltips->tip_window->window,
380 GTK_STATE_NORMAL, GTK_SHADOW_OUT,
381 NULL, GTK_WIDGET(tooltips->tip_window), "tooltip",
388 gtk_tooltips_draw_tips (GtkTooltips *tooltips)
390 GtkRequisition requisition;
393 gint x, y, w, h, scr_w, scr_h;
394 GtkTooltipsData *data;
395 gboolean keyboard_mode;
398 if (!tooltips->tip_window)
399 gtk_tooltips_force_window (tooltips);
400 else if (GTK_WIDGET_VISIBLE (tooltips->tip_window))
401 g_get_current_time (&tooltips->last_popdown);
403 gtk_widget_ensure_style (tooltips->tip_window);
404 style = tooltips->tip_window->style;
406 widget = tooltips->active_tips_data->widget;
408 keyboard_mode = get_keyboard_mode (widget);
410 gtk_tooltips_update_screen (tooltips, FALSE);
412 screen = gtk_widget_get_screen (widget);
413 scr_w = gdk_screen_get_width (screen);
414 scr_h = gdk_screen_get_height (screen);
416 data = tooltips->active_tips_data;
418 gtk_label_set_text (GTK_LABEL (tooltips->tip_label), data->tip_text);
420 gtk_widget_size_request (tooltips->tip_window, &requisition);
421 w = requisition.width;
422 h = requisition.height;
424 gdk_window_get_origin (widget->window, &x, &y);
425 if (GTK_WIDGET_NO_WINDOW (widget))
427 x += widget->allocation.x;
428 y += widget->allocation.y;
431 x += widget->allocation.width / 2;
434 gdk_window_get_pointer (gdk_screen_get_root_window (screen),
440 x -= (x + w) - scr_w;
444 if ((y + h + widget->allocation.height + 4) > scr_h)
447 y = y + widget->allocation.height + 4;
449 gtk_window_move (GTK_WINDOW (tooltips->tip_window), x, y);
450 gtk_widget_show (tooltips->tip_window);
454 gtk_tooltips_timeout (gpointer data)
456 GtkTooltips *tooltips = (GtkTooltips *) data;
458 GDK_THREADS_ENTER ();
460 if (tooltips->active_tips_data != NULL &&
461 GTK_WIDGET_DRAWABLE (tooltips->active_tips_data->widget))
462 gtk_tooltips_draw_tips (tooltips);
464 GDK_THREADS_LEAVE ();
470 gtk_tooltips_set_active_widget (GtkTooltips *tooltips,
473 if (tooltips->tip_window)
475 if (GTK_WIDGET_VISIBLE (tooltips->tip_window))
476 g_get_current_time (&tooltips->last_popdown);
477 gtk_widget_hide (tooltips->tip_window);
479 if (tooltips->timer_tag)
481 gtk_timeout_remove (tooltips->timer_tag);
482 tooltips->timer_tag = 0;
485 tooltips->active_tips_data = NULL;
491 for (list = tooltips->tips_data_list; list; list = list->next)
493 GtkTooltipsData *tooltipsdata;
495 tooltipsdata = list->data;
497 if (tooltipsdata->widget == widget &&
498 GTK_WIDGET_DRAWABLE (widget))
500 tooltips->active_tips_data = tooltipsdata;
507 tooltips->use_sticky_delay = FALSE;
512 gtk_tooltips_show_tip (GtkWidget *widget)
514 GtkTooltipsData *tooltipsdata;
516 tooltipsdata = gtk_tooltips_data_get (widget);
519 (!tooltipsdata->tooltips->active_tips_data ||
520 tooltipsdata->tooltips->active_tips_data->widget != widget))
522 gtk_tooltips_set_active_widget (tooltipsdata->tooltips, widget);
523 gtk_tooltips_draw_tips (tooltipsdata->tooltips);
528 gtk_tooltips_hide_tip (GtkWidget *widget)
530 GtkTooltipsData *tooltipsdata;
532 tooltipsdata = gtk_tooltips_data_get (widget);
535 (tooltipsdata->tooltips->active_tips_data &&
536 tooltipsdata->tooltips->active_tips_data->widget == widget))
537 gtk_tooltips_set_active_widget (tooltipsdata->tooltips, NULL);
541 gtk_tooltips_recently_shown (GtkTooltips *tooltips)
546 g_get_current_time (&now);
547 msec = (now.tv_sec - tooltips->last_popdown.tv_sec) * 1000 +
548 (now.tv_usec - tooltips->last_popdown.tv_usec) / 1000;
549 return (msec < STICKY_REVERT_DELAY);
553 get_keyboard_mode (GtkWidget *widget)
555 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
556 if (GTK_IS_WINDOW (toplevel))
557 return GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (toplevel), "gtk-tooltips-keyboard-mode"));
563 start_keyboard_mode (GtkWidget *widget)
565 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
566 if (GTK_IS_WINDOW (toplevel))
568 GtkWidget *focus = GTK_WINDOW (toplevel)->focus_widget;
570 g_object_set_data (G_OBJECT (toplevel), "gtk-tooltips-keyboard-mode", GUINT_TO_POINTER (TRUE));
573 gtk_tooltips_show_tip (focus);
578 stop_keyboard_mode (GtkWidget *widget)
580 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
581 if (GTK_IS_WINDOW (toplevel))
583 GtkWidget *focus = GTK_WINDOW (toplevel)->focus_widget;
585 gtk_tooltips_hide_tip (focus);
587 g_object_set_data (G_OBJECT (toplevel), "gtk-tooltips-keyboard-mode", GUINT_TO_POINTER (FALSE));
592 gtk_tooltips_start_delay (GtkTooltips *tooltips,
595 GtkTooltipsData *old_tips_data;
597 old_tips_data = tooltips->active_tips_data;
598 if (tooltips->enabled &&
599 (!old_tips_data || old_tips_data->widget != widget))
603 gtk_tooltips_set_active_widget (tooltips, widget);
605 if (tooltips->use_sticky_delay &&
606 gtk_tooltips_recently_shown (tooltips))
607 delay = STICKY_DELAY;
609 delay = tooltips->delay;
610 tooltips->timer_tag = gtk_timeout_add (delay,
611 gtk_tooltips_timeout,
612 (gpointer) tooltips);
617 gtk_tooltips_event_handler (GtkWidget *widget,
620 GtkTooltips *tooltips;
621 GtkTooltipsData *old_tips_data;
622 GtkWidget *event_widget;
623 gboolean keyboard_mode = get_keyboard_mode (widget);
625 if ((event->type == GDK_LEAVE_NOTIFY || event->type == GDK_ENTER_NOTIFY) &&
626 event->crossing.detail == GDK_NOTIFY_INFERIOR)
629 old_tips_data = gtk_tooltips_data_get (widget);
630 tooltips = old_tips_data->tooltips;
636 case GDK_FOCUS_CHANGE:
637 if (event->focus_change.in)
638 gtk_tooltips_show_tip (widget);
640 gtk_tooltips_hide_tip (widget);
648 if (event->type != GDK_KEY_PRESS && event->type != GDK_KEY_RELEASE)
650 event_widget = gtk_get_event_widget (event);
651 if (event_widget != widget)
660 case GDK_ENTER_NOTIFY:
661 if (!(GTK_IS_MENU_ITEM (widget) && GTK_MENU_ITEM (widget)->submenu))
662 gtk_tooltips_start_delay (tooltips, widget);
665 case GDK_LEAVE_NOTIFY:
667 gboolean use_sticky_delay;
669 use_sticky_delay = tooltips->tip_window &&
670 GTK_WIDGET_VISIBLE (tooltips->tip_window);
671 gtk_tooltips_set_active_widget (tooltips, NULL);
672 tooltips->use_sticky_delay = use_sticky_delay;
676 case GDK_MOTION_NOTIFY:
677 /* Handle menu items specially ... pend popup for each motion
678 * on other widgets, we ignore motion.
680 if (GTK_IS_MENU_ITEM (widget) && !GTK_MENU_ITEM (widget)->submenu)
682 /* Completely evil hack to make sure we get the LEAVE_NOTIFY
684 GTK_PRIVATE_SET_FLAG (widget, GTK_LEAVE_PENDING);
685 gtk_tooltips_set_active_widget (tooltips, NULL);
686 gtk_tooltips_start_delay (tooltips, widget);
690 case GDK_BUTTON_PRESS:
691 case GDK_BUTTON_RELEASE:
693 case GDK_KEY_RELEASE:
694 case GDK_PROXIMITY_IN:
696 gtk_tooltips_set_active_widget (tooltips, NULL);
705 gtk_tooltips_widget_unmap (GtkWidget *widget,
708 GtkTooltipsData *tooltipsdata = (GtkTooltipsData *)data;
709 GtkTooltips *tooltips = tooltipsdata->tooltips;
711 if (tooltips->active_tips_data &&
712 (tooltips->active_tips_data->widget == widget))
713 gtk_tooltips_set_active_widget (tooltips, NULL);
717 gtk_tooltips_widget_remove (GtkWidget *widget,
720 GtkTooltipsData *tooltipsdata = (GtkTooltipsData*) data;
721 GtkTooltips *tooltips = tooltipsdata->tooltips;
723 gtk_tooltips_widget_unmap (widget, data);
724 tooltips->tips_data_list = g_list_remove (tooltips->tips_data_list,
726 gtk_tooltips_destroy_data (tooltipsdata);
730 _gtk_tooltips_toggle_keyboard_mode (GtkWidget *widget)
732 if (get_keyboard_mode (widget))
733 stop_keyboard_mode (widget);
735 start_keyboard_mode (widget);