gtktooltip.c 40.8 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
/* 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
Javier Jardón's avatar
Javier Jardón committed
17
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Kristian Rietveld's avatar
Kristian Rietveld committed
18 19
 */

20
#include "config.h"
21

22
#include "gtktooltip.h"
23
#include "gtktooltipprivate.h"
24

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

Kristian Rietveld's avatar
Kristian Rietveld committed
28 29 30 31 32
#include "gtkintl.h"
#include "gtkwindow.h"
#include "gtkmain.h"
#include "gtklabel.h"
#include "gtkimage.h"
Matthias Clasen's avatar
Matthias Clasen committed
33
#include "gtkbox.h"
34
#include "gtksettings.h"
35
#include "gtksizerequest.h"
36
#include "gtkstylecontext.h"
37
#include "gtktooltipwindowprivate.h"
38
#include "gtkwindowprivate.h"
39
#include "gtkwidgetprivate.h"
40
#include "gtkaccessible.h"
Kristian Rietveld's avatar
Kristian Rietveld committed
41

42 43 44
#ifdef GDK_WINDOWING_WAYLAND
#include "wayland/gdkwayland.h"
#endif
45 46 47
#ifdef GDK_WINDOWING_MIR
#include "mir/gdkmir.h"
#endif
48 49


50 51 52 53 54 55 56 57 58 59 60
/**
 * SECTION:gtktooltip
 * @Short_description: Add tips to your widgets
 * @Title: GtkTooltip
 *
 * Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text()
 * or gtk_widget_set_tooltip_markup() without any explicit tooltip object.
 *
 * When you need a tooltip with a little more fancy contents, like adding an
 * image, or you want the tooltip to have different contents per #GtkTreeView
 * row or cell, you will have to do a little more work:
61
 * 
62 63 64 65 66 67 68 69 70
 * - Set the #GtkWidget:has-tooltip property to %TRUE, this will make GTK+
 *   monitor the widget for motion and related events which are needed to
 *   determine when and where to show a tooltip.
 *
 * - Connect to the #GtkWidget::query-tooltip signal.  This signal will be
 *   emitted when a tooltip is supposed to be shown. One of the arguments passed
 *   to the signal handler is a GtkTooltip object. This is the object that we
 *   are about to display as a tooltip, and can be manipulated in your callback
 *   using functions like gtk_tooltip_set_icon(). There are functions for setting
71
 *   the tooltip’s markup, setting an image from a named icon, or even putting in
72 73 74 75
 *   a custom widget.
 *
 *   Return %TRUE from your query-tooltip handler. This causes the tooltip to be
 *   show. If you return %FALSE, it will not be shown.
76 77 78 79
 *
 * In the probably rare case where you want to have even more control over the
 * tooltip that is about to be shown, you can set your own #GtkWindow which
 * will be used as tooltip window.  This works as follows:
80
 * 
81 82 83 84 85 86 87 88
 * - Set #GtkWidget:has-tooltip and connect to #GtkWidget::query-tooltip as before.
 *   Use gtk_widget_set_tooltip_window() to set a #GtkWindow created by you as
 *   tooltip window.
 *
 * - In the #GtkWidget::query-tooltip callback you can access your window using
 *   gtk_widget_get_tooltip_window() and manipulate as you wish. The semantics of
 *   the return value are exactly as before, return %TRUE to show the window,
 *   %FALSE to not show it.
89 90 91
 */


92 93 94
#define HOVER_TIMEOUT          500
#define BROWSE_TIMEOUT         60
#define BROWSE_DISABLE_TIMEOUT 500
Kristian Rietveld's avatar
Kristian Rietveld committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

#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 *box;
  GtkWidget *image;
  GtkWidget *label;
  GtkWidget *custom_widget;

  GtkWindow *current_window;
  GtkWidget *keyboard_widget;

  GtkWidget *tooltip_widget;

  gdouble last_x;
  gdouble last_y;
  GdkWindow *last_window;

  guint timeout_id;
  guint browse_mode_timeout_id;

124 125
  GdkRectangle tip_area;

Kristian Rietveld's avatar
Kristian Rietveld committed
126 127
  guint browse_mode_enabled : 1;
  guint keyboard_mode_enabled : 1;
128
  guint tip_area_set : 1;
129
  guint custom_was_reset : 1;
Kristian Rietveld's avatar
Kristian Rietveld committed
130 131 132 133 134 135 136
};

struct _GtkTooltipClass
{
  GObjectClass parent_class;
};

137
#define GTK_TOOLTIP_VISIBLE(tooltip) ((tooltip)->current_window && gtk_widget_get_visible (GTK_WIDGET((tooltip)->current_window)))
Kristian Rietveld's avatar
Kristian Rietveld committed
138 139 140 141


static void       gtk_tooltip_class_init           (GtkTooltipClass *klass);
static void       gtk_tooltip_init                 (GtkTooltip      *tooltip);
142
static void       gtk_tooltip_dispose              (GObject         *object);
Kristian Rietveld's avatar
Kristian Rietveld committed
143 144 145 146 147 148

