gtktooltip.c 40.4 KB
Newer Older
Kristian Rietveld's avatar
Kristian Rietveld committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/* gtktooltip.c
 *
 * Copyright (C) 2006-2007 Imendio AB
 * Contact: Kristian Rietveld <kris@imendio.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

22
#include "config.h"
23

24 25
#include "gtktooltip.h"

26 27 28
#include <math.h>
#include <string.h>

Kristian Rietveld's avatar
Kristian Rietveld committed
29 30 31 32 33 34 35
#include "gtkintl.h"
#include "gtkwindow.h"
#include "gtkmain.h"
#include "gtklabel.h"
#include "gtkimage.h"
#include "gtkhbox.h"
#include "gtkalignment.h"
36
#include "gtksizerequest.h"
Kristian Rietveld's avatar
Kristian Rietveld committed
37

Matthias Clasen's avatar
Matthias Clasen committed
38

39 40
#undef DEBUG_TOOLTIP

Kristian Rietveld's avatar
Kristian Rietveld committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

#define GTK_TOOLTIP_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLTIP, GtkTooltipClass))
#define GTK_IS_TOOLTIP_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLTIP))
#define GTK_TOOLTIP_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLTIP, GtkTooltipClass))

typedef struct _GtkTooltipClass   GtkTooltipClass;

struct _GtkTooltip
{
  GObject parent_instance;

  GtkWidget *window;
  GtkWidget *alignment;
  GtkWidget *box;
  GtkWidget *image;
  GtkWidget *label;
  GtkWidget *custom_widget;

  GtkWindow *current_window;
  GtkWidget *keyboard_widget;

  GtkWidget *tooltip_widget;
  GdkWindow *toplevel_window;

  gdouble last_x;
  gdouble last_y;
  GdkWindow *last_window;

  guint timeout_id;
  guint browse_mode_timeout_id;

72 73
  GdkRectangle tip_area;

Kristian Rietveld's avatar
Kristian Rietveld committed
74 75
  guint browse_mode_enabled : 1;
  guint keyboard_mode_enabled : 1;
76
  guint tip_area_set : 1;
77
  guint custom_was_reset : 1;
Kristian Rietveld's avatar
Kristian Rietveld committed
78 79 80 81 82 83 84
};

struct _GtkTooltipClass
{
  GObjectClass parent_class;
};

85
#define GTK_TOOLTIP_VISIBLE(tooltip) ((tooltip)->current_window && gtk_widget_get_visible (GTK_WIDGET((tooltip)->current_window)))
Kristian Rietveld's avatar
Kristian Rietveld committed
86 87 88 89


static void       gtk_tooltip_class_init           (GtkTooltipClass *klass);
static void       gtk_tooltip_init                 (GtkTooltip      *tooltip);
Paolo Borelli's avatar
Paolo Borelli committed
90
static void       gtk_tooltip_dispose              (GObject         *object);
Kristian Rietveld's avatar
Kristian Rietveld committed
91

92
static void       gtk_tooltip_window_style_set     (GtkTooltip      *tooltip);
93 94
static gboolean   gtk_tooltip_paint_window         (GtkTooltip      *tooltip,
                                                    cairo_t         *cr);
Kristian Rietveld's avatar
Kristian Rietveld committed
95 96 97 98 99
static void       gtk_tooltip_window_hide          (GtkWidget       *widget,
						    gpointer         user_data);
static void       gtk_tooltip_display_closed       (GdkDisplay      *display,
						    gboolean         was_error,
						    GtkTooltip      *tooltip);
100 101
static void       gtk_tooltip_set_last_window      (GtkTooltip      *tooltip,
						    GdkWindow       *window);
Kristian Rietveld's avatar
Kristian Rietveld committed
102 103 104 105 106 107 108 109 110 111 112


G_DEFINE_TYPE (GtkTooltip, gtk_tooltip, G_TYPE_OBJECT);

static void
gtk_tooltip_class_init (GtkTooltipClass *klass)
{
  GObjectClass *object_class;

  object_class = G_OBJECT_CLASS (klass);

Paolo Borelli's avatar
Paolo Borelli committed
113
  object_class->dispose = gtk_tooltip_dispose;
Kristian Rietveld's avatar
Kristian Rietveld committed
114 115 116 117 118
}

static void
gtk_tooltip_init (GtkTooltip *tooltip)
{
119 120
  GtkStyle *style;

Kristian Rietveld's avatar
Kristian Rietveld committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
  tooltip->timeout_id = 0;
  tooltip->browse_mode_timeout_id = 0;

  tooltip->browse_mode_enabled = FALSE;
  tooltip->keyboard_mode_enabled = FALSE;

  tooltip->current_window = NULL;
  tooltip->keyboard_widget = NULL;

  tooltip->tooltip_widget = NULL;
  tooltip->toplevel_window = NULL;

  tooltip->last_window = NULL;

  tooltip->window = g_object_ref (gtk_window_new (GTK_WINDOW_POPUP));
  gtk_window_set_type_hint (GTK_WINDOW (tooltip->window),
			    GDK_WINDOW_TYPE_HINT_TOOLTIP);
  gtk_widget_set_app_paintable (tooltip->window, TRUE);
  gtk_window_set_resizable (GTK_WINDOW (tooltip->window), FALSE);
  gtk_widget_set_name (tooltip->window, "gtk-tooltip");
  g_signal_connect (tooltip->window, "hide",
		    G_CALLBACK (gtk_tooltip_window_hide), tooltip);

144 145
  style = gtk_widget_get_style (tooltip->window);

Kristian Rietveld's avatar
Kristian Rietveld committed
146 147
  tooltip->alignment = gtk_alignment_new (0.5, 0.5, 1.0, 1.0);
  gtk_alignment_set_padding (GTK_ALIGNMENT (tooltip->alignment),
148 149
                             style->ythickness, style->ythickness,
                             style->xthickness, style->xthickness);
Kristian Rietveld's avatar
Kristian Rietveld committed
150 151 152
  gtk_container_add (GTK_CONTAINER (tooltip->window), tooltip->alignment);
  gtk_widget_show (tooltip->alignment);

153
  g_signal_connect_swapped (tooltip->window, "style-set",
154
			    G_CALLBACK (gtk_tooltip_window_style_set), tooltip);
155
  g_signal_connect_swapped (tooltip->window, "draw",
Kristian Rietveld's avatar
Kristian Rietveld committed
156 157
			    G_CALLBACK (gtk_tooltip_paint_window), tooltip);

158
  tooltip->box = gtk_hbox_new (FALSE, style->xthickness);
Kristian Rietveld's avatar
Kristian Rietveld committed
159 160 161 162 163 164 165 166
  gtk_container_add (GTK_CONTAINER (tooltip->alignment), tooltip->box);
  gtk_widget_show (tooltip->box);

  tooltip->image = gtk_image_new ();
  gtk_box_pack_start (GTK_BOX (tooltip->box), tooltip->image,
		      FALSE, FALSE, 0);

  tooltip->label = gtk_label_new ("");
167
  gtk_label_set_line_wrap (GTK_LABEL (tooltip->label), TRUE);
Kristian Rietveld's avatar
Kristian Rietveld committed
168 169 170 171 172 173 174
  gtk_box_pack_start (GTK_BOX (tooltip->box), tooltip->label,
		      FALSE, FALSE, 0);

  tooltip->custom_widget = NULL;
}

static void
Paolo Borelli's avatar
Paolo Borelli committed
175
gtk_tooltip_dispose (GObject *object)
Kristian Rietveld's avatar
Kristian Rietveld committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
{
  GtkTooltip *tooltip = GTK_TOOLTIP (object);

  if (tooltip->timeout_id)
    {
      g_source_remove (tooltip->timeout_id);
      tooltip->timeout_id = 0;
    }

  if (tooltip->browse_mode_timeout_id)
    {
      g_source_remove (tooltip->browse_mode_timeout_id);
      tooltip->browse_mode_timeout_id = 0;
    }

191
  gtk_tooltip_set_custom (tooltip, NULL);
192 193
  gtk_tooltip_set_last_window (tooltip, NULL);

Kristian Rietveld's avatar
Kristian Rietveld committed
194 195 196 197 198 199 200 201 202
  if (tooltip->window)
    {
      GdkDisplay *display;

      display = gtk_widget_get_display (tooltip->window);
      g_signal_handlers_disconnect_by_func (display,
					    gtk_tooltip_display_closed,
					    tooltip);
      gtk_widget_destroy (tooltip->window);
Paolo Borelli's avatar
Paolo Borelli committed
203
      tooltip->window = NULL;
Kristian Rietveld's avatar
Kristian Rietveld committed
204
    }
Michael Natterer's avatar
Michael Natterer committed
205

Paolo Borelli's avatar
Paolo Borelli committed
206
  G_OBJECT_CLASS (gtk_tooltip_parent_class)->dispose (object);
Kristian Rietveld's avatar
Kristian Rietveld committed
207 208 209 210 211 212
}

/* public API */

