gtktooltip.c 45.5 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 23
#include "gtktooltip.h"

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

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

Matthias Clasen's avatar
Matthias Clasen committed
38

39 40 41 42 43
#ifdef GDK_WINDOWING_WAYLAND
#include "wayland/gdkwayland.h"
#endif


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
/**
 * 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:
 * <itemizedlist>
 * <listitem>
 * <para>
 * 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.
 * </para>
 * </listitem>
 * <listitem>
 * <para>
 * 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
70
 * the tooltip's markup, setting an image from a named icon, or even putting in
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
 * a custom widget.
 * </para>
 * </listitem>
 * <listitem>
 * <para>
 * Return %TRUE from your query-tooltip handler. This causes the tooltip to be
 * show. If you return %FALSE, it will not be shown.
 * </para>
 * </listitem>
 * </itemizedlist>
 *
 * 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:
 * <itemizedlist>
 * <listitem>
 * <para>
 * Set #GtkWidget:has-tooltip and connect to #GtkWidget::query-tooltip as
 * before.
 * </para>
 * </listitem>
 * <listitem>
 * <para>
 * Use gtk_widget_set_tooltip_window() to set a #GtkWindow created by you as
 * tooltip window.
 * </para>
 * </listitem>
 * <listitem>
 * <para>
 * 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.
 * </para>
 * </listitem>
 * </itemizedlist>
 */


110 111
#undef DEBUG_TOOLTIP

Kristian Rietveld's avatar
Kristian Rietveld committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

#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;
  GdkWindow *toplevel_window;

  gdouble last_x;
  gdouble last_y;
  GdkWindow *last_window;

  guint timeout_id;
  guint browse_mode_timeout_id;

142 143
  GdkRectangle tip_area;

Kristian Rietveld's avatar
Kristian Rietveld committed
144 145
  guint browse_mode_enabled : 1;
  guint keyboard_mode_enabled : 1;
146
  guint tip_area_set : 1;
147
  guint custom_was_reset : 1;
Kristian Rietveld's avatar
Kristian Rietveld committed
148 149 150 151 152 153 154
};

struct _GtkTooltipClass
{
  GObjectClass parent_class;
};

155
#define GTK_TOOLTIP_VISIBLE(tooltip) ((tooltip)->current_window && gtk_widget_get_visible (GTK_WIDGET((tooltip)->current_window)))
Kristian Rietveld's avatar
Kristian Rietveld committed
156 157 158 159


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

162 163
static gboolean   gtk_tooltip_paint_window         (GtkTooltip      *tooltip,
                                                    cairo_t         *cr);
164 165
static void       gtk_tooltip_realize_window       (GtkTooltip      *tooltip,
                                                    GtkWidget       *widget);
166 167
static void       gtk_tooltip_composited_changed   (GtkTooltip      *tooltip,
                                                    GtkWidget       *widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
168 169 170 171 172
static void       gtk_tooltip_window_hide          (GtkWidget       *widget,
						    gpointer         user_data);
static void       gtk_tooltip_display_closed       (GdkDisplay      *display,
						    gboolean         was_error,
						    GtkTooltip      *tooltip);
173 174
static void       gtk_tooltip_set_last_window      (GtkTooltip      *tooltip,
						    GdkWindow       *window);
Kristian Rietveld's avatar
Kristian Rietveld committed
175 176 177 178 179 180 181 182 183 184 185


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
186
  object_class->dispose = gtk_tooltip_dispose;
Kristian Rietveld's avatar
Kristian Rietveld committed
187 188 189 190 191
}