static void       gtk_tooltip_window_hide          (GtkWidget       *widget,
						    gpointer         user_data);
static void       gtk_tooltip_display_closed       (GdkDisplay      *display,
						    gboolean         was_error,
						    GtkTooltip      *tooltip);
149 150
static void       gtk_tooltip_set_last_window      (GtkTooltip      *tooltip,
						    GdkWindow       *window);
Kristian Rietveld's avatar
Kristian Rietveld committed
151

152 153
static void       gtk_tooltip_handle_event_internal (GdkEvent        *event);

154 155 156 157 158 159 160 161 162 163
static inline GQuark tooltip_quark (void)
{
  static GQuark quark;

  if G_UNLIKELY (quark == 0)
    quark = g_quark_from_static_string ("gdk-display-current-tooltip");
  return quark;
}

#define quark_current_tooltip tooltip_quark()
Kristian Rietveld's avatar
Kristian Rietveld committed
164 165 166 167 168 169 170 171 172 173

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);

174
  object_class->dispose = gtk_tooltip_dispose;
Kristian Rietveld's avatar
Kristian Rietveld committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
}

static void
gtk_tooltip_init (GtkTooltip *tooltip)
{
  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->last_window = NULL;

193 194 195 196
  tooltip->window = gtk_tooltip_window_new ();
  g_signal_connect (tooltip->window, "hide",
                    G_CALLBACK (gtk_tooltip_window_hide),
                    tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
197 198 199
}

static void
200
gtk_tooltip_dispose (GObject *object)
Kristian Rietveld's avatar
Kristian Rietveld committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
{
  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;
    }

216
  gtk_tooltip_set_custom (tooltip, NULL);
217 218
  gtk_tooltip_set_last_window (tooltip, NULL);

Kristian Rietveld's avatar
Kristian Rietveld committed
219 220 221 222 223 224 225 226 227
  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);
228
      tooltip->window = NULL;
Kristian Rietveld's avatar
Kristian Rietveld committed
229
    }
Michael Natterer's avatar
Michael Natterer committed
230

231
  G_OBJECT_CLASS (gtk_tooltip_parent_class)->dispose (object);
Kristian Rietveld's avatar
Kristian Rietveld committed
232 233 234 235 236 237
}

/* public API */

/**
 * gtk_tooltip_set_markup:
Matthias Clasen's avatar
Matthias Clasen committed
238
 * @tooltip: a #GtkTooltip
239
 * @markup: (allow-none): a markup string (see [Pango markup format][PangoMarkupFormat]) or %NULL
Kristian Rietveld's avatar
Kristian Rietveld committed
240
 *
Matthias Clasen's avatar
Matthias Clasen committed
241
 * Sets the text of the tooltip to be @markup, which is marked up
242
 * with the [Pango text markup language][PangoMarkupFormat].
Kristian Rietveld's avatar
Kristian Rietveld committed
243 244 245 246 247 248 249 250 251 252
 * 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));

253
  gtk_tooltip_window_set_label_markup (GTK_TOOLTIP_WINDOW (tooltip->window), markup);
Kristian Rietveld's avatar
Kristian Rietveld committed
254 255
}

256 257 258
/**
 * gtk_tooltip_set_text:
 * @tooltip: a #GtkTooltip
259
 * @text: (allow-none): a text string or %NULL
260 261 262 263 264 265 266 267 268 269 270 271
 *
 * 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));

272
  gtk_tooltip_window_set_label_text (GTK_TOOLTIP_WINDOW (tooltip->window), text);
273 274
}

Kristian Rietveld's avatar
Kristian Rietveld committed
275 276 277
/**
 * gtk_tooltip_set_icon:
 * @tooltip: a #GtkTooltip
278
 * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL
Kristian Rietveld's avatar
Kristian Rietveld committed
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));
290
  g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
Kristian Rietveld's avatar
Kristian Rietveld committed
291

292
  gtk_tooltip_window_set_image_icon (GTK_TOOLTIP_WINDOW (tooltip->window), pixbuf);
Kristian Rietveld's avatar
Kristian Rietveld committed
293 294 295 296 297
}

/**
 * gtk_tooltip_set_icon_from_stock:
 * @tooltip: a #GtkTooltip
298
 * @stock_id: (allow-none): a stock id, or %NULL
299
 * @size: (type int): a stock icon size (#GtkIconSize)
Kristian Rietveld's avatar
Kristian Rietveld committed
300 301 302 303 304 305
 *
 * 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
306 307
 *
 * Deprecated: 3.10: Use gtk_tooltip_set_icon_from_icon_name() instead.
Kristian Rietveld's avatar
Kristian Rietveld committed
308 309 310 311 312 313 314 315
 */
void
gtk_tooltip_set_icon_from_stock (GtkTooltip  *tooltip,
				 const gchar *stock_id,
				 GtkIconSize  size)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

316 317 318
  gtk_tooltip_window_set_image_icon_from_stock (GTK_TOOLTIP_WINDOW (tooltip->window),
                                                stock_id,
                                                size);
Kristian Rietveld's avatar
Kristian Rietveld committed
319 320
}

