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 g_source_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;
394 GtkTooltipsData *data;
395 gboolean keyboard_mode;
397 GdkScreen *pointer_screen;
398 gint monitor_num, px, py;
399 GdkRectangle monitor;
401 if (!tooltips->tip_window)
402 gtk_tooltips_force_window (tooltips);
403 else if (GTK_WIDGET_VISIBLE (tooltips->tip_window))
404 g_get_current_time (&tooltips->last_popdown);
406 gtk_widget_ensure_style (tooltips->tip_window);
407 style = tooltips->tip_window->style;
409 widget = tooltips->active_tips_data->widget;
411 keyboard_mode = get_keyboard_mode (widget);
413 gtk_tooltips_update_screen (tooltips, FALSE);
415 screen = gtk_widget_get_screen (widget);
417 data = tooltips->active_tips_data;
419 gtk_label_set_text (GTK_LABEL (tooltips->tip_label), data->tip_text);
421 gtk_widget_size_request (tooltips->tip_window, &requisition);
422 w = requisition.width;
423 h = requisition.height;
425 gdk_window_get_origin (widget->window, &x, &y);
426 if (GTK_WIDGET_NO_WINDOW (widget))
428 x += widget->allocation.x;
429 y += widget->allocation.y;
432 x += widget->allocation.width / 2;
435 gdk_window_get_pointer (gdk_screen_get_root_window (screen),
440 gdk_display_get_pointer (gdk_screen_get_display (screen),
441 &pointer_screen, &px, &py, NULL);
442 if (pointer_screen != screen)
447 monitor_num = gdk_screen_get_monitor_at_point (screen, px, py);
448 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
450 if ((x + w) > monitor.x + monitor.width)
451 x -= (x + w) - (monitor.x + monitor.width);
452 else if (x < monitor.x)
455 if ((y + h + widget->allocation.height + 4) > monitor.y + monitor.height)
458 y = y + widget->allocation.height + 4;
460 gtk_window_move (GTK_WINDOW (tooltips->tip_window), x, y);
461 gtk_widget_show (tooltips->tip_window);
465 gtk_tooltips_timeout (gpointer data)
467 GtkTooltips *tooltips = (GtkTooltips *) data;
469 GDK_THREADS_ENTER ();
471 if (tooltips->active_tips_data != NULL &&
472 GTK_WIDGET_DRAWABLE (tooltips->active_tips_data->widget))
473 gtk_tooltips_draw_tips (tooltips);
475 GDK_THREADS_LEAVE ();
481 gtk_tooltips_set_active_widget (GtkTooltips *tooltips,
484 if (tooltips->tip_window)
486 if (GTK_WIDGET_VISIBLE (tooltips->tip_window))
487 g_get_current_time (&tooltips->last_popdown);
488 gtk_widget_hide (tooltips->tip_window);
490 if (tooltips->timer_tag)
492 g_source_remove (tooltips->timer_tag);
493 tooltips->timer_tag = 0;
496 tooltips->active_tips_data = NULL;
502 for (list = tooltips->tips_data_list; list; list = list->next)
504 GtkTooltipsData *tooltipsdata;
506 tooltipsdata = list->data;
508 if (tooltipsdata->widget == widget &&
509 GTK_WIDGET_DRAWABLE (widget))
511 tooltips->active_tips_data = tooltipsdata;
518 tooltips->use_sticky_delay = FALSE;
523 gtk_tooltips_show_tip (GtkWidget *widget)
525 GtkTooltipsData *tooltipsdata;
527 tooltipsdata = gtk_tooltips_data_get (widget);
530 (!tooltipsdata->tooltips->active_tips_data ||
531 tooltipsdata->tooltips->active_tips_data->widget != widget))
533 gtk_tooltips_set_active_widget (tooltipsdata->tooltips, widget);
534 gtk_tooltips_draw_tips (tooltipsdata->tooltips);
539 gtk_tooltips_hide_tip (GtkWidget *widget)
541 GtkTooltipsData *tooltipsdata;
543 tooltipsdata = gtk_tooltips_data_get (widget);
546 (tooltipsdata->tooltips->active_tips_data &&
547 tooltipsdata->tooltips->active_tips_data->widget == widget))
548 gtk_tooltips_set_active_widget (tooltipsdata->tooltips, NULL);
552 gtk_tooltips_recently_shown (GtkTooltips *tooltips)
557 g_get_current_time (&now);
558 msec = (now.tv_sec - tooltips->last_popdown.tv_sec) * 1000 +
559 (now.tv_usec - tooltips->last_popdown.tv_usec) / 1000;
560 return (msec < STICKY_REVERT_DELAY);
564 get_keyboard_mode (GtkWidget *widget)
566 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
567 if (GTK_IS_WINDOW (toplevel))
568 return GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (toplevel), "gtk-tooltips-keyboard-mode"));
574 start_keyboard_mode (GtkWidget *widget)
576 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
577 if (GTK_IS_WINDOW (toplevel))
579 GtkWidget *focus = GTK_WINDOW (toplevel)->focus_widget;
581 g_object_set_data (G_OBJECT (toplevel), "gtk-tooltips-keyboard-mode", GUINT_TO_POINTER (TRUE));
584 gtk_tooltips_show_tip (focus);
589 stop_keyboard_mode (GtkWidget *widget)
591 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
592 if (GTK_IS_WINDOW (toplevel))
594 GtkWidget *focus = GTK_WINDOW (toplevel)->focus_widget;
596 gtk_tooltips_hide_tip (focus);
598 g_object_set_data (G_OBJECT (toplevel), "gtk-tooltips-keyboard-mode", GUINT_TO_POINTER (FALSE));
603 gtk_tooltips_start_delay (GtkTooltips *tooltips,
606 GtkTooltipsData *old_tips_data;
608 old_tips_data = tooltips->active_tips_data;
609 if (tooltips->enabled &&
610 (!old_tips_data || old_tips_data->widget != widget))
614 gtk_tooltips_set_active_widget (tooltips, widget);
616 if (tooltips->use_sticky_delay &&
617 gtk_tooltips_recently_shown (tooltips))
618 delay = STICKY_DELAY;
620 delay = tooltips->delay;
621 tooltips->timer_tag = g_timeout_add (delay,
622 gtk_tooltips_timeout,
623 (gpointer) tooltips);
628 gtk_tooltips_event_handler (GtkWidget *widget,
631 GtkTooltips *tooltips;
632 GtkTooltipsData *old_tips_data;
633 GtkWidget *event_widget;
634 gboolean keyboard_mode = get_keyboard_mode (widget);
636 if ((event->type == GDK_LEAVE_NOTIFY || event->type == GDK_ENTER_NOTIFY) &&
637 event->crossing.detail == GDK_NOTIFY_INFERIOR)
640 old_tips_data = gtk_tooltips_data_get (widget);
641 tooltips = old_tips_data->tooltips;
647 case GDK_FOCUS_CHANGE:
648 if (event->focus_change.in)
649 gtk_tooltips_show_tip (widget);
651 gtk_tooltips_hide_tip (widget);
659 if (event->type != GDK_KEY_PRESS && event->type != GDK_KEY_RELEASE)
661 event_widget = gtk_get_event_widget (event);
662 if (event_widget != widget)
671 case GDK_ENTER_NOTIFY:
672 if (!(GTK_IS_MENU_ITEM (widget) && GTK_MENU_ITEM (widget)->submenu))
673 gtk_tooltips_start_delay (tooltips, widget);
676 case GDK_LEAVE_NOTIFY:
678 gboolean use_sticky_delay;
680 use_sticky_delay = tooltips->tip_window &&
681 GTK_WIDGET_VISIBLE (tooltips->tip_window);
682 gtk_tooltips_set_active_widget (tooltips, NULL);
683 tooltips->use_sticky_delay = use_sticky_delay;
687 case GDK_MOTION_NOTIFY:
688 /* Handle menu items specially ... pend popup for each motion
689 * on other widgets, we ignore motion.
691 if (GTK_IS_MENU_ITEM (widget) && !GTK_MENU_ITEM (widget)->submenu)
693 /* Completely evil hack to make sure we get the LEAVE_NOTIFY
695 GTK_PRIVATE_SET_FLAG (widget, GTK_LEAVE_PENDING);
696 gtk_tooltips_set_active_widget (tooltips, NULL);
697 gtk_tooltips_start_delay (tooltips, widget);
701 case GDK_BUTTON_PRESS:
702 case GDK_BUTTON_RELEASE:
704 case GDK_KEY_RELEASE:
705 case GDK_PROXIMITY_IN:
707 gtk_tooltips_set_active_widget (tooltips, NULL);
716 gtk_tooltips_widget_unmap (GtkWidget *widget,
719 GtkTooltipsData *tooltipsdata = (GtkTooltipsData *)data;
720 GtkTooltips *tooltips = tooltipsdata->tooltips;
722 if (tooltips->active_tips_data &&
723 (tooltips->active_tips_data->widget == widget))
724 gtk_tooltips_set_active_widget (tooltips, NULL);
728 gtk_tooltips_widget_remove (GtkWidget *widget,
731 GtkTooltipsData *tooltipsdata = (GtkTooltipsData*) data;
732 GtkTooltips *tooltips = tooltipsdata->tooltips;
734 gtk_tooltips_widget_unmap (widget, data);
735 tooltips->tips_data_list = g_list_remove (tooltips->tips_data_list,
737 gtk_tooltips_destroy_data (tooltipsdata);
741 _gtk_tooltips_toggle_keyboard_mode (GtkWidget *widget)
743 if (get_keyboard_mode (widget))
744 stop_keyboard_mode (widget);
746 start_keyboard_mode (widget);