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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <stdio.h>
  30
  31 #include "gtklabel.h"
  32 #include "gtkmain.h"
  33 #include "gtkwidget.h"
  34 #include "gtkwindow.h"
  35 #include "gtksignal.h"
  36 #include "gtkstyle.h"
  37 #include "gtktooltips.h"
  38
  39
  40 #define DEFAULT_DELAY 500           /* Default delay in ms */
  41
  42 static void gtk_tooltips_class_init        (GtkTooltipsClass *klass);
  43 static void gtk_tooltips_init              (GtkTooltips      *tooltips);
  44 static void gtk_tooltips_destroy           (GtkObject        *object);
  45
  46 static gint gtk_tooltips_event_handler     (GtkWidget   *widget,
  47                                             GdkEvent    *event);
  48 static void gtk_tooltips_widget_unmap      (GtkWidget   *widget,
  49                                             gpointer     data);
  50 static void gtk_tooltips_widget_remove     (GtkWidget   *widget,
  51                                             gpointer     data);
  52 static void gtk_tooltips_set_active_widget (GtkTooltips *tooltips,
  53                                             GtkWidget   *widget);
  54 static gint gtk_tooltips_timeout           (gpointer     data);
  55
  56 static gint gtk_tooltips_paint_window      (GtkTooltips *tooltips);
  57 static void gtk_tooltips_draw_tips         (GtkTooltips *tooltips);
  58
  59 static GtkDataClass *parent_class;
  60 static const gchar  *tooltips_data_key = "_GtkTooltipsData";
  61
  62 GtkType
  63 gtk_tooltips_get_type (void)
  64 {
  65   static GtkType tooltips_type = 0;
  66
  67   if (!tooltips_type)
  68     {
  69       static const GtkTypeInfo tooltips_info =
  70       {
  71         "GtkTooltips",
  72         sizeof (GtkTooltips),
  73         sizeof (GtkTooltipsClass),
  74         (GtkClassInitFunc) gtk_tooltips_class_init,
  75         (GtkObjectInitFunc) gtk_tooltips_init,
  76         /* reserved_1 */ NULL,
  77         /* reserved_2 */ NULL,
  78         (GtkClassInitFunc) NULL,
  79       };
  80
  81       tooltips_type = gtk_type_unique (GTK_TYPE_DATA, &tooltips_info);
  82     }
  83
  84   return tooltips_type;
  85 }
  86
  87 static void
  88 gtk_tooltips_class_init (GtkTooltipsClass *class)
  89 {
  90   GtkObjectClass *object_class;
  91
  92   object_class = (GtkObjectClass*) class;
  93   parent_class = gtk_type_class (GTK_TYPE_DATA);
  94
  95   object_class->destroy = gtk_tooltips_destroy;
  96 }
  97
  98 static void
  99 gtk_tooltips_init (GtkTooltips *tooltips)
 100 {
 101   tooltips->tip_window = NULL;
 102   tooltips->active_tips_data = NULL;
 103   tooltips->tips_data_list = NULL;
 104
 105   tooltips->delay = DEFAULT_DELAY;
 106   tooltips->enabled = TRUE;
 107   tooltips->timer_tag = 0;
 108 }
 109
 110 GtkTooltips *
 111 gtk_tooltips_new (void)
 112 {
 113   return gtk_type_new (GTK_TYPE_TOOLTIPS);
 114 }
 115
 116 static void
 117 gtk_tooltips_destroy_data (GtkTooltipsData *tooltipsdata)
 118 {
 119   g_free (tooltipsdata->tip_text);
 120   g_free (tooltipsdata->tip_private);
 121   gtk_signal_disconnect_by_data (GTK_OBJECT (tooltipsdata->widget),
 122                                  (gpointer) tooltipsdata);
 123   gtk_object_remove_data (GTK_OBJECT (tooltipsdata->widget), tooltips_data_key);
 124   gtk_widget_unref (tooltipsdata->widget);
 125   g_free (tooltipsdata);
 126 }
 127
 128 static void
 129 gtk_tooltips_destroy (GtkObject *object)
 130 {
 131   GtkTooltips *tooltips = GTK_TOOLTIPS (object);
 132   GList *current;
 133   GtkTooltipsData *tooltipsdata;
 134
 135   g_return_if_fail (tooltips != NULL);
 136
 137   if (tooltips->timer_tag)
 138     {
 139       gtk_timeout_remove (tooltips->timer_tag);
 140       tooltips->timer_tag = 0;
 141     }
 142
 143   if (tooltips->tips_data_list != NULL)
 144     {
 145       current = g_list_first (tooltips->tips_data_list);
 146       while (current != NULL)
 147         {
 148           tooltipsdata = (GtkTooltipsData*) current->data;
 149           current = current->next;
 150           gtk_tooltips_widget_remove (tooltipsdata->widget, tooltipsdata);
 151         }
 152     }
 153
 154   if (tooltips->tip_window)
 155     gtk_widget_destroy (tooltips->tip_window);
 156 }
 157
 158 void
 159 gtk_tooltips_force_window (GtkTooltips *tooltips)
 160 {
 161   g_return_if_fail (tooltips != NULL);
 162   g_return_if_fail (GTK_IS_TOOLTIPS (tooltips));
 163
 164   if (!tooltips->tip_window)
 165     {
 166       tooltips->tip_window = gtk_window_new (GTK_WINDOW_POPUP);
 167       gtk_widget_set_app_paintable (tooltips->tip_window, TRUE);
 168       gtk_window_set_policy (GTK_WINDOW (tooltips->tip_window), FALSE, FALSE, TRUE);
 169       gtk_widget_set_name (tooltips->tip_window, "gtk-tooltips");
 170       gtk_container_set_border_width (GTK_CONTAINER (tooltips->tip_window), 4);
 171
 172       gtk_signal_connect_object (GTK_OBJECT (tooltips->tip_window),
 173                                  "expose_event",
 174                                  GTK_SIGNAL_FUNC (gtk_tooltips_paint_window),
 175                                  GTK_OBJECT (tooltips));
 176
 177       tooltips->tip_label = gtk_label_new (NULL);
 178       gtk_label_set_line_wrap (GTK_LABEL (tooltips->tip_label), TRUE);
 179       gtk_misc_set_alignment (GTK_MISC (tooltips->tip_label), 0.5, 0.5);
 180       gtk_widget_show (tooltips->tip_label);
 181
 182       gtk_container_add (GTK_CONTAINER (tooltips->tip_window), tooltips->tip_label);
 183
 184       gtk_signal_connect (GTK_OBJECT (tooltips->tip_window),
 185                           "destroy",
 186                           gtk_widget_destroyed,
 187                           &tooltips->tip_window);
 188     }
 189 }
 190
 191 void
 192 gtk_tooltips_enable (GtkTooltips *tooltips)
 193 {
 194   g_return_if_fail (tooltips != NULL);
 195
 196   tooltips->enabled = TRUE;
 197 }
 198
 199 void
 200 gtk_tooltips_disable (GtkTooltips *tooltips)
 201 {
 202   g_return_if_fail (tooltips != NULL);
 203
 204   gtk_tooltips_set_active_widget (tooltips, NULL);
 205
 206   tooltips->enabled = FALSE;
 207 }
 208
 209 void
 210 gtk_tooltips_set_delay (GtkTooltips *tooltips,
 211                         guint         delay)
 212 {
 213   g_return_if_fail (tooltips != NULL);
 214
 215   tooltips->delay = delay;
 216 }
 217
 218 GtkTooltipsData*
 219 gtk_tooltips_data_get (GtkWidget       *widget)
 220 {
 221   g_return_val_if_fail (widget != NULL, NULL);
 222
 223   return gtk_object_get_data ((GtkObject*) widget, tooltips_data_key);
 224 }
 225
 226 void
 227 gtk_tooltips_set_tip (GtkTooltips *tooltips,
 228                       GtkWidget   *widget,
 229                       const gchar *tip_text,
 230                       const gchar *tip_private)
 231 {
 232   GtkTooltipsData *tooltipsdata;
 233
 234   g_return_if_fail (tooltips != NULL);
 235   g_return_if_fail (GTK_IS_TOOLTIPS (tooltips));
 236   g_return_if_fail (widget != NULL);
 237
 238   tooltipsdata = gtk_tooltips_data_get (widget);
 239   if (tooltipsdata)
 240     gtk_tooltips_widget_remove (tooltipsdata->widget, tooltipsdata);
 241
 242   if (!tip_text)
 243     return;
 244
 245   tooltipsdata = g_new0 (GtkTooltipsData, 1);
 246
 247   if (tooltipsdata != NULL)
 248     {
 249       tooltipsdata->tooltips = tooltips;
 250       tooltipsdata->widget = widget;
 251       gtk_widget_ref (widget);
 252
 253       tooltipsdata->tip_text = g_strdup (tip_text);
 254       tooltipsdata->tip_private = g_strdup (tip_private);
 255
 256       tooltips->tips_data_list = g_list_append (tooltips->tips_data_list,
 257                                              tooltipsdata);
 258       gtk_signal_connect_after(GTK_OBJECT (widget), "event",
 259                                (GtkSignalFunc) gtk_tooltips_event_handler,
 260                                (gpointer) tooltipsdata);
 261
 262       gtk_object_set_data (GTK_OBJECT (widget), tooltips_data_key,
 263                            (gpointer) tooltipsdata);
 264
 265       gtk_signal_connect (GTK_OBJECT (widget), "unmap",
 266                           (GtkSignalFunc) gtk_tooltips_widget_unmap,
 267                           (gpointer) tooltipsdata);
 268
 269       gtk_signal_connect (GTK_OBJECT (widget), "unrealize",
 270                           (GtkSignalFunc) gtk_tooltips_widget_unmap,
 271                           (gpointer) tooltipsdata);
 272
 273       gtk_signal_connect (GTK_OBJECT (widget), "destroy",
 274                           (GtkSignalFunc) gtk_tooltips_widget_remove,
 275                           (gpointer) tooltipsdata);
 276     }
 277 }
 278
 279 void
 280 gtk_tooltips_set_colors (GtkTooltips *tooltips,
 281                          GdkColor    *background,
 282                          GdkColor    *foreground)
 283 {
 284   g_return_if_fail (tooltips != NULL);
 285
 286   g_warning ("gtk_tooltips_set_colors is deprecated and does nothing.\n"
 287              "The colors for tooltips are now taken from the style.");
 288 }
 289
 290 static gint
 291 gtk_tooltips_paint_window (GtkTooltips *tooltips)
 292 {
 293   gtk_paint_flat_box(tooltips->tip_window->style, tooltips->tip_window->window,
 294                      GTK_STATE_NORMAL, GTK_SHADOW_OUT,
 295                      NULL, GTK_WIDGET(tooltips->tip_window), "tooltip",
 296                      0, 0, -1, -1);
 297
 298   return TRUE;
 299 }
 300
 301 static void
 302 gtk_tooltips_draw_tips (GtkTooltips * tooltips)
 303 {
 304   GtkRequisition requisition;
 305   GtkWidget *widget;
 306   GtkStyle *style;
 307   gint x, y, w, h, scr_w, scr_h;
 308   GtkTooltipsData *data;
 309
 310   if (!tooltips->tip_window)
 311     gtk_tooltips_force_window (tooltips);
 312   else if (GTK_WIDGET_VISIBLE (tooltips->tip_window))
 313     gtk_widget_hide (tooltips->tip_window);
 314
 315   gtk_widget_ensure_style (tooltips->tip_window);
 316   style = tooltips->tip_window->style;
 317
 318   widget = tooltips->active_tips_data->widget;
 319
 320   scr_w = gdk_screen_width ();
 321   scr_h = gdk_screen_height ();
 322
 323   data = tooltips->active_tips_data;
 324
 325   gtk_label_set_text (GTK_LABEL (tooltips->tip_label), data->tip_text);
 326
 327   gtk_widget_size_request (tooltips->tip_window, &requisition);
 328   w = requisition.width;
 329   h = requisition.height;
 330
 331   gdk_window_get_pointer (NULL, &x, NULL, NULL);
 332   gdk_window_get_origin (widget->window, NULL, &y);
 333   if (GTK_WIDGET_NO_WINDOW (widget))
 334     y += widget->allocation.y;
 335
 336   x -= (w / 2 + 4);
 337
 338   if ((x + w) > scr_w)
 339     x -= (x + w) - scr_w;
 340   else if (x < 0)
 341     x = 0;
 342
 343   if ((y + h + widget->allocation.height + 4) > scr_h)
 344     y = y - h - 4;
 345   else
 346     y = y + widget->allocation.height + 4;
 347
 348   gtk_widget_popup (tooltips->tip_window, x, y);
 349 }
 350
 351 static gint
 352 gtk_tooltips_timeout (gpointer data)
 353 {
 354   GtkTooltips *tooltips = (GtkTooltips *) data;
 355
 356   GDK_THREADS_ENTER ();
 357
 358   if (tooltips->active_tips_data != NULL &&
 359       GTK_WIDGET_DRAWABLE (tooltips->active_tips_data->widget))
 360     gtk_tooltips_draw_tips (tooltips);
 361
 362   GDK_THREADS_LEAVE ();
 363
 364   return FALSE;
 365 }
 366
 367 static void
 368 gtk_tooltips_set_active_widget (GtkTooltips *tooltips,
 369                                 GtkWidget   *widget)
 370 {
 371   if (tooltips->tip_window)
 372     gtk_widget_hide (tooltips->tip_window);
 373   if (tooltips->timer_tag)
 374     {
 375       gtk_timeout_remove (tooltips->timer_tag);
 376       tooltips->timer_tag = 0;
 377     }
 378
 379   tooltips->active_tips_data = NULL;
 380
 381   if (widget)
 382     {
 383       GList *list;
 384
 385       for (list = tooltips->tips_data_list; list; list = list->next)
 386         {
 387           GtkTooltipsData *tooltipsdata;
 388
 389           tooltipsdata = list->data;
 390
 391           if (tooltipsdata->widget == widget &&
 392               GTK_WIDGET_DRAWABLE (widget))
 393             {
 394               tooltips->active_tips_data = tooltipsdata;
 395               break;
 396             }
 397         }
 398     }
 399 }
 400
 401 static gint
 402 gtk_tooltips_event_handler (GtkWidget *widget,
 403                             GdkEvent  *event)
 404 {
 405   GtkTooltips *tooltips;
 406   GtkTooltipsData *old_tips_data;
 407   GtkWidget *event_widget;
 408
 409   if ((event->type == GDK_LEAVE_NOTIFY || event->type == GDK_ENTER_NOTIFY) &&
 410       event->crossing.detail == GDK_NOTIFY_INFERIOR)
 411     return FALSE;
 412
 413   event_widget = gtk_get_event_widget (event);
 414   if (event_widget != widget)
 415     return FALSE;
 416
 417   old_tips_data = gtk_tooltips_data_get (widget);
 418   tooltips = old_tips_data->tooltips;
 419
 420   switch (event->type)
 421     {
 422     case GDK_MOTION_NOTIFY:
 423     case GDK_EXPOSE:
 424       /* do nothing */
 425       break;
 426
 427     case GDK_ENTER_NOTIFY:
 428       old_tips_data = tooltips->active_tips_data;
 429       if (tooltips->enabled &&
 430           (!old_tips_data || old_tips_data->widget != widget))
 431         {
 432           gtk_tooltips_set_active_widget (tooltips, widget);
 433
 434           tooltips->timer_tag = gtk_timeout_add (tooltips->delay,
 435                                                  gtk_tooltips_timeout,
 436                                                  (gpointer) tooltips);
 437         }
 438       break;
 439
 440     default:
 441       gtk_tooltips_set_active_widget (tooltips, NULL);
 442       break;
 443     }
 444
 445   return FALSE;
 446 }
 447
 448 static void
 449 gtk_tooltips_widget_unmap (GtkWidget *widget,
 450                            gpointer   data)
 451 {
 452   GtkTooltipsData *tooltipsdata = (GtkTooltipsData *)data;
 453   GtkTooltips *tooltips = tooltipsdata->tooltips;
 454
 455   if (tooltips->active_tips_data &&
 456       (tooltips->active_tips_data->widget == widget))
 457     gtk_tooltips_set_active_widget (tooltips, NULL);
 458 }
 459
 460 static void
 461 gtk_tooltips_widget_remove (GtkWidget *widget,
 462                             gpointer   data)
 463 {
 464   GtkTooltipsData *tooltipsdata = (GtkTooltipsData*) data;
 465   GtkTooltips *tooltips = tooltipsdata->tooltips;
 466
 467   gtk_tooltips_widget_unmap (widget, data);
 468   tooltips->tips_data_list = g_list_remove (tooltips->tips_data_list,
 469                                             tooltipsdata);
 470   gtk_tooltips_destroy_data (tooltipsdata);
 471 }