321 322 323
/**
 * gtk_tooltip_set_icon_from_icon_name:
 * @tooltip: a #GtkTooltip
324
 * @icon_name: (allow-none): an icon name, or %NULL
325
 * @size: (type int): a stock icon size (#GtkIconSize)
326 327 328 329 330
 *
 * 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.
 *
331
 * Since: 2.14
332 333
 */
void
334 335 336
gtk_tooltip_set_icon_from_icon_name (GtkTooltip  *tooltip,
				     const gchar *icon_name,
				     GtkIconSize  size)
337 338 339
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

340 341 342
  gtk_tooltip_window_set_image_icon_from_name (GTK_TOOLTIP_WINDOW (tooltip->window),
                                               icon_name,
                                               size);
343 344 345
}

/**
346
 * gtk_tooltip_set_icon_from_gicon:
347
 * @tooltip: a #GtkTooltip
348
 * @gicon: (allow-none): a #GIcon representing the icon, or %NULL
349
 * @size: (type int): a stock icon size (#GtkIconSize)
350 351 352 353
 *
 * 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.
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));

364 365 366
  gtk_tooltip_window_set_image_icon_from_gicon (GTK_TOOLTIP_WINDOW (tooltip->window),
                                                gicon,
                                                size);
367 368
}

Kristian Rietveld's avatar
Kristian Rietveld committed
369 370
/**
 * gtk_tooltip_set_custom:
Matthias Clasen's avatar
Matthias Clasen committed
371
 * @tooltip: a #GtkTooltip
372
 * @custom_widget: (allow-none): a #GtkWidget, or %NULL to unset the old custom widget.
Kristian Rietveld's avatar
Kristian Rietveld committed
373
 *
374 375 376
 * 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
377 378 379
 * 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().
380

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

391 392 393 394 395
  /* 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;

396
  gtk_tooltip_window_set_custom_widget (GTK_TOOLTIP_WINDOW (tooltip->window), custom_widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
397 398
}

399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
/**
 * 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
416 417
gtk_tooltip_set_tip_area (GtkTooltip         *tooltip,
			  const GdkRectangle *rect)
418 419 420 421 422 423 424 425 426 427 428 429
{
  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
430 431
/**
 * gtk_tooltip_trigger_tooltip_query:
432
 * @display: a #GdkDisplay
Kristian Rietveld's avatar
Kristian Rietveld committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446
 *
 * 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;
447
  GdkDevice *device;
Kristian Rietveld's avatar
Kristian Rietveld committed
448 449

  /* Trigger logic as if the mouse moved */
450
  device = gdk_seat_get_pointer (gdk_display_get_default_seat (display));
451
  window = gdk_device_get_window_at_position (device, &x, &y);
Kristian Rietveld's avatar
Kristian Rietveld committed
452 453 454 455 456 457 458 459 460
  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;

461 462 463
  gdk_window_get_root_coords (window, x, y, &x, &y);
  event.motion.x_root = x;
  event.motion.y_root = y;
464

465
  gtk_tooltip_handle_event_internal (&event);
Kristian Rietveld's avatar
Kristian Rietveld committed
466 467 468 469 470 471 472 473 474
}

/* private functions */