/**
 * gtk_tooltip_set_markup:
Matthias Clasen's avatar
Matthias Clasen committed
213
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
214
 * @markup: (allow-none): a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>) or %NULL
Kristian Rietveld's avatar
Kristian Rietveld committed
215
 *
Matthias Clasen's avatar
Matthias Clasen committed
216
 * Sets the text of the tooltip to be @markup, which is marked up
Kristian Rietveld's avatar
Kristian Rietveld committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
 * with the <link
 * linkend="PangoMarkupFormat">Pango text markup language</link>.
 * If @markup is %NULL, the label will be hidden.
 *
 * Since: 2.12
 */
void
gtk_tooltip_set_markup (GtkTooltip  *tooltip,
			const gchar *markup)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

  gtk_label_set_markup (GTK_LABEL (tooltip->label), markup);

  if (markup)
    gtk_widget_show (tooltip->label);
  else
    gtk_widget_hide (tooltip->label);
}

237 238 239
/**
 * gtk_tooltip_set_text:
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
240
 * @text: (allow-none): a text string or %NULL
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
 *
 * Sets the text of the tooltip to be @text. If @text is %NULL, the label
 * will be hidden. See also gtk_tooltip_set_markup().
 *
 * Since: 2.12
 */
void
gtk_tooltip_set_text (GtkTooltip  *tooltip,
                      const gchar *text)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

  gtk_label_set_text (GTK_LABEL (tooltip->label), text);

  if (text)
    gtk_widget_show (tooltip->label);
  else
    gtk_widget_hide (tooltip->label);
}

Kristian Rietveld's avatar
Kristian Rietveld committed
261 262 263
/**
 * gtk_tooltip_set_icon:
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
264
 * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL
Kristian Rietveld's avatar
Kristian Rietveld committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
 *
 * Sets the icon of the tooltip (which is in front of the text) to be
 * @pixbuf.  If @pixbuf is %NULL, the image will be hidden.
 *
 * Since: 2.12
 */
void
gtk_tooltip_set_icon (GtkTooltip *tooltip,
		      GdkPixbuf  *pixbuf)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
  if (pixbuf)
    g_return_if_fail (GDK_IS_PIXBUF (pixbuf));

  gtk_image_set_from_pixbuf (GTK_IMAGE (tooltip->image), pixbuf);

  if (pixbuf)
    gtk_widget_show (tooltip->image);
  else
    gtk_widget_hide (tooltip->image);
}

/**
 * gtk_tooltip_set_icon_from_stock:
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
290
 * @stock_id: (allow-none): a stock id, or %NULL
291
 * @size: (type int): a stock icon size
Kristian Rietveld's avatar
Kristian Rietveld committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
 *
 * Sets the icon of the tooltip (which is in front of the text) to be
 * the stock item indicated by @stock_id with the size indicated
 * by @size.  If @stock_id is %NULL, the image will be hidden.
 *
 * Since: 2.12
 */
void
gtk_tooltip_set_icon_from_stock (GtkTooltip  *tooltip,
				 const gchar *stock_id,
				 GtkIconSize  size)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

  gtk_image_set_from_stock (GTK_IMAGE (tooltip->image), stock_id, size);

  if (stock_id)
    gtk_widget_show (tooltip->image);
  else
    gtk_widget_hide (tooltip->image);
}

Matthias Clasen's avatar
Matthias Clasen committed
314 315 316
/**
 * gtk_tooltip_set_icon_from_icon_name:
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
317
 * @icon_name: (allow-none): an icon name, or %NULL
318
 * @size: (type int): a stock icon size
Matthias Clasen's avatar
Matthias Clasen committed
319 320 321 322 323
 *
 * Sets the icon of the tooltip (which is in front of the text) to be
 * the icon indicated by @icon_name with the size indicated
 * by @size.  If @icon_name is %NULL, the image will be hidden.
 *
324
 * Since: 2.14
Matthias Clasen's avatar
Matthias Clasen committed
325 326
 */
void
327 328 329
gtk_tooltip_set_icon_from_icon_name (GtkTooltip  *tooltip,
				     const gchar *icon_name,
				     GtkIconSize  size)
Matthias Clasen's avatar
Matthias Clasen committed
330 331 332 333 334 335 336
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

  gtk_image_set_from_icon_name (GTK_IMAGE (tooltip->image), icon_name, size);

  if (icon_name)
    gtk_widget_show (tooltip->image);
337 338 339 340 341
  else
    gtk_widget_hide (tooltip->image);
}

/**
342
 * gtk_tooltip_set_icon_from_gicon:
343
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
344
 * @gicon: (allow-none): a #GIcon representing the icon, or %NULL
345
 * @size: (type int): a stock icon size
346 347 348 349
 *
 * Sets the icon of the tooltip (which is in front of the text)
 * to be the icon indicated by @gicon with the size indicated
 * by @size. If @gicon is %NULL, the image will be hidden.
350 351 352 353 354 355 356 357 358 359 360 361 362 363
 *
 * Since: 2.20
 */
void
gtk_tooltip_set_icon_from_gicon (GtkTooltip  *tooltip,
				 GIcon       *gicon,
				 GtkIconSize  size)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

  gtk_image_set_from_gicon (GTK_IMAGE (tooltip->image), gicon, size);

  if (gicon)
    gtk_widget_show (tooltip->image);
Matthias Clasen's avatar
Matthias Clasen committed
364 365 366 367
  else
    gtk_widget_hide (tooltip->image);
}