static void
gtk_tooltip_init (GtkTooltip *tooltip)
{
192
  GtkStyleContext *context;
Matthias Clasen's avatar
Matthias Clasen committed
193 194 195 196
  GtkWidget *window;
  GtkWidget *box;
  GtkWidget *image;
  GtkWidget *label;
197 198
  GdkScreen *screen;
  GdkVisual *visual;
199

Kristian Rietveld's avatar
Kristian Rietveld committed
200 201 202 203 204 205 206 207 208 209 210 211 212 213
  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;

214
  window = gtk_window_new (GTK_WINDOW_POPUP);
215 216 217 218 219 220
  screen = gtk_widget_get_screen (window);
  visual = gdk_screen_get_rgba_visual (screen);

  if (visual != NULL)
    gtk_widget_set_visual (window, visual);

Matthias Clasen's avatar
Matthias Clasen committed
221 222 223 224 225 226
  gtk_window_set_type_hint (GTK_WINDOW (window), GDK_WINDOW_TYPE_HINT_TOOLTIP);
  gtk_widget_set_app_paintable (window, TRUE);
  gtk_window_set_resizable (GTK_WINDOW (window), FALSE);
  gtk_widget_set_name (window, "gtk-tooltip");
  g_signal_connect (window, "hide",
                    G_CALLBACK (gtk_tooltip_window_hide), tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
227

Matthias Clasen's avatar
Matthias Clasen committed
228
  context = gtk_widget_get_style_context (window);
229 230
  gtk_style_context_add_class (context, GTK_STYLE_CLASS_TOOLTIP);

Matthias Clasen's avatar
Matthias Clasen committed
231 232
  g_signal_connect_swapped (window, "draw",
                            G_CALLBACK (gtk_tooltip_paint_window), tooltip);
233 234 235
  g_signal_connect_swapped (window, "realize",
                            G_CALLBACK (gtk_tooltip_realize_window), tooltip);
  g_signal_connect_swapped (window, "composited-changed",
236
                            G_CALLBACK (gtk_tooltip_composited_changed), tooltip);
Matthias Clasen's avatar
Matthias Clasen committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

  /* FIXME: don't hardcode the padding */
  box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);
  gtk_widget_set_margin_left (box, 6);
  gtk_widget_set_margin_right (box, 6);
  gtk_widget_set_margin_top (box, 6);
  gtk_widget_set_margin_bottom (box, 6);
  gtk_container_add (GTK_CONTAINER (window), box);
  gtk_widget_show (box);

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

  label = gtk_label_new ("");
  gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
  gtk_box_pack_start (GTK_BOX (box), label, FALSE, FALSE, 0);

  tooltip->window = window;
  tooltip->box = box;
  tooltip->image = image;
  tooltip->label = label;
Kristian Rietveld's avatar
Kristian Rietveld committed
258 259 260 261
  tooltip->custom_widget = NULL;
}

static void
Paolo Borelli's avatar
Paolo Borelli committed
262
gtk_tooltip_dispose (GObject *object)
Kristian Rietveld's avatar
Kristian Rietveld committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
{
  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;
    }

278
  gtk_tooltip_set_custom (tooltip, NULL);
279 280
  gtk_tooltip_set_last_window (tooltip, NULL);

Kristian Rietveld's avatar
Kristian Rietveld committed
281 282 283 284 285 286 287 288 289
  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
290
      tooltip->window = NULL;
Kristian Rietveld's avatar
Kristian Rietveld committed
291
    }
Michael Natterer's avatar
Michael Natterer committed
292

Paolo Borelli's avatar
Paolo Borelli committed
293
  G_OBJECT_CLASS (gtk_tooltip_parent_class)->dispose (object);
Kristian Rietveld's avatar
Kristian Rietveld committed
294 295 296 297 298 299
}

/* public API */

/**
 * gtk_tooltip_set_markup:
Matthias Clasen's avatar
Matthias Clasen committed
300
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
301
 * @markup: (allow-none): a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>) or %NULL
Kristian Rietveld's avatar
Kristian Rietveld committed
302
 *
Matthias Clasen's avatar
Matthias Clasen committed
303
 * Sets the text of the tooltip to be @markup, which is marked up
Kristian Rietveld's avatar
Kristian Rietveld committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
 * 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);
}

324 325 326
/**
 * gtk_tooltip_set_text:
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
327
 * @text: (allow-none): a text string or %NULL
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
 *
 * 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
348 349 350
/**
 * gtk_tooltip_set_icon:
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
351
 * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL
Kristian Rietveld's avatar
Kristian Rietveld committed
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
 *
 * 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
377
 * @stock_id: (allow-none): a stock id, or %NULL
378
 * @size: (type int): a stock icon size
Kristian Rietveld's avatar
Kristian Rietveld committed
379 380 381 382 383 384
 *
 * 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
385 386
 *
 * Deprecated: 3.10: Use gtk_tooltip_set_icon_from_icon_name() instead.
Kristian Rietveld's avatar
Kristian Rietveld committed
387 388 389 390 391 392 393 394
 */