static void
gtk_tooltip_reset (GtkTooltip *tooltip)
{
  gtk_tooltip_set_markup (tooltip, NULL);
  gtk_tooltip_set_icon (tooltip, NULL);
475
  gtk_tooltip_set_tip_area (tooltip, NULL);
476 477 478 479 480

  /* 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
481 482 483 484 485 486 487 488
}

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

489
  gtk_tooltip_set_custom (tooltip, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
490 491 492 493 494 495 496 497 498 499 500 501 502
}

/* event handling, etc */

struct ChildLocation
{
  GtkWidget *child;
  GtkWidget *container;

  gint x;
  gint y;
};

503 504 505 506 507 508 509 510 511
static void
prepend_and_ref_widget (GtkWidget *widget,
                        gpointer   data)
{
  GSList **slist_p = data;

  *slist_p = g_slist_prepend (*slist_p, g_object_ref (widget));
}

Kristian Rietveld's avatar
Kristian Rietveld committed
512 513 514 515
static void
child_location_foreach (GtkWidget *child,
			gpointer   data)
{
516
  GtkAllocation child_allocation;
517
  gint x, y;
Kristian Rietveld's avatar
Kristian Rietveld committed
518 519
  struct ChildLocation *child_loc = data;

520
  /* Ignore invisible widgets */
521
  if (!gtk_widget_is_drawable (child))
522 523
    return;

524 525
  gtk_widget_get_allocation (child, &child_allocation);

526 527 528
  x = 0;
  y = 0;

529 530 531 532
  /* (child_loc->x, child_loc->y) are relative to
   * child_loc->container's allocation.
   */

533
  if (!child_loc->child &&
Kristian Rietveld's avatar
Kristian Rietveld committed
534 535
      gtk_widget_translate_coordinates (child_loc->container, child,
					child_loc->x, child_loc->y,
536 537
					&x, &y))
    {
538
      /* (x, y) relative to child's allocation. */
539 540
      if (x >= 0 && x < child_allocation.width
	  && y >= 0 && y < child_allocation.height)
Kristian Rietveld's avatar
Kristian Rietveld committed
541 542 543 544
        {
	  if (GTK_IS_CONTAINER (child))
	    {
	      struct ChildLocation tmp = { NULL, NULL, 0, 0 };
545
              GSList *children = NULL, *tmp_list;
Kristian Rietveld's avatar
Kristian Rietveld committed
546

547 548 549
	      /* Take (x, y) relative the child's allocation and
	       * recurse.
	       */
Kristian Rietveld's avatar
Kristian Rietveld committed
550 551 552 553
	      tmp.x = x;
	      tmp.y = y;
	      tmp.container = child;

554
	      gtk_container_forall (GTK_CONTAINER (child),
555 556 557 558 559 560 561
				    prepend_and_ref_widget, &children);

              for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
                {
                  child_location_foreach (tmp_list->data, &tmp);
                  g_object_unref (tmp_list->data);
                }
Kristian Rietveld's avatar
Kristian Rietveld committed
562 563 564 565 566

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

              g_slist_free (children);
Kristian Rietveld's avatar
Kristian Rietveld committed
569 570 571 572 573 574 575
	    }
	  else
	    child_loc->child = child;
	}
    }
}

576 577 578
/* 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
579 580 581 582 583 584 585
static void
window_to_alloc (GtkWidget *dest_widget,
		 gint       src_x,
		 gint       src_y,
		 gint      *dest_x,
		 gint      *dest_y)
{
586 587 588 589
  GtkAllocation allocation;

  gtk_widget_get_allocation (dest_widget, &allocation);

Kristian Rietveld's avatar
Kristian Rietveld committed
590
  /* Translate from window relative to allocation relative */
591 592
  if (gtk_widget_get_has_window (dest_widget) &&
      gtk_widget_get_parent (dest_widget))
Kristian Rietveld's avatar
Kristian Rietveld committed
593 594
    {
      gint wx, wy;
595 596
      gdk_window_get_position (gtk_widget_get_window (dest_widget),
                               &wx, &wy);
Kristian Rietveld's avatar
Kristian Rietveld committed
597

598 599 600
      /* Offset coordinates if widget->window is smaller than
       * widget->allocation.
       */
601 602
      src_x += wx - allocation.x;
      src_y += wy - allocation.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
603 604 605
    }
  else
    {
606 607
      src_x -= allocation.x;
      src_y -= allocation.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
608 609 610 611 612 613 614 615
    }

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

616 617 618
/* Translates coordinates from window relative (x, y) to
 * allocation relative (x, y) of the returned widget.
 */
619 620 621 622 623 624
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
625 626 627 628
{
  GtkWidget *event_widget;
  struct ChildLocation child_loc = { NULL, NULL, 0, 0 };

629 630
  g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);

631 632 633 634 635
  gdk_window_get_user_data (window, (void **)&event_widget);

  if (!event_widget)
    return NULL;

636
  /* Coordinates are relative to event window */
637 638
  child_loc.x = window_x;
  child_loc.y = window_y;
Kristian Rietveld's avatar
Kristian Rietveld committed
639

640 641 642 643
  /* 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.
   */
644
  while (window && window != gtk_widget_get_window (event_widget))
645
    {
646
      gdouble px, py;
647

648 649 650 651 652
      gdk_window_coords_to_parent (window,
                                   child_loc.x, child_loc.y,
                                   &px, &py);
      child_loc.x = px;
      child_loc.y = py;
653

654
      window = gdk_window_get_effective_parent (window);
655 656 657 658 659 660 661 662 663 664
    }

  /* 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;

665 666 667 668 669 670 671
  /* 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
672 673
  if (GTK_IS_CONTAINER (event_widget))
    {
674
      GtkWidget *container = event_widget;
Kristian Rietveld's avatar
Kristian Rietveld committed
675 676 677 678

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

679 680
      gtk_container_forall (GTK_CONTAINER (event_widget),
			    child_location_foreach, &child_loc);
Kristian Rietveld's avatar
Kristian Rietveld committed
681

682 683 684 685
      /* Here we have a widget, with coordinates relative to
       * child_loc.container's allocation.
       */

Kristian Rietveld's avatar
Kristian Rietveld committed
686 687 688 689
      if (child_loc.child)
	event_widget = child_loc.child;
      else if (child_loc.container)
	event_widget = child_loc.container;
690 691 692 693 694

      /* 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
695 696
    }

697
  /* We return (x, y) relative to the allocation of event_widget. */
698 699 700 701
  if (widget_x)
    *widget_x = child_loc.x;
  if (widget_y)
    *widget_y = child_loc.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
702 703 704 705

  return event_widget;
}

706 707 708
/* Ignores (x, y) on input, translates event coordinates to
 * allocation relative (x, y) of the returned widget.
 */