Kristian Rietveld's avatar
Kristian Rietveld committed
368 369
/**
 * gtk_tooltip_set_custom:
Matthias Clasen's avatar
Matthias Clasen committed
370
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
371
 * @custom_widget: (allow-none): a #GtkWidget, or %NULL to unset the old custom widget.
Kristian Rietveld's avatar
Kristian Rietveld committed
372
 *
373 374 375
 * Replaces the widget packed into the tooltip with
 * @custom_widget. @custom_widget does not get destroyed when the tooltip goes
 * away.
Matthias Clasen's avatar
Matthias Clasen committed
376 377 378
 * By default a box with a #GtkImage and #GtkLabel is embedded in 
 * the tooltip, which can be configured using gtk_tooltip_set_markup() 
 * and gtk_tooltip_set_icon().
379

Kristian Rietveld's avatar
Kristian Rietveld committed
380 381 382 383 384 385 386 387 388 389 390
 *
 * Since: 2.12
 */
void
gtk_tooltip_set_custom (GtkTooltip *tooltip,
			GtkWidget  *custom_widget)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));
  if (custom_widget)
    g_return_if_fail (GTK_IS_WIDGET (custom_widget));

391 392 393 394 395 396 397 398 399
  /* The custom widget has been updated from the query-tooltip
   * callback, so we do not want to reset the custom widget later on.
   */
  tooltip->custom_was_reset = TRUE;

  /* No need to do anything if the custom widget stays the same */
  if (tooltip->custom_widget == custom_widget)
    return;

Kristian Rietveld's avatar
Kristian Rietveld committed
400 401
  if (tooltip->custom_widget)
    {
402 403 404 405 406 407 408 409
      GtkWidget *custom = tooltip->custom_widget;
      /* Note: We must reset tooltip->custom_widget first, 
       * since gtk_container_remove() will recurse into 
       * gtk_tooltip_set_custom()
       */
      tooltip->custom_widget = NULL;
      gtk_container_remove (GTK_CONTAINER (tooltip->box), custom);
      g_object_unref (custom);
Kristian Rietveld's avatar
Kristian Rietveld committed
410 411 412 413 414 415 416 417 418 419 420
    }

  if (custom_widget)
    {
      tooltip->custom_widget = g_object_ref (custom_widget);

      gtk_container_add (GTK_CONTAINER (tooltip->box), custom_widget);
      gtk_widget_show (custom_widget);
    }
}

421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
/**
 * gtk_tooltip_set_tip_area:
 * @tooltip: a #GtkTooltip
 * @rect: a #GdkRectangle
 *
 * Sets the area of the widget, where the contents of this tooltip apply,
 * to be @rect (in widget coordinates).  This is especially useful for
 * properly setting tooltips on #GtkTreeView rows and cells, #GtkIconViews,
 * etc.
 *
 * For setting tooltips on #GtkTreeView, please refer to the convenience
 * functions for this: gtk_tree_view_set_tooltip_row() and
 * gtk_tree_view_set_tooltip_cell().
 *
 * Since: 2.12
 */
void
438 439
gtk_tooltip_set_tip_area (GtkTooltip         *tooltip,
			  const GdkRectangle *rect)
440 441 442 443 444 445 446 447 448 449 450 451
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

  if (!rect)
    tooltip->tip_area_set = FALSE;
  else
    {
      tooltip->tip_area_set = TRUE;
      tooltip->tip_area = *rect;
    }
}

Kristian Rietveld's avatar
Kristian Rietveld committed
452 453
/**
 * gtk_tooltip_trigger_tooltip_query:
454
 * @display: a #GdkDisplay
Kristian Rietveld's avatar
Kristian Rietveld committed
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
 *
 * Triggers a new tooltip query on @display, in order to update the current
 * visible tooltip, or to show/hide the current tooltip.  This function is
 * useful to call when, for example, the state of the widget changed by a
 * key press.
 *
 * Since: 2.12
 */
void
gtk_tooltip_trigger_tooltip_query (GdkDisplay *display)
{
  gint x, y;
  GdkWindow *window;
  GdkEvent event;

  /* Trigger logic as if the mouse moved */
  window = gdk_display_get_window_at_pointer (display, &x, &y);
  if (!window)
    return;

  event.type = GDK_MOTION_NOTIFY;
  event.motion.window = window;
  event.motion.x = x;
  event.motion.y = y;
  event.motion.is_hint = FALSE;

481 482 483
  gdk_window_get_root_coords (window, x, y, &x, &y);
  event.motion.x_root = x;
  event.motion.y_root = y;
484

Kristian Rietveld's avatar
Kristian Rietveld committed
485 486 487 488 489 490 491 492 493 494
  _gtk_tooltip_handle_event (&event);
}

/* private functions */

static void
gtk_tooltip_reset (GtkTooltip *tooltip)
{
  gtk_tooltip_set_markup (tooltip, NULL);
  gtk_tooltip_set_icon (tooltip, NULL);
495
  gtk_tooltip_set_tip_area (tooltip, NULL);
496 497 498 499 500

  /* See if the custom widget is again set from the query-tooltip
   * callback.
   */
  tooltip->custom_was_reset = FALSE;
Kristian Rietveld's avatar
Kristian Rietveld committed
501 502
}

503 504 505
static void
gtk_tooltip_window_style_set (GtkTooltip *tooltip)
{
506 507 508 509
  GtkStyle *style;

  style = gtk_widget_get_style (tooltip->window);

510
  gtk_alignment_set_padding (GTK_ALIGNMENT (tooltip->alignment),
511 512 513
                             style->ythickness, style->ythickness,
                             style->xthickness, style->xthickness);

514
  gtk_box_set_spacing (GTK_BOX (tooltip->box),
515
                       style->xthickness);
516 517 518 519

  gtk_widget_queue_draw (tooltip->window);
}

Kristian Rietveld's avatar
Kristian Rietveld committed
520
static gboolean
521 522
gtk_tooltip_paint_window (GtkTooltip *tooltip,
                          cairo_t    *cr)
Kristian Rietveld's avatar
Kristian Rietveld committed
523
{
524
  gtk_paint_flat_box (gtk_widget_get_style (tooltip->window),
525
		      cr,
Kristian Rietveld's avatar
Kristian Rietveld committed
526 527 528 529 530
		      GTK_STATE_NORMAL,
		      GTK_SHADOW_OUT,
		      tooltip->window,
		      "tooltip",
		      0, 0,
531 532
                      gtk_widget_get_allocated_width (tooltip->window),
                      gtk_widget_get_allocated_height (tooltip->window));
Kristian Rietveld's avatar
Kristian Rietveld committed
533 534 535 536 537 538 539 540 541 542

  return FALSE;
}