void
gtk_tooltip_set_icon_from_stock (GtkTooltip  *tooltip,
				 const gchar *stock_id,
				 GtkIconSize  size)
{
  g_return_if_fail (GTK_IS_TOOLTIP (tooltip));

395
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
Kristian Rietveld's avatar
Kristian Rietveld committed
396
  gtk_image_set_from_stock (GTK_IMAGE (tooltip->image), stock_id, size);
397
  G_GNUC_END_IGNORE_DEPRECATIONS;
Kristian Rietveld's avatar
Kristian Rietveld committed
398 399 400 401 402 403 404

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

Matthias Clasen's avatar
Matthias Clasen committed
405 406 407
/**
 * gtk_tooltip_set_icon_from_icon_name:
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
408
 * @icon_name: (allow-none): an icon name, or %NULL
409
 * @size: (type int): a stock icon size
Matthias Clasen's avatar
Matthias Clasen committed
410 411 412 413 414
 *
 * 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.
 *
415
 * Since: 2.14
Matthias Clasen's avatar
Matthias Clasen committed
416 417
 */
void
418 419 420
gtk_tooltip_set_icon_from_icon_name (GtkTooltip  *tooltip,
				     const gchar *icon_name,
				     GtkIconSize  size)
Matthias Clasen's avatar
Matthias Clasen committed
421 422 423 424 425 426 427
{
  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);
428 429 430 431 432
  else
    gtk_widget_hide (tooltip->image);
}

/**
433
 * gtk_tooltip_set_icon_from_gicon:
434
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
435
 * @gicon: (allow-none): a #GIcon representing the icon, or %NULL
436
 * @size: (type int): a stock icon size
437 438 439 440
 *
 * 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.
441 442 443 444 445 446 447 448 449 450 451 452 453 454
 *
 * 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
455 456 457 458
  else
    gtk_widget_hide (tooltip->image);
}

Kristian Rietveld's avatar
Kristian Rietveld committed
459 460
/**
 * gtk_tooltip_set_custom:
Matthias Clasen's avatar
Matthias Clasen committed
461
 * @tooltip: a #GtkTooltip
Johan Dahlin's avatar
Johan Dahlin committed
462
 * @custom_widget: (allow-none): a #GtkWidget, or %NULL to unset the old custom widget.
Kristian Rietveld's avatar
Kristian Rietveld committed
463
 *
464 465 466
 * 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
467 468 469
 * 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().
470

Kristian Rietveld's avatar
Kristian Rietveld committed
471 472 473 474 475 476 477 478 479 480 481
 *
 * 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));

482 483 484 485 486 487 488 489 490
  /* 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
491 492
  if (tooltip->custom_widget)
    {
493 494 495 496 497 498 499 500
      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
501 502 503 504 505 506 507 508 509 510 511
    }

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

512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
/**
 * 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
529 530
gtk_tooltip_set_tip_area (GtkTooltip         *tooltip,
			  const GdkRectangle *rect)
531 532 533 534 535 536 537 538 539 540 541 542
{
  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
543 544
/**
 * gtk_tooltip_trigger_tooltip_query:
545
 * @display: a #GdkDisplay
Kristian Rietveld's avatar
Kristian Rietveld committed
546 547 548 549 550 551 552 553 554 555 556 557 558 559
 *
 * 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;
560
  GdkDevice *device;
Kristian Rietveld's avatar
Kristian Rietveld committed
561 562

  /* Trigger logic as if the mouse moved */
563
  device = gdk_device_manager_get_client_pointer (gdk_display_get_device_manager (display));
564
  window = gdk_device_get_window_at_position (device, &x, &y);
Kristian Rietveld's avatar
Kristian Rietveld committed
565 566 567 568 569 570 571 572 573
  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;

574 575 576
  gdk_window_get_root_coords (window, x, y, &x, &y);
  event.motion.x_root = x;
  event.motion.y_root = y;
577

Kristian Rietveld's avatar
Kristian Rietveld committed
578 579 580 581 582 583 584 585 586 587
  _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);
588
  gtk_tooltip_set_tip_area (tooltip, NULL);
589 590 591 592 593

  /* 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
594 595
}

596 597 598
static void
paint_background_and_frame (GtkTooltip *tooltip,
                            cairo_t *cr)
Kristian Rietveld's avatar
Kristian Rietveld committed
599
{
600
  GtkStyleContext *context;
601
  gint width, height;
602

603 604
  width = gtk_widget_get_allocated_width (tooltip->window);
  height = gtk_widget_get_allocated_height (tooltip->window);
605 606
  context = gtk_widget_get_style_context (tooltip->window);

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
  gtk_render_background (context, cr,
                         0, 0, width, height);
  gtk_render_frame (context, cr,
                    0, 0, width, height);  
}

static void
maybe_update_shape (GtkTooltip *tooltip)
{
  cairo_t *cr;
  cairo_surface_t *surface;
  cairo_region_t *region;

  /* fallback to XShape only for non-composited clients */
  if (gtk_widget_is_composited (tooltip->window))
    {
      gtk_widget_shape_combine_region (tooltip->window, NULL);
      return;
    }

  surface = gdk_window_create_similar_surface (gtk_widget_get_window (tooltip->window),
                                               CAIRO_CONTENT_COLOR_ALPHA,
                                               gtk_widget_get_allocated_width (tooltip->window),
                                               gtk_widget_get_allocated_height (tooltip->window));

  cr = cairo_create (surface);
  paint_background_and_frame (tooltip, cr);
  cairo_destroy (cr);

  region = gdk_cairo_region_create_from_surface (surface);
  gtk_widget_shape_combine_region (tooltip->window, region);

  cairo_surface_destroy (surface);
  cairo_region_destroy (region);
}