Kristian Rietveld's avatar
Kristian Rietveld committed
709 710 711 712 713
static GtkWidget *
find_topmost_widget_coords_from_event (GdkEvent *event,
				       gint     *x,
				       gint     *y)
{
714
  GtkAllocation allocation;
Kristian Rietveld's avatar
Kristian Rietveld committed
715 716 717 718 719 720
  gint tx, ty;
  gdouble dx, dy;
  GtkWidget *tmp;

  gdk_event_get_coords (event, &dx, &dy);

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

724
  if (!tmp)
725 726
    return NULL;

727
  /* Make sure the pointer can actually be on the widget returned. */
728
  gtk_widget_get_allocation (tmp, &allocation);
729 730 731 732 733 734 735 736 737 738 739 740 741 742
  allocation.x = 0;
  allocation.y = 0;
  if (GTK_IS_WINDOW (tmp))
    {
      GtkBorder border;
      _gtk_window_get_shadow_width (GTK_WINDOW (tmp), &border);
      allocation.x = border.left;
      allocation.y = border.top;
      allocation.width -= border.left + border.right;
      allocation.height -= border.top + border.bottom;
    }

  if (tx < allocation.x || tx >= allocation.width ||
      ty < allocation.y || ty >= allocation.height)
743
    return NULL;
744

745 746 747 748
  if (x)
    *x = tx;
  if (y)
    *y = ty;
Kristian Rietveld's avatar
Kristian Rietveld committed
749 750 751 752 753 754 755 756

  return tmp;
}