static void
gtk_tooltip_window_hide (GtkWidget *widget,
			 gpointer   user_data)
{
  GtkTooltip *tooltip = GTK_TOOLTIP (user_data);

543
  gtk_tooltip_set_custom (tooltip, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
}

/* event handling, etc */

struct ChildLocation
{
  GtkWidget *child;
  GtkWidget *container;

  gint x;
  gint y;
};

static void
child_location_foreach (GtkWidget *child,
			gpointer   data)
{
561
  GtkAllocation child_allocation;
562
  gint x, y;
Kristian Rietveld's avatar
Kristian Rietveld committed
563 564
  struct ChildLocation *child_loc = data;

565
  /* Ignore invisible widgets */
566
  if (!gtk_widget_is_drawable (child))
567 568
    return;

569 570
  gtk_widget_get_allocation (child, &child_allocation);

571 572 573
  x = 0;
  y = 0;

574 575 576 577
  /* (child_loc->x, child_loc->y) are relative to
   * child_loc->container's allocation.
   */

578
  if (!child_loc->child &&
Kristian Rietveld's avatar
Kristian Rietveld committed
579 580
      gtk_widget_translate_coordinates (child_loc->container, child,
					child_loc->x, child_loc->y,
581 582
					&x, &y))
    {
583 584 585
#ifdef DEBUG_TOOLTIP
      g_print ("candidate: %s  alloc=[(%d,%d)  %dx%d]     (%d, %d)->(%d, %d)\n",
	       gtk_widget_get_name (child),
586 587 588 589
               child_allocation.x,
               child_allocation.y,
               child_allocation.width,
               child_allocation.height,
590 591 592 593 594
	       child_loc->x, child_loc->y,
	       x, y);
#endif /* DEBUG_TOOLTIP */

      /* (x, y) relative to child's allocation. */
595 596
      if (x >= 0 && x < child_allocation.width
	  && y >= 0 && y < child_allocation.height)
Kristian Rietveld's avatar
Kristian Rietveld committed
597 598 599 600 601
        {
	  if (GTK_IS_CONTAINER (child))
	    {
	      struct ChildLocation tmp = { NULL, NULL, 0, 0 };

602 603 604
	      /* Take (x, y) relative the child's allocation and
	       * recurse.
	       */
Kristian Rietveld's avatar
Kristian Rietveld committed
605 606 607 608
	      tmp.x = x;
	      tmp.y = y;
	      tmp.container = child;

609 610
	      gtk_container_forall (GTK_CONTAINER (child),
				    child_location_foreach, &tmp);
Kristian Rietveld's avatar
Kristian Rietveld committed
611 612 613 614 615 616 617 618 619 620 621 622

	      if (tmp.child)
		child_loc->child = tmp.child;
	      else
		child_loc->child = child;
	    }
	  else
	    child_loc->child = child;
	}
    }
}

623 624 625
/* Translates coordinates from dest_widget->window relative (src_x, src_y),
 * to allocation relative (dest_x, dest_y) of dest_widget.
 */
Kristian Rietveld's avatar
Kristian Rietveld committed
626 627 628 629 630 631 632
static void
window_to_alloc (GtkWidget *dest_widget,
		 gint       src_x,
		 gint       src_y,
		 gint      *dest_x,
		 gint      *dest_y)
{
633 634 635 636
  GtkAllocation allocation;

  gtk_widget_get_allocation (dest_widget, &allocation);

Kristian Rietveld's avatar
Kristian Rietveld committed
637
  /* Translate from window relative to allocation relative */
638 639
  if (gtk_widget_get_has_window (dest_widget) &&
      gtk_widget_get_parent (dest_widget))
Kristian Rietveld's avatar
Kristian Rietveld committed
640 641
    {
      gint wx, wy;
642 643
      gdk_window_get_position (gtk_widget_get_window (dest_widget),
                               &wx, &wy);
Kristian Rietveld's avatar
Kristian Rietveld committed
644

645 646 647
      /* Offset coordinates if widget->window is smaller than
       * widget->allocation.
       */
648 649
      src_x += wx - allocation.x;
      src_y += wy - allocation.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
650 651 652
    }
  else
    {
653 654
      src_x -= allocation.x;
      src_y -= allocation.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
655 656 657 658 659 660 661 662
    }

  if (dest_x)
    *dest_x = src_x;
  if (dest_y)
    *dest_y = src_y;
}

663 664 665
/* Translates coordinates from window relative (x, y) to
 * allocation relative (x, y) of the returned widget.
 */
666 667 668 669 670 671
GtkWidget *
_gtk_widget_find_at_coords (GdkWindow *window,
                            gint       window_x,
                            gint       window_y,
                            gint      *widget_x,
                            gint      *widget_y)
Kristian Rietveld's avatar
Kristian Rietveld committed
672 673 674 675
{
  GtkWidget *event_widget;
  struct ChildLocation child_loc = { NULL, NULL, 0, 0 };

676 677
  g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);

678 679 680 681 682
  gdk_window_get_user_data (window, (void **)&event_widget);

  if (!event_widget)
    return NULL;

683 684 685
#ifdef DEBUG_TOOLTIP
  g_print ("event window %p (belonging to %p (%s))  (%d, %d)\n",
	   window, event_widget, gtk_widget_get_name (event_widget),
686
	   window_x, window_y);
687 688 689
#endif

  /* Coordinates are relative to event window */
690 691
  child_loc.x = window_x;
  child_loc.y = window_y;
Kristian Rietveld's avatar
Kristian Rietveld committed
692

693 694 695 696
  /* We go down the window hierarchy to the widget->window,
   * coordinates stay relative to the current window.
   * We end up with window == widget->window, coordinates relative to that.
   */
697
  while (window && window != gtk_widget_get_window (event_widget))
698
    {
699
      gdouble px, py;
700

701 702 703 704 705
      gdk_window_coords_to_parent (window,
                                   child_loc.x, child_loc.y,
                                   &px, &py);
      child_loc.x = px;
      child_loc.y = py;
706

707
      window = gdk_window_get_effective_parent (window);
708 709 710 711 712 713 714 715 716 717
    }

  /* Failing to find widget->window can happen for e.g. a detached handle box;
   * chaining ::query-tooltip up to its parent probably makes little sense,
   * and users better implement tooltips on handle_box->child.
   * so we simply ignore the event for tooltips here.
   */
  if (!window)
    return NULL;

718 719 720 721 722 723 724
  /* Convert the window relative coordinates to allocation
   * relative coordinates.
   */
  window_to_alloc (event_widget,
		   child_loc.x, child_loc.y,
		   &child_loc.x, &child_loc.y);

Kristian Rietveld's avatar
Kristian Rietveld committed
725 726
  if (GTK_IS_CONTAINER (event_widget))
    {
727
      GtkWidget *container = event_widget;
Kristian Rietveld's avatar
Kristian Rietveld committed
728 729 730 731

      child_loc.container = event_widget;
      child_loc.child = NULL;

732 733
      gtk_container_forall (GTK_CONTAINER (event_widget),
			    child_location_foreach, &child_loc);
Kristian Rietveld's avatar
Kristian Rietveld committed
734

735 736 737 738
      /* Here we have a widget, with coordinates relative to
       * child_loc.container's allocation.
       */

Kristian Rietveld's avatar
Kristian Rietveld committed
739 740 741 742
      if (child_loc.child)
	event_widget = child_loc.child;
      else if (child_loc.container)
	event_widget = child_loc.container;
743 744 745 746 747

      /* Translate to event_widget's allocation */
      gtk_widget_translate_coordinates (container, event_widget,
					child_loc.x, child_loc.y,
					&child_loc.x, &child_loc.y);
Kristian Rietveld's avatar
Kristian Rietveld committed
748 749
    }

750
  /* We return (x, y) relative to the allocation of event_widget. */
751 752 753 754
  if (widget_x)
    *widget_x = child_loc.x;
  if (widget_y)
    *widget_y = child_loc.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
755 756 757 758

  return event_widget;
}

759 760 761
/* Ignores (x, y) on input, translates event coordinates to
 * allocation relative (x, y) of the returned widget.
 */