643 644 645 646 647 648 649 650
static void
gtk_tooltip_composited_changed (GtkTooltip *tooltip,
                                GtkWidget  *widget)
{
  if (gtk_widget_get_realized (tooltip->window))
    maybe_update_shape (tooltip);
}

651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
static void
gtk_tooltip_realize_window (GtkTooltip *tooltip,
                            GtkWidget *widget)
{
  maybe_update_shape (tooltip);
}

static gboolean
gtk_tooltip_paint_window (GtkTooltip *tooltip,
                          cairo_t    *cr)
{
  if (gtk_widget_is_composited (tooltip->window))
    {
      /* clear any background */
      cairo_save (cr);
      cairo_set_source_rgba (cr, 0, 0, 0, 0);
      cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
      cairo_paint (cr);
      cairo_restore (cr);
    }

  maybe_update_shape (tooltip);
  paint_background_and_frame (tooltip, cr);
Kristian Rietveld's avatar
Kristian Rietveld committed
674 675 676 677 678 679 680 681 682 683

  return FALSE;
}

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

684
  gtk_tooltip_set_custom (tooltip, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
685 686 687 688 689 690 691 692 693 694 695 696 697
}

/* event handling, etc */

struct ChildLocation
{
  GtkWidget *child;
  GtkWidget *container;

  gint x;
  gint y;
};