static gint
tooltip_browse_mode_expired (gpointer data)
{
  GtkTooltip *tooltip;
757
  GdkDisplay *display;
Kristian Rietveld's avatar
Kristian Rietveld committed
758 759 760 761 762 763 764

  tooltip = GTK_TOOLTIP (data);

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

  /* destroy tooltip */
765 766
  display = gtk_widget_get_display (tooltip->window);
  g_object_set_qdata (G_OBJECT (display), quark_current_tooltip, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
767 768 769 770 771 772 773 774 775

  return FALSE;
}

static void
gtk_tooltip_display_closed (GdkDisplay *display,
			    gboolean    was_error,
			    GtkTooltip *tooltip)
{
776
  g_object_set_qdata (G_OBJECT (display), quark_current_tooltip, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
777 778
}

779 780 781 782
static void
gtk_tooltip_set_last_window (GtkTooltip *tooltip,
			     GdkWindow  *window)
{
783 784
  GtkWidget *window_widget = NULL;

785 786 787
  if (tooltip->last_window == window)
    return;

788 789 790 791 792 793
  if (tooltip->last_window)
    g_object_remove_weak_pointer (G_OBJECT (tooltip->last_window),
				  (gpointer *) &tooltip->last_window);

  tooltip->last_window = window;

Matthias Clasen's avatar
Matthias Clasen committed
794
  if (tooltip->last_window)
795 796
    g_object_add_weak_pointer (G_OBJECT (tooltip->last_window),
			       (gpointer *) &tooltip->last_window);
797 798 799 800 801 802 803 804 805

  if (window)
    gdk_window_get_user_data (window, (gpointer *) &window_widget);

  if (window_widget)
    window_widget = gtk_widget_get_toplevel (window_widget);

  if (window_widget &&
      window_widget != tooltip->window &&
806 807
      gtk_widget_is_toplevel (window_widget) &&
      GTK_IS_WINDOW (window_widget))
808 809 810 811
    gtk_window_set_transient_for (GTK_WINDOW (tooltip->window),
                                  GTK_WINDOW (window_widget));
  else
    gtk_window_set_transient_for (GTK_WINDOW (tooltip->window), NULL);
812 813
}

Kristian Rietveld's avatar
Kristian Rietveld committed
814 815 816 817 818 819 820 821 822 823 824 825 826
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
    {
827
      has_tooltip = gtk_widget_get_has_tooltip (*widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
828 829

      if (has_tooltip)
830
        return_value = gtk_widget_query_tooltip (*widget, *x, *y, tooltip->keyboard_mode_enabled, tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
831 832 833

      if (!return_value)
        {
834
	  GtkWidget *parent = gtk_widget_get_parent (*widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
835 836 837 838 839 840 841 842 843 844 845

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

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

846 847 848 849 850 851
  /* 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
852 853 854
  return return_value;
}

855 856 857 858
static void
get_bounding_box (GtkWidget    *widget,
                  GdkRectangle *bounds)
{
859
  GtkAllocation allocation;
860
  GtkBorder border = { 0, };
861 862 863 864 865 866 867 868 869
  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);
870 871
  if (window == NULL)
    window = gtk_widget_get_window (widget);
872

873
  gtk_widget_get_allocation (widget, &allocation);
874 875 876 877 878 879
  if (GTK_IS_WINDOW (widget))
    _gtk_window_get_shadow_width (GTK_WINDOW (widget), &border);
  x = allocation.x + border.left;
  y = allocation.y + border.right;
  w = allocation.width - border.left - border.right;
  h = allocation.height - border.top - border.bottom;
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894

  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;
}

895 896 897 898 899
static void
gtk_tooltip_position (GtkTooltip *tooltip,
		      GdkDisplay *display,
		      GtkWidget  *new_tooltip_widget)
{
900
  gint x, y, width, height;
901 902
  GdkMonitor *monitor;
  GdkRectangle workarea;
903 904
  guint cursor_size;
  GdkRectangle bounds;
905
  GtkBorder border;
906 907

#define MAX_DISTANCE 32
908

909
  gtk_widget_realize (GTK_WIDGET (tooltip->current_window));
910
  gtk_widget_set_visible (GTK_WIDGET (tooltip->current_window), TRUE);
911

912 913
  tooltip->tooltip_widget = new_tooltip_widget;

914 915 916 917
  _gtk_window_get_shadow_width (GTK_WINDOW (tooltip->current_window), &border);

  width = gtk_widget_get_allocated_width (GTK_WIDGET (tooltip->current_window)) - border.left - border.right;
  height = gtk_widget_get_allocated_height (GTK_WIDGET (tooltip->current_window)) - border.top - border.bottom;
918

919 920
  monitor = gdk_display_get_monitor_at_point (display, tooltip->last_x, tooltip->last_y);
  gdk_monitor_get_workarea (monitor, &workarea);
921 922 923

  get_bounding_box (new_tooltip_widget, &bounds);

924
  /* Position the tooltip */
925 926 927 928

  cursor_size = gdk_display_get_default_cursor_size (display);

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

932
  if (y + height <= workarea.y + workarea.height)
933
    {
934 935
      if (tooltip->keyboard_mode_enabled)
        goto found;
936

937 938 939 940
      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;
941 942
          else if (x + width < tooltip->last_x - MAX_DISTANCE)
            x = tooltip->last_x - MAX_DISTANCE - width;
943

944 945 946 947 948
          goto found;
        }
   }

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

952
  if (y >= workarea.y)
953 954 955 956
    {
      if (tooltip->keyboard_mode_enabled)
        goto found;

957
      if (y + height >= tooltip->last_y - MAX_DISTANCE)
958 959 960
        {
          if (tooltip->last_x + cursor_size + MAX_DISTANCE < x)
            x = tooltip->last_x + cursor_size + MAX_DISTANCE;
961 962
          else if (x + width < tooltip->last_x - MAX_DISTANCE)
            x = tooltip->last_x - MAX_DISTANCE - width;
963 964 965

          goto found;
        }
966
    }
967 968 969

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

972
  if (x + width <= workarea.x + workarea.width)
973
    {
974 975
      if (tooltip->keyboard_mode_enabled)
        goto found;
976

977 978 979 980
      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;
981 982
          else if (y + height < tooltip->last_y - MAX_DISTANCE)
            y = tooltip->last_y - MAX_DISTANCE - height;
983

984 985
          goto found;
        }
986 987
    }

988
  /* Try left FIXME: flip on rtl ? */
989 990
  x = bounds.x - width - 4;
  y = bounds.y + bounds.height / 2 - height / 2;
991

992
  if (x >= workarea.x)
993
    {
994 995
      if (tooltip->keyboard_mode_enabled)
        goto found;
996

997
      if (x + width >= tooltip->last_x - MAX_DISTANCE)
998 999 1000
        {
          if (tooltip->last_y + cursor_size + MAX_DISTANCE < y)
            y = tooltip->last_y + cursor_size + MAX_DISTANCE;
1001 1002
          else if (y + height < tooltip->last_y - MAX_DISTANCE)
            y = tooltip->last_y - MAX_DISTANCE - height;
1003

1004 1005 1006
          goto found;
        }
    }
1007

1008 1009 1010
   /* Fallback */
  if (tooltip->keyboard_mode_enabled)
    {
1011
      x = bounds.x + bounds.width / 2 - width / 2;
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
      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 */
1023 1024 1025 1026 1027 1028 1029 1030 1031
  if (x + width > workarea.x + workarea.width)
    x -= x - (workarea.x + workarea.width) + width;
  else if (x < workarea.x)
    x = workarea.x;

  if (y + height > workarea.y + workarea.height)
    y -= y - (workarea.y + workarea.height) + height;
  else if (y < workarea.y)
    y = workarea.y;
1032

1033 1034 1035 1036 1037 1038 1039
  if (!tooltip->keyboard_mode_enabled)
    {
      /* don't pop up under the pointer */
      if (x <= tooltip->last_x && tooltip->last_x < x + width &&
          y <= tooltip->last_y && tooltip->last_y < y + height)
        y = tooltip->last_y - height - 2;
    }
1040

1041
#ifdef GDK_WINDOWING_WAYLAND
1042 1043 1044 1045 1046 1047
  /* set the transient parent on the tooltip when running with the Wayland
   * backend to allow correct positioning of the tooltip windows
   */
  if (GDK_IS_WAYLAND_DISPLAY (display))
    {
      GtkWidget *toplevel;
1048

1049 1050 1051 1052 1053
      toplevel = gtk_widget_get_toplevel (tooltip->tooltip_widget);
      if (GTK_IS_WINDOW (toplevel))
        gtk_window_set_transient_for (GTK_WINDOW (tooltip->current_window),
                                      GTK_WINDOW (toplevel));
    }
1054
#endif
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
#ifdef GDK_WINDOWING_MIR
      /* Set the transient parent on the tooltip when running with the Mir
       * backend to allow correct positioning of the tooltip windows */
      if (GDK_IS_MIR_DISPLAY (display))
        {
          GtkWidget *toplevel;

          toplevel = gtk_widget_get_toplevel (tooltip->tooltip_widget);
          if (GTK_IS_WINDOW (toplevel))
            gtk_window_set_transient_for (GTK_WINDOW (tooltip->current_window),
                                          GTK_WINDOW (toplevel));
        }
#endif
1068

1069 1070
  x -= border.left;
  y -= border.top;
1071

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

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

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

1087
  tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1088 1089 1090

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

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

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

1104
      device = gdk_seat_get_pointer (gdk_display_get_default_seat (display));
1105 1106

      gdk_window_get_device_position (window, device, &x, &y, NULL);
1107 1108 1109 1110

      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
1111

1112
      tooltip_widget = _gtk_widget_find_at_coords (window, x, y, &x, &y);
Kristian Rietveld's avatar
Kristian Rietveld committed
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
    }

  if (!tooltip_widget)
    return;

  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))
1125
        tooltip->current_window = gtk_widget_get_tooltip_window (tooltip_widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
1126
      else
1127
        tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
Kristian Rietveld's avatar
Kristian Rietveld committed
1128 1129 1130 1131
    }

  screen = gtk_widget_get_screen (tooltip_widget);

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

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

      g_signal_connect (display, "closed",
1142
                        G_CALLBACK (gtk_tooltip_display_closed), tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1143 1144
    }

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

  /* 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)
{
1161
  if (!tooltip)
Kristian Rietveld's avatar
Kristian Rietveld committed
1162 1163 1164 1165 1166 1167 1168 1169
    return;

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

1170 1171 1172 1173 1174
  if (!GTK_TOOLTIP_VISIBLE (tooltip))
    return;

  tooltip->tooltip_widget = NULL;

Kristian Rietveld's avatar
Kristian Rietveld committed
1175 1176
  if (!tooltip->keyboard_mode_enabled)
    {
1177
      guint timeout = BROWSE_DISABLE_TIMEOUT;
Kristian Rietveld's avatar
Kristian Rietveld committed
1178 1179 1180 1181 1182

      /* The tooltip is gone, after (by default, should be configurable) 500ms
       * we want to turn off browse mode
       */
      if (!tooltip->browse_mode_timeout_id)
1183 1184 1185 1186 1187 1188 1189 1190
        {
	  tooltip->browse_mode_timeout_id =
	    gdk_threads_add_timeout_full (0, timeout,
					  tooltip_browse_mode_expired,
					  g_object_ref (tooltip),
					  g_object_unref);
	  g_source_set_name_by_id (tooltip->browse_mode_timeout_id, "[gtk+] tooltip_browse_mode_expired");
	}
Kristian Rietveld's avatar
Kristian Rietveld committed
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
    }
  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;

1214
  display = GDK_DISPLAY (data);
1215
  tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
1216 1217 1218 1219 1220 1221

  /* 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
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235

  gtk_tooltip_show_tooltip (display);

  tooltip->timeout_id = 0;

  return FALSE;
}

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

1236
  tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1237

1238
  if (!tooltip || GTK_TOOLTIP_VISIBLE (tooltip))
Kristian Rietveld's avatar
Kristian Rietveld committed
1239 1240 1241 1242 1243 1244
    return;

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

  if (tooltip->browse_mode_enabled)
1245
    timeout = BROWSE_TIMEOUT;
Kristian Rietveld's avatar
Kristian Rietveld committed
1246
  else
1247
    timeout = HOVER_TIMEOUT;
Kristian Rietveld's avatar
Kristian Rietveld committed
1248

1249 1250 1251 1252
  tooltip->timeout_id = gdk_threads_add_timeout_full (0, timeout,
						      tooltip_popup_timeout,
						      g_object_ref (display),
						      g_object_unref);
1253
  g_source_set_name_by_id (tooltip->timeout_id, "[gtk+] tooltip_popup_timeout");
Kristian Rietveld's avatar
Kristian Rietveld committed
1254 1255 1256 1257 1258 1259 1260 1261 1262
}

void
_gtk_tooltip_focus_in (GtkWidget *widget)
{
  gint x, y;
  gboolean return_value = FALSE;
  GdkDisplay *display;
  GtkTooltip *tooltip;
1263
  GdkDevice *device;
Kristian Rietveld's avatar
Kristian Rietveld committed
1264 1265 1266

  /* Get current tooltip for this display */
  display = gtk_widget_get_display (widget);
1267
  tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1268 1269 1270 1271 1272

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

1273 1274
  device = gtk_get_current_event_device ();

1275
  if (device && gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1276 1277 1278 1279 1280 1281 1282 1283
    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
1284 1285 1286 1287 1288
  if (tooltip->keyboard_widget)
    g_object_unref (tooltip->keyboard_widget);

  tooltip->keyboard_widget = g_object_ref (widget);

1289 1290
  gdk_window_get_device_position (gtk_widget_get_window (widget),
                                  device, &x, &y, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317

  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);
1318
  tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338

  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);
1339
  tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1340 1341 1342 1343

  if (!tooltip)
    {
      tooltip = g_object_new (GTK_TYPE_TOOLTIP, NULL);
1344 1345 1346 1347
      g_object_set_qdata_full (G_OBJECT (display),
			       quark_current_tooltip,
			       tooltip,
                               g_object_unref);
1348 1349 1350
      g_signal_connect (display, "closed",
			G_CALLBACK (gtk_tooltip_display_closed),
			tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
    }

  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)
{
  GdkDisplay *display;
  GtkTooltip *tooltip;

  display = gtk_widget_get_display (widget);
1379
  tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1380 1381 1382 1383

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

1384
  if (widget == tooltip->tooltip_widget)
Kristian Rietveld's avatar
Kristian Rietveld committed
1385 1386 1387
    gtk_tooltip_hide_tooltip (tooltip);
}

1388
static gboolean
1389
tooltips_enabled (GdkEvent *event)
1390
{
1391 1392
  GdkDevice *source_device;
  GdkInputSource source;
1393

1394 1395 1396 1397 1398 1399
  source_device = gdk_event_get_source_device (event);

  if (!source_device)
    return FALSE;

  source = gdk_device_get_source (source_device);
1400

1401
  if (source != GDK_SOURCE_TOUCHSCREEN)
1402 1403 1404
    return TRUE;

  return FALSE;
1405 1406
}

Kristian Rietveld's avatar
Kristian Rietveld committed
1407 1408
void
_gtk_tooltip_handle_event (GdkEvent *event)
1409 1410 1411 1412 1413 1414 1415 1416 1417
{
  if (!tooltips_enabled (event))
    return;

  gtk_tooltip_handle_event_internal (event);
}

static void
gtk_tooltip_handle_event_internal (GdkEvent *event)
Kristian Rietveld's avatar
Kristian Rietveld committed
1418 1419 1420 1421 1422 1423
{
  gint x, y;
  gboolean return_value = FALSE;
  GtkWidget *has_tooltip_widget = NULL;
  GdkDisplay *display;
  GtkTooltip *current_tooltip;
1424

1425
  /* Returns coordinates relative to has_tooltip_widget's allocation. */
Kristian Rietveld's avatar
Kristian Rietveld committed
1426
  has_tooltip_widget = find_topmost_widget_coords_from_event (event, &x, &y);
1427
  display = gdk_window_get_display (event->any.window);
1428
  current_tooltip = g_object_get_qdata (G_OBJECT (display), quark_current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1429 1430 1431

  if (current_tooltip)
    {
1432
      gtk_tooltip_set_last_window (current_tooltip, event->any.window);
Kristian Rietveld's avatar
Kristian Rietveld committed
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
    }

  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;
    }

  /* Always poll for a next motion event */
1454
  gdk_event_request_motions (&event->motion);
Kristian Rietveld's avatar
Kristian Rietveld committed
1455 1456 1457 1458

  /* Hide the tooltip when there's no new tooltip widget */
  if (!has_tooltip_widget)
    {
1459
      if (current_tooltip)
Kristian Rietveld's avatar
Kristian Rietveld committed
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
	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:
1473
      case GDK_SCROLL:
Kristian Rietveld's avatar
Kristian Rietveld committed
1474 1475 1476 1477 1478 1479 1480 1481
	gtk_tooltip_hide_tooltip (current_tooltip);
	break;

      case GDK_MOTION_NOTIFY:
      case GDK_ENTER_NOTIFY:
      case GDK_LEAVE_NOTIFY:
	if (current_tooltip)
	  {
1482 1483 1484 1485 1486 1487 1488
	    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
1489 1490 1491 1492
	    return_value = gtk_tooltip_run_requery (&has_tooltip_widget,
						    current_tooltip,
						    &x, &y);

1493 1494 1495
	    /* Requested to be hidden? */
	    hide_tooltip = !return_value;

1496 1497 1498
	    /* Leave notify should override the query function */
	    hide_tooltip = (event->type == GDK_LEAVE_NOTIFY);

1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
	    /* 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
1511 1512 1513 1514 1515 1516 1517 1518
	      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);
1519 1520 1521 1522
	    g_object_set_qdata_full (G_OBJECT (display),
				     quark_current_tooltip,
				     current_tooltip,
                                     g_object_unref);
1523 1524 1525
	    g_signal_connect (display, "closed",
			      G_CALLBACK (gtk_tooltip_display_closed),
			      current_tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1526

1527
	    gtk_tooltip_set_last_window (current_tooltip, event->any.window);
Kristian Rietveld's avatar
Kristian Rietveld committed
1528 1529 1530 1531 1532 1533 1534 1535 1536

	    gtk_tooltip_start_delay (display);
	  }
	break;

      default:
	break;
    }
}