Kristian Rietveld's avatar
Kristian Rietveld committed
762 763 764 765 766
static GtkWidget *
find_topmost_widget_coords_from_event (GdkEvent *event,
				       gint     *x,
				       gint     *y)
{
767
  GtkAllocation allocation;
Kristian Rietveld's avatar
Kristian Rietveld committed
768 769 770 771 772 773
  gint tx, ty;
  gdouble dx, dy;
  GtkWidget *tmp;

  gdk_event_get_coords (event, &dx, &dy);

774
  /* Returns coordinates relative to tmp's allocation. */
775
  tmp = _gtk_widget_find_at_coords (event->any.window, dx, dy, &tx, &ty);
Kristian Rietveld's avatar
Kristian Rietveld committed
776

777
  if (!tmp)
778 779
    return NULL;

780
  /* Make sure the pointer can actually be on the widget returned. */
781 782 783
  gtk_widget_get_allocation (tmp, &allocation);
  if (tx < 0 || tx >= allocation.width ||
      ty < 0 || ty >= allocation.height)
784
    return NULL;
785

786 787 788 789
  if (x)
    *x = tx;
  if (y)
    *y = ty;
Kristian Rietveld's avatar
Kristian Rietveld committed
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815

  return tmp;
}

static gint
tooltip_browse_mode_expired (gpointer data)
{
  GtkTooltip *tooltip;

  tooltip = GTK_TOOLTIP (data);

  tooltip->browse_mode_enabled = FALSE;
  tooltip->browse_mode_timeout_id = 0;

  /* destroy tooltip */
  g_object_set_data (G_OBJECT (gtk_widget_get_display (tooltip->window)),
		     "gdk-display-current-tooltip", NULL);

  return FALSE;
}