698 699 700 701 702 703 704 705 706
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
707 708 709 710
static void
child_location_foreach (GtkWidget *child,
			gpointer   data)
{
711
  GtkAllocation child_allocation;
712
  gint x, y;
Kristian Rietveld's avatar
Kristian Rietveld committed
713 714
  struct ChildLocation *child_loc = data;

715
  /* Ignore invisible widgets */
716
  if (!gtk_widget_is_drawable (child))
717 718
    return;

719 720
  gtk_widget_get_allocation (child, &child_allocation);

721 722 723
  x = 0;
  y = 0;

724 725 726 727
  /* (child_loc->x, child_loc->y) are relative to
   * child_loc->container's allocation.
   */

728
  if (!child_loc->child &&
Kristian Rietveld's avatar
Kristian Rietveld committed
729 730
      gtk_widget_translate_coordinates (child_loc->container, child,
					child_loc->x, child_loc->y,
731 732
					&x, &y))
    {
733 734 735
#ifdef DEBUG_TOOLTIP
      g_print ("candidate: %s  alloc=[(%d,%d)  %dx%d]     (%d, %d)->(%d, %d)\n",
	       gtk_widget_get_name (child),
736 737 738 739
               child_allocation.x,
               child_allocation.y,
               child_allocation.width,
               child_allocation.height,
740 741 742 743 744
	       child_loc->x, child_loc->y,
	       x, y);
#endif /* DEBUG_TOOLTIP */

      /* (x, y) relative to child's allocation. */
745 746
      if (x >= 0 && x < child_allocation.width
	  && y >= 0 && y < child_allocation.height)
Kristian Rietveld's avatar
Kristian Rietveld committed
747 748 749 750
        {
	  if (GTK_IS_CONTAINER (child))
	    {
	      struct ChildLocation tmp = { NULL, NULL, 0, 0 };
751
              GSList *children = NULL, *tmp_list;
Kristian Rietveld's avatar
Kristian Rietveld committed
752

753 754 755
	      /* Take (x, y) relative the child's allocation and
	       * recurse.
	       */
Kristian Rietveld's avatar
Kristian Rietveld committed
756 757 758 759
	      tmp.x = x;
	      tmp.y = y;
	      tmp.container = child;

760
	      gtk_container_forall (GTK_CONTAINER (child),
761 762 763 764 765 766 767
				    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
768 769 770 771 772

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

              g_slist_free (children);
Kristian Rietveld's avatar
Kristian Rietveld committed
775 776 777 778 779 780 781
	    }
	  else
	    child_loc->child = child;
	}
    }
}

782 783 784
/* 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
785 786 787 788 789 790 791
static void
window_to_alloc (GtkWidget *dest_widget,
		 gint       src_x,
		 gint       src_y,
		 gint      *dest_x,
		 gint      *dest_y)
{
792 793 794 795
  GtkAllocation allocation;

  gtk_widget_get_allocation (dest_widget, &allocation);

Kristian Rietveld's avatar
Kristian Rietveld committed
796
  /* Translate from window relative to allocation relative */
797 798
  if (gtk_widget_get_has_window (dest_widget) &&
      gtk_widget_get_parent (dest_widget))
Kristian Rietveld's avatar
Kristian Rietveld committed
799 800
    {
      gint wx, wy;
801 802
      gdk_window_get_position (gtk_widget_get_window (dest_widget),
                               &wx, &wy);
Kristian Rietveld's avatar
Kristian Rietveld committed
803

804 805 806
      /* Offset coordinates if widget->window is smaller than
       * widget->allocation.
       */
807 808
      src_x += wx - allocation.x;
      src_y += wy - allocation.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
809 810 811
    }
  else
    {
812 813
      src_x -= allocation.x;
      src_y -= allocation.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
814 815 816 817 818 819 820 821
    }

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

822 823 824
/* Translates coordinates from window relative (x, y) to
 * allocation relative (x, y) of the returned widget.
 */
825 826 827 828 829 830
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
831 832 833 834
{
  GtkWidget *event_widget;
  struct ChildLocation child_loc = { NULL, NULL, 0, 0 };

835 836
  g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);

837 838 839 840 841
  gdk_window_get_user_data (window, (void **)&event_widget);

  if (!event_widget)
    return NULL;

842 843 844
#ifdef DEBUG_TOOLTIP
  g_print ("event window %p (belonging to %p (%s))  (%d, %d)\n",
	   window, event_widget, gtk_widget_get_name (event_widget),
845
	   window_x, window_y);
846 847 848
#endif

  /* Coordinates are relative to event window */
849 850
  child_loc.x = window_x;
  child_loc.y = window_y;
Kristian Rietveld's avatar
Kristian Rietveld committed
851

852 853 854 855
  /* 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.
   */
856
  while (window && window != gtk_widget_get_window (event_widget))
857
    {
858
      gdouble px, py;
859

860 861 862 863 864
      gdk_window_coords_to_parent (window,
                                   child_loc.x, child_loc.y,
                                   &px, &py);
      child_loc.x = px;
      child_loc.y = py;
865

866
      window = gdk_window_get_effective_parent (window);
867 868 869 870 871 872 873 874 875 876
    }

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

877 878 879 880 881 882 883
  /* 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
884 885
  if (GTK_IS_CONTAINER (event_widget))
    {
886
      GtkWidget *container = event_widget;
Kristian Rietveld's avatar
Kristian Rietveld committed
887 888 889 890

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

891 892
      gtk_container_forall (GTK_CONTAINER (event_widget),
			    child_location_foreach, &child_loc);
Kristian Rietveld's avatar
Kristian Rietveld committed
893

894 895 896 897
      /* Here we have a widget, with coordinates relative to
       * child_loc.container's allocation.
       */

Kristian Rietveld's avatar
Kristian Rietveld committed
898 899 900 901
      if (child_loc.child)
	event_widget = child_loc.child;
      else if (child_loc.container)
	event_widget = child_loc.container;
902 903 904 905 906

      /* 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
907 908
    }

909
  /* We return (x, y) relative to the allocation of event_widget. */
910 911 912 913
  if (widget_x)
    *widget_x = child_loc.x;
  if (widget_y)
    *widget_y = child_loc.y;
Kristian Rietveld's avatar
Kristian Rietveld committed
914 915 916 917

  return event_widget;
}

918 919 920
/* Ignores (x, y) on input, translates event coordinates to
 * allocation relative (x, y) of the returned widget.
 */
