Pileus Git - ~andy/gtk/blob - gtk/gtktooltip.c

   1 /* gtktooltip.c
   2  *
   3  * Copyright (C) 2006-2007 Imendio AB
   4  * Contact: Kristian Rietveld <kris@imendio.com>
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 #include "config.h"
  23
  24 #include "gtktooltip.h"
  25
  26 #include <math.h>
  27 #include <string.h>
  28
  29 #include "gtkintl.h"
  30 #include "gtkwindow.h"
  31 #include "gtkmain.h"
  32 #include "gtklabel.h"
  33 #include "gtkimage.h"
  34 #include "gtkbox.h"
  35 #include "gtksizerequest.h"
  36 #include "gtkwindowprivate.h"
  37
  38
  39 /**
  40  * SECTION:gtktooltip
  41  * @Short_description: Add tips to your widgets
  42  * @Title: GtkTooltip
  43  *
  44  * Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text()
  45  * or gtk_widget_set_tooltip_markup() without any explicit tooltip object.
  46  *
  47  * When you need a tooltip with a little more fancy contents, like adding an
  48  * image, or you want the tooltip to have different contents per #GtkTreeView
  49  * row or cell, you will have to do a little more work:
  50  * <itemizedlist>
  51  * <listitem>
  52  * <para>
  53  * Set the #GtkWidget:has-tooltip property to %TRUE, this will make GTK+
  54  * monitor the widget for motion and related events which are needed to
  55  * determine when and where to show a tooltip.
  56  * </para>
  57  * </listitem>
  58  * <listitem>
  59  * <para>
  60  * Connect to the #GtkWidget::query-tooltip signal.  This signal will be
  61  * emitted when a tooltip is supposed to be shown. One of the arguments passed
  62  * to the signal handler is a GtkTooltip object. This is the object that we
  63  * are about to display as a tooltip, and can be manipulated in your callback
  64  * using functions like gtk_tooltip_set_icon(). There are functions for setting
  65  * the tooltip's markup, setting an image from a stock icon, or even putting in
  66  * a custom widget.
  67  * </para>
  68  * </listitem>
  69  * <listitem>
  70  * <para>
  71  * Return %TRUE from your query-tooltip handler. This causes the tooltip to be
  72  * show. If you return %FALSE, it will not be shown.
  73  * </para>
  74  * </listitem>
  75  * </itemizedlist>
  76  *
  77  * In the probably rare case where you want to have even more control over the
  78  * tooltip that is about to be shown, you can set your own #GtkWindow which
  79  * will be used as tooltip window.  This works as follows:
  80  * <itemizedlist>
  81  * <listitem>
  82  * <para>
  83  * Set #GtkWidget:has-tooltip and connect to #GtkWidget::query-tooltip as
  84  * before.
  85  * </para>
  86  * </listitem>
  87  * <listitem>
  88  * <para>
  89  * Use gtk_widget_set_tooltip_window() to set a #GtkWindow created by you as
  90  * tooltip window.
  91  * </para>
  92  * </listitem>
  93  * <listitem>
  94  * <para>
  95  * In the #GtkWidget::query-tooltip callback you can access your window using
  96  * gtk_widget_get_tooltip_window() and manipulate as you wish. The semantics of
  97  * the return value are exactly as before, return %TRUE to show the window,
  98  * %FALSE to not show it.
  99  * </para>
 100  * </listitem>
 101  * </itemizedlist>
 102  */
 103
 104
 105 #undef DEBUG_TOOLTIP
 106
 107
 108 #define GTK_TOOLTIP_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLTIP, GtkTooltipClass))
 109 #define GTK_IS_TOOLTIP_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLTIP))
 110 #define GTK_TOOLTIP_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLTIP, GtkTooltipClass))
 111
 112 typedef struct _GtkTooltipClass   GtkTooltipClass;
 113
 114 struct _GtkTooltip
 115 {
 116   GObject parent_instance;
 117
 118   GtkWidget *window;
 119   GtkWidget *alignment;
 120   GtkWidget *box;
 121   GtkWidget *image;
 122   GtkWidget *label;
 123   GtkWidget *custom_widget;
 124
 125   GtkWindow *current_window;
 126   GtkWidget *keyboard_widget;
 127
 128   GtkWidget *tooltip_widget;
 129   GdkWindow *toplevel_window;
 130
 131   gdouble last_x;
 132   gdouble last_y;
 133   GdkWindow *last_window;
 134
 135   guint timeout_id;
 136   guint browse_mode_timeout_id;
 137
 138   GdkRectangle tip_area;
 139
 140   guint browse_mode_enabled : 1;
 141   guint keyboard_mode_enabled : 1;
 142   guint tip_area_set : 1;
 143   guint custom_was_reset : 1;
 144 };
 145
 146 struct _GtkTooltipClass
 147 {
 148   GObjectClass parent_class;
 149 };
 150
 151 #define GTK_TOOLTIP_VISIBLE(tooltip) ((tooltip)->current_window && gtk_widget_get_visible (GTK_WIDGET((tooltip)->current_window)))
 152
 153
 154 static void       gtk_tooltip_class_init           (GtkTooltipClass *klass);
 155 static void       gtk_tooltip_init                 (GtkTooltip      *tooltip);
 156 static void       gtk_tooltip_dispose              (GObject         *object);
 157
 158 static gboolean   gtk_tooltip_paint_window         (GtkTooltip      *tooltip,
 159                                                     cairo_t         *cr);
 160 static void       gtk_tooltip_realize_window       (GtkTooltip      *tooltip,
 161                                                     GtkWidget       *widget);
 162 static void       maybe_update_shape               (GtkTooltip      *tooltip);
 163 static void       gtk_tooltip_window_hide          (GtkWidget       *widget,
 164                                                     gpointer         user_data);
 165 static void       gtk_tooltip_display_closed       (GdkDisplay      *display,
 166                                                     gboolean         was_error,
 167                                                     GtkTooltip      *tooltip);
 168 static void       gtk_tooltip_set_last_window      (GtkTooltip      *tooltip,
 169                                                     GdkWindow       *window);
 170
 171
 172 G_DEFINE_TYPE (GtkTooltip, gtk_tooltip, G_TYPE_OBJECT);
 173
 174 static void
 175 gtk_tooltip_class_init (GtkTooltipClass *klass)
 176 {
 177   GObjectClass *object_class;
 178
 179   object_class = G_OBJECT_CLASS (klass);
 180
 181   object_class->dispose = gtk_tooltip_dispose;
 182 }
 183
 184 static void
 185 gtk_tooltip_init (GtkTooltip *tooltip)
 186 {
 187   GtkStyleContext *context;
 188   GtkWidget *window;
 189   GtkWidget *box;
 190   GtkWidget *image;
 191   GtkWidget *label;
 192   GdkScreen *screen;
 193   GdkVisual *visual;
 194
 195   tooltip->timeout_id = 0;
 196   tooltip->browse_mode_timeout_id = 0;
 197
 198   tooltip->browse_mode_enabled = FALSE;
 199   tooltip->keyboard_mode_enabled = FALSE;
 200
 201   tooltip->current_window = NULL;
 202   tooltip->keyboard_widget = NULL;
 203
 204   tooltip->tooltip_widget = NULL;
 205   tooltip->toplevel_window = NULL;
 206
 207   tooltip->last_window = NULL;
 208
 209   window = g_object_ref (gtk_window_new (GTK_WINDOW_POPUP));
 210   screen = gtk_widget_get_screen (window);
 211   visual = gdk_screen_get_rgba_visual (screen);
 212
 213   if (visual != NULL)
 214     gtk_widget_set_visual (window, visual);
 215
 216   gtk_window_set_type_hint (GTK_WINDOW (window), GDK_WINDOW_TYPE_HINT_TOOLTIP);
 217   gtk_widget_set_app_paintable (window, TRUE);
 218   gtk_window_set_resizable (GTK_WINDOW (window), FALSE);
 219   gtk_widget_set_name (window, "gtk-tooltip");
 220   g_signal_connect (window, "hide",
 221                     G_CALLBACK (gtk_tooltip_window_hide), tooltip);
 222
 223   context = gtk_widget_get_style_context (window);
 224   gtk_style_context_add_class (context, GTK_STYLE_CLASS_TOOLTIP);
 225
 226   g_signal_connect_swapped (window, "draw",
 227                             G_CALLBACK (gtk_tooltip_paint_window), tooltip);
 228   g_signal_connect_swapped (window, "realize",
 229                             G_CALLBACK (gtk_tooltip_realize_window), tooltip);
 230   g_signal_connect_swapped (window, "composited-changed",
 231                             G_CALLBACK (maybe_update_shape), tooltip);
 232
 233   /* FIXME: don't hardcode the padding */
 234   box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);
 235   gtk_widget_set_margin_left (box, 6);
 236   gtk_widget_set_margin_right (box, 6);
 237   gtk_widget_set_margin_top (box, 6);
 238   gtk_widget_set_margin_bottom (box, 6);
 239   gtk_container_add (GTK_CONTAINER (window), box);
 240   gtk_widget_show (box);
 241
 242   image = gtk_image_new ();
 243   gtk_box_pack_start (GTK_BOX (box), image, FALSE, FALSE, 0);
 244
 245   label = gtk_label_new ("");
 246   gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
 247   gtk_box_pack_start (GTK_BOX (box), label, FALSE, FALSE, 0);
 248
 249   tooltip->window = window;
 250   tooltip->box = box;
 251   tooltip->image = image;
 252   tooltip->label = label;
 253   tooltip->custom_widget = NULL;
 254 }
 255
 256 static void
 257 gtk_tooltip_dispose (GObject *object)
 258 {
 259   GtkTooltip *tooltip = GTK_TOOLTIP (object);
 260
 261   if (tooltip->timeout_id)
 262     {
 263       g_source_remove (tooltip->timeout_id);
 264       tooltip->timeout_id = 0;
 265     }
 266
 267   if (tooltip->browse_mode_timeout_id)
 268     {
 269       g_source_remove (tooltip->browse_mode_timeout_id);
 270       tooltip->browse_mode_timeout_id = 0;
 271     }
 272
 273   gtk_tooltip_set_custom (tooltip, NULL);
 274   gtk_tooltip_set_last_window (tooltip, NULL);
 275
 276   if (tooltip->window)
 277     {
 278       GdkDisplay *display;
 279
 280       display = gtk_widget_get_display (tooltip->window);
 281       g_signal_handlers_disconnect_by_func (display,
 282                                             gtk_tooltip_display_closed,
 283                                             tooltip);
 284       gtk_widget_destroy (tooltip->window);
 285       tooltip->window = NULL;
 286     }
 287
 288   G_OBJECT_CLASS (gtk_tooltip_parent_class)->dispose (object);
 289 }
 290
 291 /* public API */
 292
 293 /**
 294  * gtk_tooltip_set_markup:
 295  * @tooltip: a #GtkTooltip
 296  * @markup: (allow-none): a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>) or %NULL
 297  *
 298  * Sets the text of the tooltip to be @markup, which is marked up
 299  * with the <link
 300  * linkend="PangoMarkupFormat">Pango text markup language</link>.
 301  * If @markup is %NULL, the label will be hidden.
 302  *
 303  * Since: 2.12
 304  */
 305 void
 306 gtk_tooltip_set_markup (GtkTooltip  *tooltip,
 307                         const gchar *markup)
 308 {
 309   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 310
 311   gtk_label_set_markup (GTK_LABEL (tooltip->label), markup);
 312
 313   if (markup)
 314     gtk_widget_show (tooltip->label);
 315   else
 316     gtk_widget_hide (tooltip->label);
 317 }
 318
 319 /**
 320  * gtk_tooltip_set_text:
 321  * @tooltip: a #GtkTooltip
 322  * @text: (allow-none): a text string or %NULL
 323  *
 324  * Sets the text of the tooltip to be @text. If @text is %NULL, the label
 325  * will be hidden. See also gtk_tooltip_set_markup().
 326  *
 327  * Since: 2.12
 328  */
 329 void
 330 gtk_tooltip_set_text (GtkTooltip  *tooltip,
 331                       const gchar *text)
 332 {
 333   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 334
 335   gtk_label_set_text (GTK_LABEL (tooltip->label), text);
 336
 337   if (text)
 338     gtk_widget_show (tooltip->label);
 339   else
 340     gtk_widget_hide (tooltip->label);
 341 }
 342
 343 /**
 344  * gtk_tooltip_set_icon:
 345  * @tooltip: a #GtkTooltip
 346  * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL
 347  *
 348  * Sets the icon of the tooltip (which is in front of the text) to be
 349  * @pixbuf.  If @pixbuf is %NULL, the image will be hidden.
 350  *
 351  * Since: 2.12
 352  */
 353 void
 354 gtk_tooltip_set_icon (GtkTooltip *tooltip,
 355                       GdkPixbuf  *pixbuf)
 356 {
 357   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 358   if (pixbuf)
 359     g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
 360
 361   gtk_image_set_from_pixbuf (GTK_IMAGE (tooltip->image), pixbuf);
 362
 363   if (pixbuf)
 364     gtk_widget_show (tooltip->image);
 365   else
 366     gtk_widget_hide (tooltip->image);
 367 }
 368
 369 /**
 370  * gtk_tooltip_set_icon_from_stock:
 371  * @tooltip: a #GtkTooltip
 372  * @stock_id: (allow-none): a stock id, or %NULL
 373  * @size: (type int): a stock icon size
 374  *
 375  * Sets the icon of the tooltip (which is in front of the text) to be
 376  * the stock item indicated by @stock_id with the size indicated
 377  * by @size.  If @stock_id is %NULL, the image will be hidden.
 378  *
 379  * Since: 2.12
 380  */
 381 void
 382 gtk_tooltip_set_icon_from_stock (GtkTooltip  *tooltip,
 383                                  const gchar *stock_id,
 384                                  GtkIconSize  size)
 385 {
 386   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 387
 388   gtk_image_set_from_stock (GTK_IMAGE (tooltip->image), stock_id, size);
 389
 390   if (stock_id)
 391     gtk_widget_show (tooltip->image);
 392   else
 393     gtk_widget_hide (tooltip->image);
 394 }
 395
 396 /**
 397  * gtk_tooltip_set_icon_from_icon_name:
 398  * @tooltip: a #GtkTooltip
 399  * @icon_name: (allow-none): an icon name, or %NULL
 400  * @size: (type int): a stock icon size
 401  *
 402  * Sets the icon of the tooltip (which is in front of the text) to be
 403  * the icon indicated by @icon_name with the size indicated
 404  * by @size.  If @icon_name is %NULL, the image will be hidden.
 405  *
 406  * Since: 2.14
 407  */
 408 void
 409 gtk_tooltip_set_icon_from_icon_name (GtkTooltip  *tooltip,
 410                                      const gchar *icon_name,
 411                                      GtkIconSize  size)
 412 {
 413   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 414
 415   gtk_image_set_from_icon_name (GTK_IMAGE (tooltip->image), icon_name, size);
 416
 417   if (icon_name)
 418     gtk_widget_show (tooltip->image);
 419   else
 420     gtk_widget_hide (tooltip->image);
 421 }
 422
 423 /**
 424  * gtk_tooltip_set_icon_from_gicon:
 425  * @tooltip: a #GtkTooltip
 426  * @gicon: (allow-none): a #GIcon representing the icon, or %NULL
 427  * @size: (type int): a stock icon size
 428  *
 429  * Sets the icon of the tooltip (which is in front of the text)
 430  * to be the icon indicated by @gicon with the size indicated
 431  * by @size. If @gicon is %NULL, the image will be hidden.
 432  *
 433  * Since: 2.20
 434  */
 435 void
 436 gtk_tooltip_set_icon_from_gicon (GtkTooltip  *tooltip,
 437                                  GIcon       *gicon,
 438                                  GtkIconSize  size)
 439 {
 440   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 441
 442   gtk_image_set_from_gicon (GTK_IMAGE (tooltip->image), gicon, size);
 443
 444   if (gicon)
 445     gtk_widget_show (tooltip->image);
 446   else
 447     gtk_widget_hide (tooltip->image);
 448 }
 449
 450 /**
 451  * gtk_tooltip_set_custom:
 452  * @tooltip: a #GtkTooltip
 453  * @custom_widget: (allow-none): a #GtkWidget, or %NULL to unset the old custom widget.
 454  *
 455  * Replaces the widget packed into the tooltip with
 456  * @custom_widget. @custom_widget does not get destroyed when the tooltip goes
 457  * away.
 458  * By default a box with a #GtkImage and #GtkLabel is embedded in
 459  * the tooltip, which can be configured using gtk_tooltip_set_markup()
 460  * and gtk_tooltip_set_icon().
 461
 462  *
 463  * Since: 2.12
 464  */
 465 void
 466 gtk_tooltip_set_custom (GtkTooltip *tooltip,
 467                         GtkWidget  *custom_widget)
 468 {
 469   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 470   if (custom_widget)
 471     g_return_if_fail (GTK_IS_WIDGET (custom_widget));
 472
 473   /* The custom widget has been updated from the query-tooltip
 474    * callback, so we do not want to reset the custom widget later on.
 475    */
 476   tooltip->custom_was_reset = TRUE;
 477
 478   /* No need to do anything if the custom widget stays the same */
 479   if (tooltip->custom_widget == custom_widget)
 480     return;
 481
 482   if (tooltip->custom_widget)
 483     {
 484       GtkWidget *custom = tooltip->custom_widget;
 485       /* Note: We must reset tooltip->custom_widget first,
 486        * since gtk_container_remove() will recurse into
 487        * gtk_tooltip_set_custom()
 488        */
 489       tooltip->custom_widget = NULL;
 490       gtk_container_remove (GTK_CONTAINER (tooltip->box), custom);
 491       g_object_unref (custom);
 492     }
 493
 494   if (custom_widget)
 495     {
 496       tooltip->custom_widget = g_object_ref (custom_widget);
 497
 498       gtk_container_add (GTK_CONTAINER (tooltip->box), custom_widget);
 499       gtk_widget_show (custom_widget);
 500     }
 501 }
 502
 503 /**
 504  * gtk_tooltip_set_tip_area:
 505  * @tooltip: a #GtkTooltip
 506  * @rect: a #GdkRectangle
 507  *
 508  * Sets the area of the widget, where the contents of this tooltip apply,
 509  * to be @rect (in widget coordinates).  This is especially useful for
 510  * properly setting tooltips on #GtkTreeView rows and cells, #GtkIconViews,
 511  * etc.
 512  *
 513  * For setting tooltips on #GtkTreeView, please refer to the convenience
 514  * functions for this: gtk_tree_view_set_tooltip_row() and
 515  * gtk_tree_view_set_tooltip_cell().
 516  *
 517  * Since: 2.12
 518  */
 519 void
 520 gtk_tooltip_set_tip_area (GtkTooltip         *tooltip,
 521                           const GdkRectangle *rect)
 522 {
 523   g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
 524
 525   if (!rect)
 526     tooltip->tip_area_set = FALSE;
 527   else
 528     {
 529       tooltip->tip_area_set = TRUE;
 530       tooltip->tip_area = *rect;
 531     }
 532 }
 533
 534 /**
 535  * gtk_tooltip_trigger_tooltip_query:
 536  * @display: a #GdkDisplay
 537  *
 538  * Triggers a new tooltip query on @display, in order to update the current
 539  * visible tooltip, or to show/hide the current tooltip.  This function is
 540  * useful to call when, for example, the state of the widget changed by a
 541  * key press.
 542  *
 543  * Since: 2.12
 544  */
 545 void
 546 gtk_tooltip_trigger_tooltip_query (GdkDisplay *display)
 547 {
 548   gint x, y;
 549   GdkWindow *window;
 550   GdkEvent event;
 551   GdkDevice *device;
 552
 553   /* Trigger logic as if the mouse moved */
 554   device = gdk_device_manager_get_client_pointer (gdk_display_get_device_manager (display));
 555   window = gdk_device_get_window_at_position (device, &x, &y);
 556   if (!window)
 557     return;
 558
 559   event.type = GDK_MOTION_NOTIFY;
 560   event.motion.window = window;
 561   event.motion.x = x;
 562   event.motion.y = y;
 563   event.motion.is_hint = FALSE;
 564
 565   gdk_window_get_root_coords (window, x, y, &x, &y);
 566   event.motion.x_root = x;
 567   event.motion.y_root = y;
 568
 569   _gtk_tooltip_handle_event (&event);
 570 }
 571
 572 /* private functions */
 573
 574 static void
 575 gtk_tooltip_reset (GtkTooltip *tooltip)
 576 {
 577   gtk_tooltip_set_markup (tooltip, NULL);
 578   gtk_tooltip_set_icon (tooltip, NULL);
 579   gtk_tooltip_set_tip_area (tooltip, NULL);
 580
 581   /* See if the custom widget is again set from the query-tooltip
 582    * callback.
 583    */
 584   tooltip->custom_was_reset = FALSE;
 585 }
 586
 587 static void
 588 paint_background_and_frame (GtkTooltip *tooltip,
 589                             cairo_t *cr)
 590 {
 591   GtkStyleContext *context;
 592   gint width, height;
 593
 594   width = gtk_widget_get_allocated_width (tooltip->window);
 595   height = gtk_widget_get_allocated_height (tooltip->window);
 596   context = gtk_widget_get_style_context (tooltip->window);
 597
 598   gtk_render_background (context, cr,
 599                          0, 0, width, height);
 600   gtk_render_frame (context, cr,
 601                     0, 0, width, height);
 602 }
 603
 604 static void
 605 maybe_update_shape (GtkTooltip *tooltip)
 606 {
 607   cairo_t *cr;
 608   cairo_surface_t *surface;
 609   cairo_region_t *region;
 610   gint width, height;
 611
 612   /* fallback to XShape only for non-composited clients */
 613   if (gtk_widget_is_composited (tooltip->window))
 614     {
 615       gtk_widget_shape_combine_region (tooltip->window, NULL);
 616       return;
 617     }
 618
 619   surface = gdk_window_create_similar_surface (gtk_widget_get_window (tooltip->window),
 620                                                CAIRO_CONTENT_COLOR_ALPHA,
 621                                                gtk_widget_get_allocated_width (tooltip->window),
 622                                                gtk_widget_get_allocated_height (tooltip->window));
 623
 624   cr = cairo_create (surface);
 625   paint_background_and_frame (tooltip, cr);
 626   cairo_destroy (cr);
 627
 628   region = gdk_cairo_region_create_from_surface (surface);
 629   gtk_widget_shape_combine_region (tooltip->window, region);
 630
 631   cairo_surface_destroy (surface);
 632   cairo_region_destroy (region);
 633 }
 634
 635 static void
 636 gtk_tooltip_realize_window (GtkTooltip *tooltip,
 637                             GtkWidget *widget)
 638 {
 639   maybe_update_shape (tooltip);
 640 }
 641
 642 static gboolean
 643 gtk_tooltip_paint_window (GtkTooltip *tooltip,
 644                           cairo_t    *cr)
 645 {
 646   if (gtk_widget_is_composited (tooltip->window))
 647     {
 648       /* clear any background */
 649       cairo_save (cr);
 650       cairo_set_source_rgba (cr, 0, 0, 0, 0);
 651       cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
 652       cairo_paint (cr);
 653       cairo_restore (cr);
 654     }
 655
 656   maybe_update_shape (tooltip);
 657   paint_background_and_frame (tooltip, cr);
 658
 659   return FALSE;
 660 }
 661
 662 static void
 663 gtk_tooltip_window_hide (GtkWidget *widget,
 664                          gpointer   user_data)
 665 {
 666   GtkTooltip *tooltip = GTK_TOOLTIP (user_data);
 667
 668   gtk_tooltip_set_custom (tooltip, NULL);
 669 }
 670
 671 /* event handling, etc */
 672
 673 struct ChildLocation
 674 {
 675   GtkWidget *child;
 676   GtkWidget *container;
 677
 678   gint x;
 679   gint y;
 680 };
 681
 682 static void
 683 child_location_foreach (GtkWidget *child,
 684                         gpointer   data)
 685 {
 686   GtkAllocation child_allocation;
 687   gint x, y;
 688   struct ChildLocation *child_loc = data;
 689
 690   /* Ignore invisible widgets */
 691   if (!gtk_widget_is_drawable (child))
 692     return;
 693
 694   gtk_widget_get_allocation (child, &child_allocation);
 695
 696   x = 0;
 697   y = 0;
 698
 699   /* (child_loc->x, child_loc->y) are relative to
 700    * child_loc->container's allocation.
 701    */
 702
 703   if (!child_loc->child &&
 704       gtk_widget_translate_coordinates (child_loc->container, child,
 705                                         child_loc->x, child_loc->y,
 706                                         &x, &y))
 707     {
 708 #ifdef DEBUG_TOOLTIP
 709       g_print ("candidate: %s  alloc=[(%d,%d)  %dx%d]     (%d, %d)->(%d, %d)\n",
 710                gtk_widget_get_name (child),
 711                child_allocation.x,
 712                child_allocation.y,
 713                child_allocation.width,
 714                child_allocation.height,
 715                child_loc->x, child_loc->y,
 716                x, y);
 717 #endif /* DEBUG_TOOLTIP */
 718
 719       /* (x, y) relative to child's allocation. */
 720       if (x >= 0 && x < child_allocation.width
 721           && y >= 0 && y < child_allocation.height)
 722         {
 723           if (GTK_IS_CONTAINER (child))
 724             {
 725               struct ChildLocation tmp = { NULL, NULL, 0, 0 };
 726
 727               /* Take (x, y) relative the child's allocation and
 728                * recurse.
 729                */
 730               tmp.x = x;
 731               tmp.y = y;
 732               tmp.container = child;
 733
 734               gtk_container_forall (GTK_CONTAINER (child),
 735                                     child_location_foreach, &tmp);
 736
 737               if (tmp.child)
 738                 child_loc->child = tmp.child;
 739               else
 740                 child_loc->child = child;
 741             }
 742           else
 743             child_loc->child = child;
 744         }
 745     }
 746 }
 747
 748 /* Translates coordinates from dest_widget->window relative (src_x, src_y),
 749  * to allocation relative (dest_x, dest_y) of dest_widget.
 750  */
 751 static void
 752 window_to_alloc (GtkWidget *dest_widget,
 753                  gint       src_x,
 754                  gint       src_y,
 755                  gint      *dest_x,
 756                  gint      *dest_y)
 757 {
 758   GtkAllocation allocation;
 759
 760   gtk_widget_get_allocation (dest_widget, &allocation);
 761
 762   /* Translate from window relative to allocation relative */
 763   if (gtk_widget_get_has_window (dest_widget) &&
 764       gtk_widget_get_parent (dest_widget))
 765     {
 766       gint wx, wy;
 767       gdk_window_get_position (gtk_widget_get_window (dest_widget),
 768                                &wx, &wy);
 769
 770       /* Offset coordinates if widget->window is smaller than
 771        * widget->allocation.
 772        */
 773       src_x += wx - allocation.x;
 774       src_y += wy - allocation.y;
 775     }
 776   else
 777     {
 778       src_x -= allocation.x;
 779       src_y -= allocation.y;
 780     }
 781
 782   if (dest_x)
 783     *dest_x = src_x;
 784   if (dest_y)
 785     *dest_y = src_y;
 786 }
 787
 788 /* Translates coordinates from window relative (x, y) to
 789  * allocation relative (x, y) of the returned widget.
 790  */
 791 GtkWidget *
 792 _gtk_widget_find_at_coords (GdkWindow *window,
 793                             gint       window_x,
 794                             gint       window_y,
 795                             gint      *widget_x,
 796                             gint      *widget_y)
 797 {
 798   GtkWidget *event_widget;
 799   struct ChildLocation child_loc = { NULL, NULL, 0, 0 };
 800
 801   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
 802
 803   gdk_window_get_user_data (window, (void **)&event_widget);
 804
 805   if (!event_widget)
 806     return NULL;
 807
 808 #ifdef DEBUG_TOOLTIP
 809   g_print ("event window %p (belonging to %p (%s))  (%d, %d)\n",
 810            window, event_widget, gtk_widget_get_name (event_widget),
 811            window_x, window_y);
 812 #endif
 813
 814   /* Coordinates are relative to event window */
 815   child_loc.x = window_x;
 816   child_loc.y = window_y;
 817
 818   /* We go down the window hierarchy to the widget->window,
 819    * coordinates stay relative to the current window.
 820    * We end up with window == widget->window, coordinates relative to that.
 821    */
 822   while (window && window != gtk_widget_get_window (event_widget))
 823     {
 824       gdouble px, py;
 825
 826       gdk_window_coords_to_parent (window,
 827                                    child_loc.x, child_loc.y,
 828                                    &px, &py);
 829       child_loc.x = px;
 830       child_loc.y = py;
 831
 832       window = gdk_window_get_effective_parent (window);
 833     }
 834
 835   /* Failing to find widget->window can happen for e.g. a detached handle box;
 836    * chaining ::query-tooltip up to its parent probably makes little sense,
 837    * and users better implement tooltips on handle_box->child.
 838    * so we simply ignore the event for tooltips here.
 839    */
 840   if (!window)
 841     return NULL;
 842
 843   /* Convert the window relative coordinates to allocation
 844    * relative coordinates.
 845    */
 846   window_to_alloc (event_widget,
 847                    child_loc.x, child_loc.y,
 848                    &child_loc.x, &child_loc.y);
 849
 850   if (GTK_IS_CONTAINER (event_widget))
 851     {
 852       GtkWidget *container = event_widget;
 853
 854       child_loc.container = event_widget;
 855       child_loc.child = NULL;
 856
 857       gtk_container_forall (GTK_CONTAINER (event_widget),
 858                             child_location_foreach, &child_loc);
 859
 860       /* Here we have a widget, with coordinates relative to
 861        * child_loc.container's allocation.
 862        */
 863
 864       if (child_loc.child)
 865         event_widget = child_loc.child;
 866       else if (child_loc.container)
 867         event_widget = child_loc.container;
 868
 869       /* Translate to event_widget's allocation */
 870       gtk_widget_translate_coordinates (container, event_widget,
 871                                         child_loc.x, child_loc.y,
 872                                         &child_loc.x, &child_loc.y);
 873     }
 874
 875   /* We return (x, y) relative to the allocation of event_widget. */
 876   if (widget_x)
 877     *widget_x = child_loc.x;
 878   if (widget_y)
 879     *widget_y = child_loc.y;
 880
 881   return event_widget;
 882 }
 883
 884 /* Ignores (x, y) on input, translates event coordinates to
 885  * allocation relative (x, y) of the returned widget.
 886  */
 887 static GtkWidget *
 888 find_topmost_widget_coords_from_event (GdkEvent *event,
 889                                        gint     *x,
 890                                        gint     *y)
 891 {
 892   GtkAllocation allocation;
 893   gint tx, ty;
 894   gdouble dx, dy;
 895   GtkWidget *tmp;
 896
 897   gdk_event_get_coords (event, &dx, &dy);
 898
 899   /* Returns coordinates relative to tmp's allocation. */
 900   tmp = _gtk_widget_find_at_coords (event->any.window, dx, dy, &tx, &ty);
 901
 902   if (!tmp)
 903     return NULL;
 904
 905   /* Make sure the pointer can actually be on the widget returned. */
 906   gtk_widget_get_allocation (tmp, &allocation);
 907   if (tx < 0 || tx >= allocation.width ||
 908       ty < 0 || ty >= allocation.height)
 909     return NULL;
 910
 911   if (x)
 912     *x = tx;
 913   if (y)
 914     *y = ty;
 915
 916   return tmp;
 917 }
 918
 919 static gint
 920 tooltip_browse_mode_expired (gpointer data)
 921 {
 922   GtkTooltip *tooltip;
 923
 924   tooltip = GTK_TOOLTIP (data);
 925
 926   tooltip->browse_mode_enabled = FALSE;
 927   tooltip->browse_mode_timeout_id = 0;
 928
 929   /* destroy tooltip */
 930   g_object_set_data (G_OBJECT (gtk_widget_get_display (tooltip->window)),
 931                      "gdk-display-current-tooltip", NULL);
 932
 933   return FALSE;
 934 }
 935
 936 static void
 937 gtk_tooltip_display_closed (GdkDisplay *display,
 938                             gboolean    was_error,
 939                             GtkTooltip *tooltip)
 940 {
 941   g_object_set_data (G_OBJECT (display), "gdk-display-current-tooltip", NULL);
 942 }
 943
 944 static void
 945 gtk_tooltip_set_last_window (GtkTooltip *tooltip,
 946                              GdkWindow  *window)
 947 {
 948   if (tooltip->last_window == window)
 949     return;
 950
 951   if (tooltip->last_window)
 952     g_object_remove_weak_pointer (G_OBJECT (tooltip->last_window),
 953                                   (gpointer *) &tooltip->last_window);
 954
 955   tooltip->last_window = window;
 956
 957   if (window)
 958     g_object_add_weak_pointer (G_OBJECT (tooltip->last_window),
 959                                (gpointer *) &tooltip->last_window);
 960 }
 961
 962 static gboolean
 963 gtk_tooltip_run_requery (GtkWidget  **widget,
 964                          GtkTooltip  *tooltip,
 965                          gint        *x,
 966                          gint        *y)
 967 {
 968   gboolean has_tooltip = FALSE;
 969   gboolean return_value = FALSE;
 970
 971   gtk_tooltip_reset (tooltip);
 972
 973   do
 974     {
 975       g_object_get (*widget,
 976                     "has-tooltip", &has_tooltip,
 977                     NULL);
 978
 979       if (has_tooltip)
 980         g_signal_emit_by_name (*widget,
 981                                "query-tooltip",
 982                                *x, *y,
 983                                tooltip->keyboard_mode_enabled,
 984                                tooltip,
 985                                &return_value);
 986
 987       if (!return_value)
 988         {
 989           GtkWidget *parent = gtk_widget_get_parent (*widget);
 990
 991           if (parent)
 992             gtk_widget_translate_coordinates (*widget, parent, *x, *y, x, y);
 993
 994           *widget = parent;
 995         }
 996       else
 997         break;
 998     }
 999   while (*widget);
1000
1001   /* If the custom widget was not reset in the query-tooltip
1002    * callback, we clear it here.
1003    */
1004   if (!tooltip->custom_was_reset)
1005     gtk_tooltip_set_custom (tooltip, NULL);
1006
1007   return return_value;
1008 }
1009
1010 static void
1011 get_bounding_box (GtkWidget    *widget,
1012                   GdkRectangle *bounds)
1013 {
1014   GtkAllocation allocation;
1015   GdkWindow *window;
1016   gint x, y;
1017   gint w, h;
1018   gint x1, y1;
1019   gint x2, y2;
1020   gint x3, y3;
1021   gint x4, y4;
1022
1023   window = gtk_widget_get_parent_window (widget);
1024   if (window == NULL)
1025     window = gtk_widget_get_window (widget);
1026
1027   gtk_widget_get_allocation (widget, &allocation);
1028   x = allocation.x;
1029   y = allocation.y;
1030   w = allocation.width;
1031   h = allocation.height;
1032
1033   gdk_window_get_root_coords (window, x, y, &x1, &y1);
1034   gdk_window_get_root_coords (window, x + w, y, &x2, &y2);
1035   gdk_window_get_root_coords (window, x, y + h, &x3, &y3);
1036   gdk_window_get_root_coords (window, x + w, y + h, &x4, &y4);
1037
1038 #define MIN4(a,b,c,d) MIN(MIN(a,b),MIN(c,d))
1039 #define MAX4(a,b,c,d) MAX(MAX(a,b),MAX(c,d))
1040
1041   bounds->x = floor (MIN4 (x1, x2, x3, x4));
1042   bounds->y = floor (MIN4 (y1, y2, y3, y4));
1043   bounds->width = ceil (MAX4 (x1, x2, x3, x4)) - bounds->x;
1044   bounds->height = ceil (MAX4 (y1, y2, y3, y4)) - bounds->y;
1045 }
1046
1047 static void
1048 gtk_tooltip_position (GtkTooltip *tooltip,
1049                       GdkDisplay *display,
1050                       GtkWidget  *new_tooltip_widget)
1051 {
1052   gint x, y, width, height;
1053   GdkScreen *screen;
1054   gint monitor_num;
1055   GdkRectangle monitor;
1056   guint cursor_size;
1057   GdkRectangle bounds;
1058
1059 #define MAX_DISTANCE 32
1060
1061   gtk_widget_realize (GTK_WIDGET (tooltip->current_window));
1062
1063   tooltip->tooltip_widget = new_tooltip_widget;
1064
1065   screen = gtk_widget_get_screen (new_tooltip_widget);
1066
1067   width = gtk_widget_get_allocated_width (GTK_WIDGET (tooltip->current_window));
1068   height = gtk_widget_get_allocated_height (GTK_WIDGET (tooltip->current_window));
1069
1070   monitor_num = gdk_screen_get_monitor_at_point (screen,
1071                                                  tooltip->last_x,
1072                                                  tooltip->last_y);
1073   gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
1074
1075   get_bounding_box (new_tooltip_widget, &bounds);
1076
1077   /* Position the tooltip */
1078
1079   cursor_size = gdk_display_get_default_cursor_size (display);
1080
1081   /* Try below */
1082   x = bounds.x + bounds.width / 2 - width / 2;
1083   y = bounds.y + bounds.height + 4;
1084
1085   if (y + height <= monitor.y + monitor.height)
1086     {
1087       if (tooltip->keyboard_mode_enabled)
1088         goto found;
1089
1090       if (y <= tooltip->last_y + cursor_size + MAX_DISTANCE)
1091         {
1092           if (tooltip->last_x + cursor_size + MAX_DISTANCE < x)
1093             x = tooltip->last_x + cursor_size + MAX_DISTANCE;
1094           else if (x + width < tooltip->last_x - MAX_DISTANCE)
1095             x = tooltip->last_x - MAX_DISTANCE - width;
1096
1097           goto found;
1098         }
1099    }
1100
1101   /* Try above */
1102   x = bounds.x + bounds.width / 2 - width / 2;
1103   y = bounds.y - height - 4;
1104
1105   if (y >= monitor.y)
1106     {
1107       if (tooltip->keyboard_mode_enabled)
1108         goto found;
1109
1110       if (y + height >= tooltip->last_y - MAX_DISTANCE)
1111         {
1112           if (tooltip->last_x + cursor_size + MAX_DISTANCE < x)
1113             x = tooltip->last_x + cursor_size + MAX_DISTANCE;
1114           else if (x + width < tooltip->last_x - MAX_DISTANCE)
1115             x = tooltip->last_x - MAX_DISTANCE - width;
1116
1117           goto found;
1118         }
1119     }
1120
1121   /* Try right FIXME: flip on rtl ? */
1122   x = bounds.x + bounds.width + 4;
1123   y = bounds.y + bounds.height / 2 - height / 2;
1124
1125   if (x + width <= monitor.x + monitor.width)
1126     {
1127       if (tooltip->keyboard_mode_enabled)
1128         goto found;
1129
1130       if (x <= tooltip->last_x + cursor_size + MAX_DISTANCE)
1131         {
1132           if (tooltip->last_y + cursor_size + MAX_DISTANCE < y)
1133             y = tooltip->last_y + cursor_size + MAX_DISTANCE;
1134           else if (y + height < tooltip->last_y - MAX_DISTANCE)
1135             y = tooltip->last_y - MAX_DISTANCE - height;
1136
1137           goto found;
1138         }
1139     }
1140
1141   /* Try left FIXME: flip on rtl ? */
1142   x = bounds.x - width - 4;
1143   y = bounds.y + bounds.height / 2 - height / 2;
1144
1145   if (x >= monitor.x)
1146     {
1147       if (tooltip->keyboard_mode_enabled)
1148         goto found;
1149
1150       if (x + width >= tooltip->last_x - MAX_DISTANCE)
1151         {
1152           if (tooltip->last_y + cursor_size + MAX_DISTANCE < y)
1153             y = tooltip->last_y + cursor_size + MAX_DISTANCE;
1154           else if (y + height < tooltip->last_y - MAX_DISTANCE)
1155             y = tooltip->last_y - MAX_DISTANCE - height;
1156
1157           goto found;
1158         }
1159     }
1160
1161    /* Fallback */
1162   if (tooltip->keyboard_mode_enabled)
1163     {
1164       x = bounds.x + bounds.width / 2 - width / 2;
1165       y = bounds.y + bounds.height + 4;
1166     }
1167   else
1168     {
1169       /* At cursor */
1170       x = tooltip->last_x + cursor_size * 3 / 4;
1171       y = tooltip->last_y + cursor_size * 3 / 4;
1172     }
1173
1174 found:
1175   /* Show it */
1176   if (tooltip->current_window)
1177     {
1178       if (x + width > monitor.x + monitor.width)
1179         x -= x - (monitor.x + monitor.width) + width;
1180       else if (x < monitor.x)
1181         x = monitor.x;
1182
1183       if (y + height > monitor.y + monitor.height)
1184         y -= y - (monitor.y + monitor.height) + height;
1185       else if (y < monitor.y)
1186         y = monitor.y;
1187
1188       if (!tooltip->keyboard_mode_enabled)
1189         {
1190           /* don't pop up under the pointer */
1191           if (x <= tooltip->last_x && tooltip->last_x < x + width &&
1192               y <= tooltip->last_y && tooltip->last_y < y + height)
1193             y = tooltip->last_y - height - 2;
1194         }
1195
1196       gtk_window_move (GTK_WINDOW (tooltip->current_window), x, y);
1197       gtk_widget_show (GTK_WIDGET (tooltip->current_window));
1198     }
1199 }
1200
1201 static void
1202 gtk_tooltip_show_tooltip (GdkDisplay *display)
1203 {
1204   gint x, y;
1205   GdkScreen *screen;
1206
1207   GdkWindow *window;
1208   GtkWidget *tooltip_widget;
1209   GtkTooltip *tooltip;
1210   gboolean has_tooltip;
1211   gboolean return_value = FALSE;
1212
1213   tooltip = g_object_get_data (G_OBJECT (display),
1214                                "gdk-display-current-tooltip");
1215
1216   if (tooltip->keyboard_mode_enabled)
1217     {
1218       x = y = -1;
1219       tooltip_widget = tooltip->keyboard_widget;
1220     }
1221   else
1222     {
1223       gint tx, ty;
1224
1225       window = tooltip->last_window;
1226
1227       if (!GDK_IS_WINDOW (window))
1228         return;
1229
1230       gdk_window_get_pointer (window, &x, &y, NULL);
1231
1232       gdk_window_get_root_coords (window, x, y, &tx, &ty);
1233       tooltip->last_x = tx;
1234       tooltip->last_y = ty;
1235
1236       tooltip_widget = _gtk_widget_find_at_coords (window, x, y, &x, &y);
1237     }
1238
1239   if (!tooltip_widget)
1240     return;
1241
1242   g_object_get (tooltip_widget, "has-tooltip", &has_tooltip, NULL);
1243
1244   return_value = gtk_tooltip_run_requery (&tooltip_widget, tooltip, &x, &y);
1245   if (!return_value)
1246     return;
1247
1248   if (!tooltip->current_window)
1249     {
1250       if (gtk_widget_get_tooltip_window (tooltip_widget))
1251         tooltip->current_window = gtk_widget_get_tooltip_window (tooltip_widget);
1252       else
1253         tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
1254     }
1255
1256   screen = gtk_widget_get_screen (tooltip_widget);
1257
1258   /* FIXME: should use tooltip->current_window iso tooltip->window */
1259   if (screen != gtk_widget_get_screen (tooltip->window))
1260     {
1261       g_signal_handlers_disconnect_by_func (display,
1262                                             gtk_tooltip_display_closed,
1263                                             tooltip);
1264
1265       gtk_window_set_screen (GTK_WINDOW (tooltip->window), screen);
1266
1267       g_signal_connect (display, "closed",
1268                         G_CALLBACK (gtk_tooltip_display_closed), tooltip);
1269     }
1270
1271   gtk_tooltip_position (tooltip, display, tooltip_widget);
1272
1273   /* Now a tooltip is visible again on the display, make sure browse
1274    * mode is enabled.
1275    */
1276   tooltip->browse_mode_enabled = TRUE;
1277   if (tooltip->browse_mode_timeout_id)
1278     {
1279       g_source_remove (tooltip->browse_mode_timeout_id);
1280       tooltip->browse_mode_timeout_id = 0;
1281     }
1282 }
1283
1284 static void
1285 gtk_tooltip_hide_tooltip (GtkTooltip *tooltip)
1286 {
1287   if (!tooltip)
1288     return;
1289
1290   if (tooltip->timeout_id)
1291     {
1292       g_source_remove (tooltip->timeout_id);
1293       tooltip->timeout_id = 0;
1294     }
1295
1296   if (!GTK_TOOLTIP_VISIBLE (tooltip))
1297     return;
1298
1299   tooltip->tooltip_widget = NULL;
1300
1301   if (!tooltip->keyboard_mode_enabled)
1302     {
1303       guint timeout;
1304       GtkSettings *settings;
1305
1306       settings = gtk_widget_get_settings (GTK_WIDGET (tooltip->window));
1307
1308       g_object_get (settings,
1309                     "gtk-tooltip-browse-mode-timeout", &timeout,
1310                     NULL);
1311
1312       /* The tooltip is gone, after (by default, should be configurable) 500ms
1313        * we want to turn off browse mode
1314        */
1315       if (!tooltip->browse_mode_timeout_id)
1316         tooltip->browse_mode_timeout_id =
1317           gdk_threads_add_timeout_full (0, timeout,
1318                                         tooltip_browse_mode_expired,
1319                                         g_object_ref (tooltip),
1320                                         g_object_unref);
1321     }
1322   else
1323     {
1324       if (tooltip->browse_mode_timeout_id)
1325         {
1326           g_source_remove (tooltip->browse_mode_timeout_id);
1327           tooltip->browse_mode_timeout_id = 0;
1328         }
1329     }
1330
1331   if (tooltip->current_window)
1332     {
1333       gtk_widget_hide (GTK_WIDGET (tooltip->current_window));
1334       tooltip->current_window = NULL;
1335     }
1336 }
1337
1338 static gint
1339 tooltip_popup_timeout (gpointer data)
1340 {
1341   GdkDisplay *display;
1342   GtkTooltip *tooltip;
1343
1344   display = GDK_DISPLAY (data);
1345   tooltip = g_object_get_data (G_OBJECT (display),
1346                                "gdk-display-current-tooltip");
1347
1348   /* This usually does not happen.  However, it does occur in language
1349    * bindings were reference counting of objects behaves differently.
1350    */
1351   if (!tooltip)
1352     return FALSE;
1353
1354   gtk_tooltip_show_tooltip (display);
1355
1356   tooltip->timeout_id = 0;
1357
1358   return FALSE;
1359 }
1360
1361 static void
1362 gtk_tooltip_start_delay (GdkDisplay *display)
1363 {
1364   guint timeout;
1365   GtkTooltip *tooltip;
1366   GtkSettings *settings;
1367
1368   tooltip = g_object_get_data (G_OBJECT (display),
1369                                "gdk-display-current-tooltip");
1370
1371   if (!tooltip || GTK_TOOLTIP_VISIBLE (tooltip))
1372     return;
1373
1374   if (tooltip->timeout_id)
1375     g_source_remove (tooltip->timeout_id);
1376
1377   settings = gtk_widget_get_settings (GTK_WIDGET (tooltip->window));
1378
1379   if (tooltip->browse_mode_enabled)
1380     g_object_get (settings, "gtk-tooltip-browse-timeout", &timeout, NULL);
1381   else
1382     g_object_get (settings, "gtk-tooltip-timeout", &timeout, NULL);
1383
1384   tooltip->timeout_id = gdk_threads_add_timeout_full (0, timeout,
1385                                                       tooltip_popup_timeout,
1386                                                       g_object_ref (display),
1387                                                       g_object_unref);
1388 }
1389
1390 void
1391 _gtk_tooltip_focus_in (GtkWidget *widget)
1392 {
1393   gint x, y;
1394   gboolean return_value = FALSE;
1395   GdkDisplay *display;
1396   GtkTooltip *tooltip;
1397   GdkDevice *device;
1398
1399   /* Get current tooltip for this display */
1400   display = gtk_widget_get_display (widget);
1401   tooltip = g_object_get_data (G_OBJECT (display),
1402                                "gdk-display-current-tooltip");
1403
1404   /* Check if keyboard mode is enabled at this moment */
1405   if (!tooltip || !tooltip->keyboard_mode_enabled)
1406     return;
1407
1408   device = gtk_get_current_event_device ();
1409
1410   if (device && gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1411     device = gdk_device_get_associated_device (device);
1412
1413   /* This function should be called by either a focus in event,
1414    * or a key binding. In either case there should be a device.
1415    */
1416   if (!device)
1417     return;
1418
1419   if (tooltip->keyboard_widget)
1420     g_object_unref (tooltip->keyboard_widget);
1421
1422   tooltip->keyboard_widget = g_object_ref (widget);
1423
1424   gdk_window_get_device_position (gtk_widget_get_window (widget),
1425                                   device, &x, &y, NULL);
1426
1427   return_value = gtk_tooltip_run_requery (&widget, tooltip, &x, &y);
1428   if (!return_value)
1429     {
1430       gtk_tooltip_hide_tooltip (tooltip);
1431       return;
1432     }
1433
1434   if (!tooltip->current_window)
1435     {
1436       if (gtk_widget_get_tooltip_window (widget))
1437         tooltip->current_window = gtk_widget_get_tooltip_window (widget);
1438       else
1439         tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
1440     }
1441
1442   gtk_tooltip_show_tooltip (display);
1443 }
1444
1445 void
1446 _gtk_tooltip_focus_out (GtkWidget *widget)
1447 {
1448   GdkDisplay *display;
1449   GtkTooltip *tooltip;
1450
1451   /* Get current tooltip for this display */
1452   display = gtk_widget_get_display (widget);
1453   tooltip = g_object_get_data (G_OBJECT (display),
1454                                "gdk-display-current-tooltip");
1455
1456   if (!tooltip || !tooltip->keyboard_mode_enabled)
1457     return;
1458
1459   if (tooltip->keyboard_widget)
1460     {
1461       g_object_unref (tooltip->keyboard_widget);
1462       tooltip->keyboard_widget = NULL;
1463     }
1464
1465   gtk_tooltip_hide_tooltip (tooltip);
1466 }
1467
1468 void
1469 _gtk_tooltip_toggle_keyboard_mode (GtkWidget *widget)
1470 {
1471   GdkDisplay *display;
1472   GtkTooltip *tooltip;
1473
1474   display = gtk_widget_get_display (widget);
1475   tooltip = g_object_get_data (G_OBJECT (display),
1476                                "gdk-display-current-tooltip");
1477
1478   if (!tooltip)
1479     {
1480       tooltip = g_object_new (GTK_TYPE_TOOLTIP, NULL);
1481       g_object_set_data_full (G_OBJECT (display),
1482                               "gdk-display-current-tooltip",
1483                               tooltip, g_object_unref);
1484       g_signal_connect (display, "closed",
1485                         G_CALLBACK (gtk_tooltip_display_closed),
1486                         tooltip);
1487     }
1488
1489   tooltip->keyboard_mode_enabled ^= 1;
1490
1491   if (tooltip->keyboard_mode_enabled)
1492     {
1493       tooltip->keyboard_widget = g_object_ref (widget);
1494       _gtk_tooltip_focus_in (widget);
1495     }
1496   else
1497     {
1498       if (tooltip->keyboard_widget)
1499         {
1500           g_object_unref (tooltip->keyboard_widget);
1501           tooltip->keyboard_widget = NULL;
1502         }
1503
1504       gtk_tooltip_hide_tooltip (tooltip);
1505     }
1506 }
1507
1508 void
1509 _gtk_tooltip_hide (GtkWidget *widget)
1510 {
1511   GtkWidget *toplevel;
1512   GdkDisplay *display;
1513   GtkTooltip *tooltip;
1514
1515   display = gtk_widget_get_display (widget);
1516   tooltip = g_object_get_data (G_OBJECT (display),
1517                                "gdk-display-current-tooltip");
1518
1519   if (!tooltip || !GTK_TOOLTIP_VISIBLE (tooltip) || !tooltip->tooltip_widget)
1520     return;
1521
1522   toplevel = gtk_widget_get_toplevel (widget);
1523
1524   if (widget == tooltip->tooltip_widget
1525       || gtk_widget_get_window (toplevel) == tooltip->toplevel_window)
1526     gtk_tooltip_hide_tooltip (tooltip);
1527 }
1528
1529 static gboolean
1530 tooltips_enabled (GdkWindow *window)
1531 {
1532   gboolean enabled;
1533   gboolean touchscreen;
1534   GdkScreen *screen;
1535   GtkSettings *settings;
1536
1537   screen = gdk_window_get_screen (window);
1538   settings = gtk_settings_get_for_screen (screen);
1539
1540   g_object_get (settings,
1541                 "gtk-touchscreen-mode", &touchscreen,
1542                 "gtk-enable-tooltips", &enabled,
1543                 NULL);
1544
1545   return (!touchscreen && enabled);
1546 }
1547
1548 void
1549 _gtk_tooltip_handle_event (GdkEvent *event)
1550 {
1551   gint x, y;
1552   gboolean return_value = FALSE;
1553   GtkWidget *has_tooltip_widget = NULL;
1554   GdkDisplay *display;
1555   GtkTooltip *current_tooltip;
1556
1557   if (!tooltips_enabled (event->any.window))
1558     return;
1559
1560   /* Returns coordinates relative to has_tooltip_widget's allocation. */
1561   has_tooltip_widget = find_topmost_widget_coords_from_event (event, &x, &y);
1562   display = gdk_window_get_display (event->any.window);
1563   current_tooltip = g_object_get_data (G_OBJECT (display),
1564                                        "gdk-display-current-tooltip");
1565
1566   if (current_tooltip)
1567     {
1568       gtk_tooltip_set_last_window (current_tooltip, event->any.window);
1569     }
1570
1571   if (current_tooltip && current_tooltip->keyboard_mode_enabled)
1572     {
1573       has_tooltip_widget = current_tooltip->keyboard_widget;
1574       if (!has_tooltip_widget)
1575         return;
1576
1577       return_value = gtk_tooltip_run_requery (&has_tooltip_widget,
1578                                               current_tooltip,
1579                                               &x, &y);
1580
1581       if (!return_value)
1582         gtk_tooltip_hide_tooltip (current_tooltip);
1583       else
1584         gtk_tooltip_start_delay (display);
1585
1586       return;
1587     }
1588
1589 #ifdef DEBUG_TOOLTIP
1590   if (has_tooltip_widget)
1591     g_print ("%p (%s) at (%d, %d) %dx%d     pointer: (%d, %d)\n",
1592              has_tooltip_widget, gtk_widget_get_name (has_tooltip_widget),
1593              has_tooltip_widget->allocation.x,
1594              has_tooltip_widget->allocation.y,
1595              has_tooltip_widget->allocation.width,
1596              has_tooltip_widget->allocation.height,
1597              x, y);
1598 #endif /* DEBUG_TOOLTIP */
1599
1600   /* Always poll for a next motion event */
1601   gdk_event_request_motions (&event->motion);
1602
1603   /* Hide the tooltip when there's no new tooltip widget */
1604   if (!has_tooltip_widget)
1605     {
1606       if (current_tooltip)
1607         gtk_tooltip_hide_tooltip (current_tooltip);
1608
1609       return;
1610     }
1611
1612   switch (event->type)
1613     {
1614       case GDK_BUTTON_PRESS:
1615       case GDK_2BUTTON_PRESS:
1616       case GDK_3BUTTON_PRESS:
1617       case GDK_KEY_PRESS:
1618       case GDK_DRAG_ENTER:
1619       case GDK_GRAB_BROKEN:
1620       case GDK_SCROLL:
1621         gtk_tooltip_hide_tooltip (current_tooltip);
1622         break;
1623
1624       case GDK_MOTION_NOTIFY:
1625       case GDK_ENTER_NOTIFY:
1626       case GDK_LEAVE_NOTIFY:
1627         if (current_tooltip)
1628           {
1629             gboolean tip_area_set;
1630             GdkRectangle tip_area;
1631             gboolean hide_tooltip;
1632
1633             tip_area_set = current_tooltip->tip_area_set;
1634             tip_area = current_tooltip->tip_area;
1635
1636             return_value = gtk_tooltip_run_requery (&has_tooltip_widget,
1637                                                     current_tooltip,
1638                                                     &x, &y);
1639
1640             /* Requested to be hidden? */
1641             hide_tooltip = !return_value;
1642
1643             /* Leave notify should override the query function */
1644             hide_tooltip = (event->type == GDK_LEAVE_NOTIFY);
1645
1646             /* Is the pointer above another widget now? */
1647             if (GTK_TOOLTIP_VISIBLE (current_tooltip))
1648               hide_tooltip |= has_tooltip_widget != current_tooltip->tooltip_widget;
1649
1650             /* Did the pointer move out of the previous "context area"? */
1651             if (tip_area_set)
1652               hide_tooltip |= (x <= tip_area.x
1653                                || x >= tip_area.x + tip_area.width
1654                                || y <= tip_area.y
1655                                || y >= tip_area.y + tip_area.height);
1656
1657             if (hide_tooltip)
1658               gtk_tooltip_hide_tooltip (current_tooltip);
1659             else
1660               gtk_tooltip_start_delay (display);
1661           }
1662         else
1663           {
1664             /* Need a new tooltip for this display */
1665             current_tooltip = g_object_new (GTK_TYPE_TOOLTIP, NULL);
1666             g_object_set_data_full (G_OBJECT (display),
1667                                     "gdk-display-current-tooltip",
1668                                     current_tooltip, g_object_unref);
1669             g_signal_connect (display, "closed",
1670                               G_CALLBACK (gtk_tooltip_display_closed),
1671                               current_tooltip);
1672
1673             gtk_tooltip_set_last_window (current_tooltip, event->any.window);
1674
1675             gtk_tooltip_start_delay (display);
1676           }
1677         break;
1678
1679       default:
1680         break;
1681     }
1682 }