static void
gtk_tooltip_display_closed (GdkDisplay *display,
			    gboolean    was_error,
			    GtkTooltip *tooltip)
{
816
  g_object_set_data (G_OBJECT (display), "gdk-display-current-tooltip", NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
817 818
}

819 820 821 822
static void
gtk_tooltip_set_last_window (GtkTooltip *tooltip,
			     GdkWindow  *window)
{
823 824 825
  if (tooltip->last_window == window)
    return;

826 827 828 829 830 831 832 833 834 835 836
  if (tooltip->last_window)
    g_object_remove_weak_pointer (G_OBJECT (tooltip->last_window),
				  (gpointer *) &tooltip->last_window);

  tooltip->last_window = window;

  if (window)
    g_object_add_weak_pointer (G_OBJECT (tooltip->last_window),
			       (gpointer *) &tooltip->last_window);
}

Kristian Rietveld's avatar
Kristian Rietveld committed
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
static gboolean
gtk_tooltip_run_requery (GtkWidget  **widget,
			 GtkTooltip  *tooltip,
			 gint        *x,
			 gint        *y)
{
  gboolean has_tooltip = FALSE;
  gboolean return_value = FALSE;

  gtk_tooltip_reset (tooltip);

  do
    {
      g_object_get (*widget,
		    "has-tooltip", &has_tooltip,
		    NULL);

      if (has_tooltip)
	g_signal_emit_by_name (*widget,
			       "query-tooltip",
			       *x, *y,
			       tooltip->keyboard_mode_enabled,
			       tooltip,
			       &return_value);

      if (!return_value)
        {
864
	  GtkWidget *parent = gtk_widget_get_parent (*widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
865 866 867 868 869 870 871 872 873 874 875

	  if (parent)
	    gtk_widget_translate_coordinates (*widget, parent, *x, *y, x, y);

	  *widget = parent;
	}
      else
	break;
    }
  while (*widget);

876 877 878 879 880 881
  /* If the custom widget was not reset in the query-tooltip
   * callback, we clear it here.
   */
  if (!tooltip->custom_was_reset)
    gtk_tooltip_set_custom (tooltip, NULL);

Kristian Rietveld's avatar
Kristian Rietveld committed
882 883 884
  return return_value;
}

885 886 887 888
static void
get_bounding_box (GtkWidget    *widget,
                  GdkRectangle *bounds)
{
889
  GtkAllocation allocation;
890 891 892 893 894 895 896 897 898
  GdkWindow *window;
  gint x, y;
  gint w, h;
  gint x1, y1;
  gint x2, y2;
  gint x3, y3;
  gint x4, y4;

  window = gtk_widget_get_parent_window (widget);
899 900
  if (window == NULL)
    window = gtk_widget_get_window (widget);
901

902 903 904 905 906
  gtk_widget_get_allocation (widget, &allocation);
  x = allocation.x;
  y = allocation.y;
  w = allocation.width;
  h = allocation.height;
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

  gdk_window_get_root_coords (window, x, y, &x1, &y1);
  gdk_window_get_root_coords (window, x + w, y, &x2, &y2);
  gdk_window_get_root_coords (window, x, y + h, &x3, &y3);
  gdk_window_get_root_coords (window, x + w, y + h, &x4, &y4);

#define MIN4(a,b,c,d) MIN(MIN(a,b),MIN(c,d))
#define MAX4(a,b,c,d) MAX(MAX(a,b),MAX(c,d))

  bounds->x = floor (MIN4 (x1, x2, x3, x4));
  bounds->y = floor (MIN4 (y1, y2, y3, y4));
  bounds->width = ceil (MAX4 (x1, x2, x3, x4)) - bounds->x;
  bounds->height = ceil (MAX4 (y1, y2, y3, y4)) - bounds->y;
}

922 923 924 925 926 927 928
static void
gtk_tooltip_position (GtkTooltip *tooltip,
		      GdkDisplay *display,
		      GtkWidget  *new_tooltip_widget)
{
  gint x, y;
  GdkScreen *screen;
Matthias Clasen's avatar
Matthias Clasen committed
929 930 931 932 933 934 935
  gint monitor_num;
  GdkRectangle monitor;
  GtkRequisition requisition;
  guint cursor_size;
  GdkRectangle bounds;

#define MAX_DISTANCE 32
936 937 938

  tooltip->tooltip_widget = new_tooltip_widget;

Matthias Clasen's avatar
Matthias Clasen committed
939 940
  screen = gtk_widget_get_screen (new_tooltip_widget);

941 942
  gtk_widget_get_preferred_size (GTK_WIDGET (tooltip->current_window),
                                 &requisition, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
943 944 945 946 947 948 949 950

  monitor_num = gdk_screen_get_monitor_at_point (screen,
                                                 tooltip->last_x,
                                                 tooltip->last_y);
  gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);

  get_bounding_box (new_tooltip_widget, &bounds);

951
  /* Position the tooltip */
Matthias Clasen's avatar
Matthias Clasen committed
952 953 954 955 956 957 958 959

  cursor_size = gdk_display_get_default_cursor_size (display);

  /* Try below */
  x = bounds.x + bounds.width / 2 - requisition.width / 2;
  y = bounds.y + bounds.height + 4;

  if (y + requisition.height <= monitor.y + monitor.height)
960
    {
Matthias Clasen's avatar
Matthias Clasen committed
961 962
      if (tooltip->keyboard_mode_enabled)
        goto found;
963

Matthias Clasen's avatar
Matthias Clasen committed
964 965 966 967 968 969
      if (y <= tooltip->last_y + cursor_size + MAX_DISTANCE)
        {
          if (tooltip->last_x + cursor_size + MAX_DISTANCE < x)
            x = tooltip->last_x + cursor_size + MAX_DISTANCE;
          else if (x + requisition.width < tooltip->last_x - MAX_DISTANCE)
            x = tooltip->last_x - MAX_DISTANCE - requisition.width;
970

Matthias Clasen's avatar
Matthias Clasen committed
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
          goto found;
        }
   }

  /* Try above */
  x = bounds.x + bounds.width / 2 - requisition.width / 2;
  y = bounds.y - requisition.height - 4;

  if (y >= monitor.y)
    {
      if (tooltip->keyboard_mode_enabled)
        goto found;

      if (y + requisition.height >= tooltip->last_y - MAX_DISTANCE)
        {
          if (tooltip->last_x + cursor_size + MAX_DISTANCE < x)
            x = tooltip->last_x + cursor_size + MAX_DISTANCE;
          else if (x + requisition.width < tooltip->last_x - MAX_DISTANCE)
            x = tooltip->last_x - MAX_DISTANCE - requisition.width;

          goto found;
        }
993
    }
Matthias Clasen's avatar
Matthias Clasen committed
994 995 996 997 998 999

  /* Try right FIXME: flip on rtl ? */
  x = bounds.x + bounds.width + 4;
  y = bounds.y + bounds.height / 2 - requisition.height / 2;

  if (x + requisition.width <= monitor.x + monitor.width)
1000
    {
Matthias Clasen's avatar
Matthias Clasen committed
1001 1002
      if (tooltip->keyboard_mode_enabled)
        goto found;
1003

Matthias Clasen's avatar
Matthias Clasen committed
1004 1005 1006 1007 1008 1009
      if (x <= tooltip->last_x + cursor_size + MAX_DISTANCE)
        {
          if (tooltip->last_y + cursor_size + MAX_DISTANCE < y)
            y = tooltip->last_y + cursor_size + MAX_DISTANCE;
          else if (y + requisition.height < tooltip->last_y - MAX_DISTANCE)
            y = tooltip->last_y - MAX_DISTANCE - requisition.height;
1010

Matthias Clasen's avatar
Matthias Clasen committed
1011 1012
          goto found;
        }
1013 1014
    }

Matthias Clasen's avatar
Matthias Clasen committed
1015 1016 1017
  /* Try left FIXME: flip on rtl ? */
  x = bounds.x - requisition.width - 4;
  y = bounds.y + bounds.height / 2 - requisition.height / 2;
1018

Matthias Clasen's avatar
Matthias Clasen committed
1019
  if (x >= monitor.x)
1020
    {
Matthias Clasen's avatar
Matthias Clasen committed
1021 1022
      if (tooltip->keyboard_mode_enabled)
        goto found;
1023

Matthias Clasen's avatar
Matthias Clasen committed
1024 1025 1026 1027 1028 1029
      if (x + requisition.width >= tooltip->last_x - MAX_DISTANCE)
        {
          if (tooltip->last_y + cursor_size + MAX_DISTANCE < y)
            y = tooltip->last_y + cursor_size + MAX_DISTANCE;
          else if (y + requisition.height < tooltip->last_y - MAX_DISTANCE)
            y = tooltip->last_y - MAX_DISTANCE - requisition.height;
1030

Matthias Clasen's avatar
Matthias Clasen committed
1031 1032 1033
          goto found;
        }
    }
1034

Matthias Clasen's avatar
Matthias Clasen committed
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
   /* Fallback */
  if (tooltip->keyboard_mode_enabled)
    {
      x = bounds.x + bounds.width / 2 - requisition.width / 2;
      y = bounds.y + bounds.height + 4;
    }
  else
    {
      /* At cursor */
      x = tooltip->last_x + cursor_size * 3 / 4;
      y = tooltip->last_y + cursor_size * 3 / 4;
    }

found:
  /* Show it */
  if (tooltip->current_window)
    {
1052 1053 1054 1055 1056 1057 1058
      if (x + requisition.width > monitor.x + monitor.width)
        x -= x - (monitor.x + monitor.width) + requisition.width;
      else if (x < monitor.x)
        x = monitor.x;

      if (y + requisition.height > monitor.y + monitor.height)
        y -= y - (monitor.y + monitor.height) + requisition.height;
Matthias Clasen's avatar
Matthias Clasen committed
1059 1060 1061
      else if (y < monitor.y)
        y = monitor.y;

1062 1063 1064 1065 1066 1067 1068
      if (!tooltip->keyboard_mode_enabled)
        {
          /* don't pop up under the pointer */
          if (x <= tooltip->last_x && tooltip->last_x < x + requisition.width &&
              y <= tooltip->last_y && tooltip->last_y < y + requisition.height)
            y = tooltip->last_y - requisition.height - 2;
        }
Matthias Clasen's avatar
Matthias Clasen committed
1069

1070 1071 1072 1073 1074
      gtk_window_move (GTK_WINDOW (tooltip->current_window), x, y);
      gtk_widget_show (GTK_WIDGET (tooltip->current_window));
    }
}

Kristian Rietveld's avatar
Kristian Rietveld committed
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
static void
gtk_tooltip_show_tooltip (GdkDisplay *display)
{
  gint x, y;
  GdkScreen *screen;

  GdkWindow *window;
  GtkWidget *tooltip_widget;
  GtkWidget *pointer_widget;
  GtkTooltip *tooltip;
  gboolean has_tooltip;
  gboolean return_value = FALSE;

  tooltip = g_object_get_data (G_OBJECT (display),
			       "gdk-display-current-tooltip");

  if (tooltip->keyboard_mode_enabled)
    {
1093
      x = y = -1;
Kristian Rietveld's avatar
Kristian Rietveld committed
1094 1095 1096 1097
      pointer_widget = tooltip_widget = tooltip->keyboard_widget;
    }
  else
    {
1098 1099
      gint tx, ty;

Kristian Rietveld's avatar
Kristian Rietveld committed
1100 1101
      window = tooltip->last_window;

1102 1103 1104
      if (!GDK_IS_WINDOW (window))
	return;

1105 1106 1107 1108 1109
      gdk_window_get_pointer (window, &x, &y, NULL);

      gdk_window_get_root_coords (window, x, y, &tx, &ty);
      tooltip->last_x = tx;
      tooltip->last_y = ty;
Kristian Rietveld's avatar
Kristian Rietveld committed
1110

1111 1112 1113
      pointer_widget = tooltip_widget = _gtk_widget_find_at_coords (window,
                                                                    x, y,
                                                                    &x, &y);
Kristian Rietveld's avatar
Kristian Rietveld committed
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
    }

  if (!tooltip_widget)
    return;

  g_object_get (tooltip_widget, "has-tooltip", &has_tooltip, NULL);

  return_value = gtk_tooltip_run_requery (&tooltip_widget, tooltip, &x, &y);
  if (!return_value)
    return;

  if (!tooltip->current_window)
    {
      if (gtk_widget_get_tooltip_window (tooltip_widget))
	tooltip->current_window = gtk_widget_get_tooltip_window (tooltip_widget);
      else
	tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
    }

  screen = gtk_widget_get_screen (tooltip_widget);

1135
  /* FIXME: should use tooltip->current_window iso tooltip->window */
Kristian Rietveld's avatar
Kristian Rietveld committed
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
  if (screen != gtk_widget_get_screen (tooltip->window))
    {
      g_signal_handlers_disconnect_by_func (display,
					    gtk_tooltip_display_closed,
					    tooltip);

      gtk_window_set_screen (GTK_WINDOW (tooltip->window), screen);

      g_signal_connect (display, "closed",
			G_CALLBACK (gtk_tooltip_display_closed), tooltip);
    }

1148
  gtk_tooltip_position (tooltip, display, tooltip_widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163

  /* Now a tooltip is visible again on the display, make sure browse
   * mode is enabled.
   */
  tooltip->browse_mode_enabled = TRUE;
  if (tooltip->browse_mode_timeout_id)
    {
      g_source_remove (tooltip->browse_mode_timeout_id);
      tooltip->browse_mode_timeout_id = 0;
    }
}

static void
gtk_tooltip_hide_tooltip (GtkTooltip *tooltip)
{
1164
  if (!tooltip)
Kristian Rietveld's avatar
Kristian Rietveld committed
1165 1166 1167 1168 1169 1170 1171 1172
    return;

  if (tooltip->timeout_id)
    {
      g_source_remove (tooltip->timeout_id);
      tooltip->timeout_id = 0;
    }

1173 1174 1175 1176 1177
  if (!GTK_TOOLTIP_VISIBLE (tooltip))
    return;

  tooltip->tooltip_widget = NULL;

Kristian Rietveld's avatar
Kristian Rietveld committed
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
  if (!tooltip->keyboard_mode_enabled)
    {
      guint timeout;
      GtkSettings *settings;

      settings = gtk_widget_get_settings (GTK_WIDGET (tooltip->window));

      g_object_get (settings,
		    "gtk-tooltip-browse-mode-timeout", &timeout,
		    NULL);

      /* The tooltip is gone, after (by default, should be configurable) 500ms
       * we want to turn off browse mode
       */
      if (!tooltip->browse_mode_timeout_id)
	tooltip->browse_mode_timeout_id =
Kristian Rietveld's avatar
Kristian Rietveld committed
1194 1195 1196 1197
	  gdk_threads_add_timeout_full (0, timeout,
					tooltip_browse_mode_expired,
					g_object_ref (tooltip),
					g_object_unref);
Kristian Rietveld's avatar
Kristian Rietveld committed
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
    }
  else
    {
      if (tooltip->browse_mode_timeout_id)
        {
	  g_source_remove (tooltip->browse_mode_timeout_id);
	  tooltip->browse_mode_timeout_id = 0;
	}
    }

  if (tooltip->current_window)
    {
      gtk_widget_hide (GTK_WIDGET (tooltip->current_window));
      tooltip->current_window = NULL;
    }
}

static gint
tooltip_popup_timeout (gpointer data)
{
  GdkDisplay *display;
  GtkTooltip *tooltip;

  display = GDK_DISPLAY_OBJECT (data);
1222 1223 1224 1225 1226 1227 1228 1229
  tooltip = g_object_get_data (G_OBJECT (display),
			       "gdk-display-current-tooltip");

  /* This usually does not happen.  However, it does occur in language
   * bindings were reference counting of objects behaves differently.
   */
  if (!tooltip)
    return FALSE;
Kristian Rietveld's avatar
Kristian Rietveld committed
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

  gtk_tooltip_show_tooltip (display);

  tooltip->timeout_id = 0;

  return FALSE;
}

static void
gtk_tooltip_start_delay (GdkDisplay *display)
{
  guint timeout;
  GtkTooltip *tooltip;
  GtkSettings *settings;

  tooltip = g_object_get_data (G_OBJECT (display),
			       "gdk-display-current-tooltip");

1248
  if (!tooltip || GTK_TOOLTIP_VISIBLE (tooltip))
Kristian Rietveld's avatar
Kristian Rietveld committed
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
    return;

  if (tooltip->timeout_id)
    g_source_remove (tooltip->timeout_id);

  settings = gtk_widget_get_settings (GTK_WIDGET (tooltip->window));

  if (tooltip->browse_mode_enabled)
    g_object_get (settings, "gtk-tooltip-browse-timeout", &timeout, NULL);
  else
    g_object_get (settings, "gtk-tooltip-timeout", &timeout, NULL);

Kristian Rietveld's avatar
Kristian Rietveld committed
1261 1262 1263 1264
  tooltip->timeout_id = gdk_threads_add_timeout_full (0, timeout,
						      tooltip_popup_timeout,
						      g_object_ref (display),
						      g_object_unref);
Kristian Rietveld's avatar
Kristian Rietveld committed
1265 1266 1267 1268 1269 1270 1271 1272 1273
}

void
_gtk_tooltip_focus_in (GtkWidget *widget)
{
  gint x, y;
  gboolean return_value = FALSE;
  GdkDisplay *display;
  GtkTooltip *tooltip;
1274
  GdkDevice *device;
Kristian Rietveld's avatar
Kristian Rietveld committed
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284

  /* Get current tooltip for this display */
  display = gtk_widget_get_display (widget);
  tooltip = g_object_get_data (G_OBJECT (display),
			       "gdk-display-current-tooltip");

  /* Check if keyboard mode is enabled at this moment */
  if (!tooltip || !tooltip->keyboard_mode_enabled)
    return;

1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
  device = gtk_get_current_event_device ();

  if (device && device->source == GDK_SOURCE_KEYBOARD)
    device = gdk_device_get_associated_device (device);

  /* This function should be called by either a focus in event,
   * or a key binding. In either case there should be a device.
   */
  if (!device)
    return;

Kristian Rietveld's avatar
Kristian Rietveld committed
1296 1297 1298 1299 1300
  if (tooltip->keyboard_widget)
    g_object_unref (tooltip->keyboard_widget);

  tooltip->keyboard_widget = g_object_ref (widget);

1301 1302
  gdk_window_get_device_position (gtk_widget_get_window (widget),
                                  device, &x, &y, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360

  return_value = gtk_tooltip_run_requery (&widget, tooltip, &x, &y);
  if (!return_value)
    {
      gtk_tooltip_hide_tooltip (tooltip);
      return;
    }

  if (!tooltip->current_window)
    {
      if (gtk_widget_get_tooltip_window (widget))
	tooltip->current_window = gtk_widget_get_tooltip_window (widget);
      else
	tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
    }

  gtk_tooltip_show_tooltip (display);
}

void
_gtk_tooltip_focus_out (GtkWidget *widget)
{
  GdkDisplay *display;
  GtkTooltip *tooltip;

  /* Get current tooltip for this display */
  display = gtk_widget_get_display (widget);
  tooltip = g_object_get_data (G_OBJECT (display),
			       "gdk-display-current-tooltip");

  if (!tooltip || !tooltip->keyboard_mode_enabled)
    return;

  if (tooltip->keyboard_widget)
    {
      g_object_unref (tooltip->keyboard_widget);
      tooltip->keyboard_widget = NULL;
    }

  gtk_tooltip_hide_tooltip (tooltip);
}

void
_gtk_tooltip_toggle_keyboard_mode (GtkWidget *widget)
{
  GdkDisplay *display;
  GtkTooltip *tooltip;

  display = gtk_widget_get_display (widget);
  tooltip = g_object_get_data (G_OBJECT (display),
			       "gdk-display-current-tooltip");

  if (!tooltip)
    {
      tooltip = g_object_new (GTK_TYPE_TOOLTIP, NULL);
      g_object_set_data_full (G_OBJECT (display),
			      "gdk-display-current-tooltip",
			      tooltip, g_object_unref);
1361 1362 1363
      g_signal_connect (display, "closed",
			G_CALLBACK (gtk_tooltip_display_closed),
			tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
    }

  tooltip->keyboard_mode_enabled ^= 1;

  if (tooltip->keyboard_mode_enabled)
    {
      tooltip->keyboard_widget = g_object_ref (widget);
      _gtk_tooltip_focus_in (widget);
    }
  else
    {
      if (tooltip->keyboard_widget)
        {
	  g_object_unref (tooltip->keyboard_widget);
	  tooltip->keyboard_widget = NULL;
	}

      gtk_tooltip_hide_tooltip (tooltip);
    }
}

void
_gtk_tooltip_hide (GtkWidget *widget)
{
  GtkWidget *toplevel;
  GdkDisplay *display;
  GtkTooltip *tooltip;

  display = gtk_widget_get_display (widget);
  tooltip = g_object_get_data (G_OBJECT (display),
			       "gdk-display-current-tooltip");

  if (!tooltip || !GTK_TOOLTIP_VISIBLE (tooltip) || !tooltip->tooltip_widget)
    return;

  toplevel = gtk_widget_get_toplevel (widget);

  if (widget == tooltip->tooltip_widget
1402
      || gtk_widget_get_window (toplevel) == tooltip->toplevel_window)
Kristian Rietveld's avatar
Kristian Rietveld committed
1403 1404 1405
    gtk_tooltip_hide_tooltip (tooltip);
}

1406 1407 1408 1409 1410 1411 1412 1413
static gboolean
tooltips_enabled (GdkWindow *window)
{
  gboolean enabled;
  gboolean touchscreen;
  GdkScreen *screen;
  GtkSettings *settings;

1414
  screen = gdk_window_get_screen (window);
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
  settings = gtk_settings_get_for_screen (screen);

  g_object_get (settings,
		"gtk-touchscreen-mode", &touchscreen,
		"gtk-enable-tooltips", &enabled,
		NULL);

  return (!touchscreen && enabled);
}

Kristian Rietveld's avatar
Kristian Rietveld committed
1425 1426 1427 1428 1429 1430 1431 1432
void
_gtk_tooltip_handle_event (GdkEvent *event)
{
  gint x, y;
  gboolean return_value = FALSE;
  GtkWidget *has_tooltip_widget = NULL;
  GdkDisplay *display;
  GtkTooltip *current_tooltip;
1433

1434
  if (!tooltips_enabled (event->any.window))
1435
    return;
Kristian Rietveld's avatar
Kristian Rietveld committed
1436

1437
  /* Returns coordinates relative to has_tooltip_widget's allocation. */
Kristian Rietveld's avatar
Kristian Rietveld committed
1438
  has_tooltip_widget = find_topmost_widget_coords_from_event (event, &x, &y);
1439
  display = gdk_window_get_display (event->any.window);
Kristian Rietveld's avatar
Kristian Rietveld committed
1440 1441 1442 1443 1444
  current_tooltip = g_object_get_data (G_OBJECT (display),
				       "gdk-display-current-tooltip");

  if (current_tooltip)
    {
1445
      gtk_tooltip_set_last_window (current_tooltip, event->any.window);
Kristian Rietveld's avatar
Kristian Rietveld committed
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
    }

  if (current_tooltip && current_tooltip->keyboard_mode_enabled)
    {
      has_tooltip_widget = current_tooltip->keyboard_widget;
      if (!has_tooltip_widget)
	return;

      return_value = gtk_tooltip_run_requery (&has_tooltip_widget,
					      current_tooltip,
					      &x, &y);

      if (!return_value)
	gtk_tooltip_hide_tooltip (current_tooltip);
      else
	gtk_tooltip_start_delay (display);

      return;
    }

1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
#ifdef DEBUG_TOOLTIP
  if (has_tooltip_widget)
    g_print ("%p (%s) at (%d, %d) %dx%d     pointer: (%d, %d)\n",
	     has_tooltip_widget, gtk_widget_get_name (has_tooltip_widget),
	     has_tooltip_widget->allocation.x,
	     has_tooltip_widget->allocation.y,
	     has_tooltip_widget->allocation.width,
	     has_tooltip_widget->allocation.height,
	     x, y);
#endif /* DEBUG_TOOLTIP */

Kristian Rietveld's avatar
Kristian Rietveld committed
1477
  /* Always poll for a next motion event */
1478
  gdk_event_request_motions (&event->motion);
Kristian Rietveld's avatar
Kristian Rietveld committed
1479 1480 1481 1482

  /* Hide the tooltip when there's no new tooltip widget */
  if (!has_tooltip_widget)
    {
1483
      if (current_tooltip)
Kristian Rietveld's avatar
Kristian Rietveld committed
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
	gtk_tooltip_hide_tooltip (current_tooltip);

      return;
    }

  switch (event->type)
    {
      case GDK_BUTTON_PRESS:
      case GDK_2BUTTON_PRESS:
      case GDK_3BUTTON_PRESS:
      case GDK_KEY_PRESS:
      case GDK_DRAG_ENTER:
      case GDK_GRAB_BROKEN:
	gtk_tooltip_hide_tooltip (current_tooltip);
	break;

      case GDK_MOTION_NOTIFY:
      case GDK_ENTER_NOTIFY:
      case GDK_LEAVE_NOTIFY:
      case GDK_SCROLL:
	if (current_tooltip)
	  {
1506 1507 1508 1509 1510 1511 1512
	    gboolean tip_area_set;
	    GdkRectangle tip_area;
	    gboolean hide_tooltip;

	    tip_area_set = current_tooltip->tip_area_set;
	    tip_area = current_tooltip->tip_area;

Kristian Rietveld's avatar
Kristian Rietveld committed
1513 1514 1515 1516
	    return_value = gtk_tooltip_run_requery (&has_tooltip_widget,
						    current_tooltip,
						    &x, &y);

1517 1518 1519
	    /* Requested to be hidden? */
	    hide_tooltip = !return_value;

1520 1521 1522
	    /* Leave notify should override the query function */
	    hide_tooltip = (event->type == GDK_LEAVE_NOTIFY);

1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
	    /* Is the pointer above another widget now? */
	    if (GTK_TOOLTIP_VISIBLE (current_tooltip))
	      hide_tooltip |= has_tooltip_widget != current_tooltip->tooltip_widget;

	    /* Did the pointer move out of the previous "context area"? */
	    if (tip_area_set)
	      hide_tooltip |= (x <= tip_area.x
			       || x >= tip_area.x + tip_area.width
			       || y <= tip_area.y
			       || y >= tip_area.y + tip_area.height);

	    if (hide_tooltip)
Kristian Rietveld's avatar
Kristian Rietveld committed
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
	      gtk_tooltip_hide_tooltip (current_tooltip);
	    else
	      gtk_tooltip_start_delay (display);
	  }
	else
	  {
	    /* Need a new tooltip for this display */
	    current_tooltip = g_object_new (GTK_TYPE_TOOLTIP, NULL);
	    g_object_set_data_full (G_OBJECT (display),
				    "gdk-display-current-tooltip",
				    current_tooltip, g_object_unref);
1546 1547 1548
	    g_signal_connect (display, "closed",
			      G_CALLBACK (gtk_tooltip_display_closed),
			      current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1549

1550
	    gtk_tooltip_set_last_window (current_tooltip, event->any.window);
Kristian Rietveld's avatar
Kristian Rietveld committed
1551 1552 1553 1554 1555 1556 1557 1558 1559

	    gtk_tooltip_start_delay (display);
	  }
	break;

      default:
	break;
    }
}