Kristian Rietveld's avatar
Kristian Rietveld committed
921 922 923 924 925
static GtkWidget *
find_topmost_widget_coords_from_event (GdkEvent *event,
				       gint     *x,
				       gint     *y)
{
926
  GtkAllocation allocation;
Kristian Rietveld's avatar
Kristian Rietveld committed
927 928 929 930 931 932
  gint tx, ty;
  gdouble dx, dy;
  GtkWidget *tmp;

  gdk_event_get_coords (event, &dx, &dy);

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

936
  if (!tmp)
937 938
    return NULL;

939
  /* Make sure the pointer can actually be on the widget returned. */
940 941 942
  gtk_widget_get_allocation (tmp, &allocation);
  if (tx < 0 || tx >= allocation.width ||
      ty < 0 || ty >= allocation.height)
943
    return NULL;
944

945 946 947 948
  if (x)
    *x = tx;
  if (y)
    *y = ty;
Kristian Rietveld's avatar
Kristian Rietveld committed
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974

  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)
{
975
  g_object_set_data (G_OBJECT (display), "gdk-display-current-tooltip", NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
976 977
}

978 979 980 981
static void
gtk_tooltip_set_last_window (GtkTooltip *tooltip,
			     GdkWindow  *window)
{
982 983 984
  if (tooltip->last_window == window)
    return;

985 986 987 988 989 990 991 992 993 994 995
  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
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
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)
        {
1023
	  GtkWidget *parent = gtk_widget_get_parent (*widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034

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

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

1035 1036 1037 1038 1039 1040
  /* 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
1041 1042 1043
  return return_value;
}

1044 1045 1046 1047
static void
get_bounding_box (GtkWidget    *widget,
                  GdkRectangle *bounds)
{
1048
  GtkAllocation allocation;
1049 1050 1051 1052 1053 1054 1055 1056 1057
  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);
1058 1059
  if (window == NULL)
    window = gtk_widget_get_window (widget);
1060

1061 1062 1063 1064 1065
  gtk_widget_get_allocation (widget, &allocation);
  x = allocation.x;
  y = allocation.y;
  w = allocation.width;
  h = allocation.height;
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080

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

1081 1082 1083 1084 1085
static void
gtk_tooltip_position (GtkTooltip *tooltip,
		      GdkDisplay *display,
		      GtkWidget  *new_tooltip_widget)
{
1086
  gint x, y, width, height;
1087
  GdkScreen *screen;
Matthias Clasen's avatar
Matthias Clasen committed
1088 1089 1090 1091 1092 1093
  gint monitor_num;
  GdkRectangle monitor;
  guint cursor_size;
  GdkRectangle bounds;

#define MAX_DISTANCE 32
1094

1095 1096
  gtk_widget_realize (GTK_WIDGET (tooltip->current_window));

1097 1098
  tooltip->tooltip_widget = new_tooltip_widget;

Matthias Clasen's avatar
Matthias Clasen committed
1099 1100
  screen = gtk_widget_get_screen (new_tooltip_widget);

1101 1102
  width = gtk_widget_get_allocated_width (GTK_WIDGET (tooltip->current_window));
  height = gtk_widget_get_allocated_height (GTK_WIDGET (tooltip->current_window));
Matthias Clasen's avatar
Matthias Clasen committed
1103 1104 1105 1106

  monitor_num = gdk_screen_get_monitor_at_point (screen,
                                                 tooltip->last_x,
                                                 tooltip->last_y);
1107
  gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
Matthias Clasen's avatar
Matthias Clasen committed
1108 1109 1110

  get_bounding_box (new_tooltip_widget, &bounds);

1111
  /* Position the tooltip */
Matthias Clasen's avatar
Matthias Clasen committed
1112 1113 1114 1115

  cursor_size = gdk_display_get_default_cursor_size (display);

  /* Try below */
1116
  x = bounds.x + bounds.width / 2 - width / 2;
Matthias Clasen's avatar
Matthias Clasen committed
1117 1118
  y = bounds.y + bounds.height + 4;

1119
  if (y + height <= monitor.y + monitor.height)
1120
    {
Matthias Clasen's avatar
Matthias Clasen committed
1121 1122
      if (tooltip->keyboard_mode_enabled)
        goto found;
1123

Matthias Clasen's avatar
Matthias Clasen committed
1124 1125 1126 1127
      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;
1128 1129
          else if (x + width < tooltip->last_x - MAX_DISTANCE)
            x = tooltip->last_x - MAX_DISTANCE - width;
1130

Matthias Clasen's avatar
Matthias Clasen committed
1131 1132 1133 1134 1135
          goto found;
        }
   }

  /* Try above */
1136 1137
  x = bounds.x + bounds.width / 2 - width / 2;
  y = bounds.y - height - 4;
Matthias Clasen's avatar
Matthias Clasen committed
1138 1139 1140 1141 1142 1143

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

1144
      if (y + height >= tooltip->last_y - MAX_DISTANCE)
Matthias Clasen's avatar
Matthias Clasen committed
1145 1146 1147
        {
          if (tooltip->last_x + cursor_size + MAX_DISTANCE < x)
            x = tooltip->last_x + cursor_size + MAX_DISTANCE;
1148 1149
          else if (x + width < tooltip->last_x - MAX_DISTANCE)
            x = tooltip->last_x - MAX_DISTANCE - width;
Matthias Clasen's avatar
Matthias Clasen committed
1150 1151 1152

          goto found;
        }
1153
    }
Matthias Clasen's avatar
Matthias Clasen committed
1154 1155 1156

  /* Try right FIXME: flip on rtl ? */
  x = bounds.x + bounds.width + 4;
1157
  y = bounds.y + bounds.height / 2 - height / 2;
Matthias Clasen's avatar
Matthias Clasen committed
1158

1159
  if (x + width <= monitor.x + monitor.width)
1160
    {
Matthias Clasen's avatar
Matthias Clasen committed
1161 1162
      if (tooltip->keyboard_mode_enabled)
        goto found;
1163

Matthias Clasen's avatar
Matthias Clasen committed
1164 1165 1166 1167
      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;
1168 1169
          else if (y + height < tooltip->last_y - MAX_DISTANCE)
            y = tooltip->last_y - MAX_DISTANCE - height;
1170

Matthias Clasen's avatar
Matthias Clasen committed
1171 1172
          goto found;
        }
1173 1174
    }

Matthias Clasen's avatar
Matthias Clasen committed
1175
  /* Try left FIXME: flip on rtl ? */
1176 1177
  x = bounds.x - width - 4;
  y = bounds.y + bounds.height / 2 - height / 2;
1178

Matthias Clasen's avatar
Matthias Clasen committed
1179
  if (x >= monitor.x)
1180
    {
Matthias Clasen's avatar
Matthias Clasen committed
1181 1182
      if (tooltip->keyboard_mode_enabled)
        goto found;
1183

1184
      if (x + width >= tooltip->last_x - MAX_DISTANCE)
Matthias Clasen's avatar
Matthias Clasen committed
1185 1186 1187
        {
          if (tooltip->last_y + cursor_size + MAX_DISTANCE < y)
            y = tooltip->last_y + cursor_size + MAX_DISTANCE;
1188 1189
          else if (y + height < tooltip->last_y - MAX_DISTANCE)
            y = tooltip->last_y - MAX_DISTANCE - height;
1190

Matthias Clasen's avatar
Matthias Clasen committed
1191 1192 1193
          goto found;
        }
    }
1194

Matthias Clasen's avatar
Matthias Clasen committed
1195 1196 1197
   /* Fallback */
  if (tooltip->keyboard_mode_enabled)
    {
1198
      x = bounds.x + bounds.width / 2 - width / 2;
Matthias Clasen's avatar
Matthias Clasen committed
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
      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)
    {
1212 1213
      if (x + width > monitor.x + monitor.width)
        x -= x - (monitor.x + monitor.width) + width;
1214 1215 1216
      else if (x < monitor.x)
        x = monitor.x;

1217 1218
      if (y + height > monitor.y + monitor.height)
        y -= y - (monitor.y + monitor.height) + height;
Matthias Clasen's avatar
Matthias Clasen committed
1219 1220 1221
      else if (y < monitor.y)
        y = monitor.y;

1222 1223 1224
      if (!tooltip->keyboard_mode_enabled)
        {
          /* don't pop up under the pointer */
1225 1226 1227
          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;
1228
        }
Matthias Clasen's avatar
Matthias Clasen committed
1229

1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
#ifdef GDK_WINDOWING_WAYLAND
      /* 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;

          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

1244 1245 1246 1247 1248
      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
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
static void
gtk_tooltip_show_tooltip (GdkDisplay *display)
{
  gint x, y;
  GdkScreen *screen;

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

  tooltip = g_object_get_data (G_OBJECT (display),
Matthias Clasen's avatar
Matthias Clasen committed
1262
                               "gdk-display-current-tooltip");
Kristian Rietveld's avatar
Kristian Rietveld committed
1263 1264 1265

  if (tooltip->keyboard_mode_enabled)
    {
1266
      x = y = -1;
Matthias Clasen's avatar
Matthias Clasen committed
1267
      tooltip_widget = tooltip->keyboard_widget;
Kristian Rietveld's avatar
Kristian Rietveld committed
1268 1269 1270
    }
  else
    {
1271
      GdkDevice *device;
1272 1273
      gint tx, ty;

Kristian Rietveld's avatar
Kristian Rietveld committed
1274 1275
      window = tooltip->last_window;

1276
      if (!GDK_IS_WINDOW (window))
Matthias Clasen's avatar
Matthias Clasen committed
1277
        return;
1278

1279 1280 1281
      device = gdk_device_manager_get_client_pointer (gdk_display_get_device_manager (display));

      gdk_window_get_device_position (window, device, &x, &y, NULL);
1282 1283 1284 1285

      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
1286

Matthias Clasen's avatar
Matthias Clasen committed
1287
      tooltip_widget = _gtk_widget_find_at_coords (window, x, y, &x, &y);
Kristian Rietveld's avatar
Kristian Rietveld committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
    }

  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))
Matthias Clasen's avatar
Matthias Clasen committed
1302
        tooltip->current_window = gtk_widget_get_tooltip_window (tooltip_widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
1303
      else
Matthias Clasen's avatar
Matthias Clasen committed
1304
        tooltip->current_window = GTK_WINDOW (GTK_TOOLTIP (tooltip)->window);
Kristian Rietveld's avatar
Kristian Rietveld committed
1305 1306 1307 1308
    }

  screen = gtk_widget_get_screen (tooltip_widget);

1309
  /* FIXME: should use tooltip->current_window iso tooltip->window */
Kristian Rietveld's avatar
Kristian Rietveld committed
1310 1311 1312
  if (screen != gtk_widget_get_screen (tooltip->window))
    {
      g_signal_handlers_disconnect_by_func (display,
Matthias Clasen's avatar
Matthias Clasen committed
1313 1314
                                            gtk_tooltip_display_closed,
                                            tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1315 1316 1317 1318

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

      g_signal_connect (display, "closed",
Matthias Clasen's avatar
Matthias Clasen committed
1319
                        G_CALLBACK (gtk_tooltip_display_closed), tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1320 1321
    }

1322
  gtk_tooltip_position (tooltip, display, tooltip_widget);
Kristian Rietveld's avatar
Kristian Rietveld committed
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337

  /* 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)
{
1338
  if (!tooltip)
Kristian Rietveld's avatar
Kristian Rietveld committed
1339 1340 1341 1342 1343 1344 1345 1346
    return;

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

1347 1348 1349 1350 1351
  if (!GTK_TOOLTIP_VISIBLE (tooltip))
    return;

  tooltip->tooltip_widget = NULL;

Kristian Rietveld's avatar
Kristian Rietveld committed
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
  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
1368 1369 1370 1371
	  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
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
    }
  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;

1395
  display = GDK_DISPLAY (data);
1396 1397 1398 1399 1400 1401 1402 1403
  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
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421

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

1422
  if (!tooltip || GTK_TOOLTIP_VISIBLE (tooltip))
Kristian Rietveld's avatar
Kristian Rietveld committed
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
    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
1435 1436 1437 1438
  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
1439 1440 1441 1442 1443 1444 1445 1446 1447
}

void
_gtk_tooltip_focus_in (GtkWidget *widget)
{
  gint x, y;
  gboolean return_value = FALSE;
  GdkDisplay *display;
  GtkTooltip *tooltip;
1448
  GdkDevice *device;
Kristian Rietveld's avatar
Kristian Rietveld committed
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458

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

1459 1460
  device = gtk_get_current_event_device ();

1461
  if (device && gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1462 1463 1464 1465 1466 1467 1468 1469
    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
1470 1471 1472 1473 1474
  if (tooltip->keyboard_widget)
    g_object_unref (tooltip->keyboard_widget);

  tooltip->keyboard_widget = g_object_ref (widget);

1475 1476
  gdk_window_get_device_position (gtk_widget_get_window (widget),
                                  device, &x, &y, NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534

  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);
1535 1536 1537
      g_signal_connect (display, "closed",
			G_CALLBACK (gtk_tooltip_display_closed),
			tooltip);
Kristian Rietveld's avatar
Kristian Rietveld committed
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
    }

  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
1576
      || gtk_widget_get_window (toplevel) == tooltip->toplevel_window)
Kristian Rietveld's avatar
Kristian Rietveld committed
1577 1578 1579
    gtk_tooltip_hide_tooltip (tooltip);
}

1580
static gboolean
1581
tooltips_enabled (GdkEvent *event)
1582
{
1583 1584
  GdkDevice *source_device;
  GdkInputSource source;
1585

1586 1587 1588 1589 1590 1591
  source_device = gdk_event_get_source_device (event);

  if (!source_device)
    return FALSE;

  source = gdk_device_get_source (source_device);
1592

1593
  if (source != GDK_SOURCE_TOUCHSCREEN)
Carlos Garnacho's avatar