shell/ev-tooltip.c

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2004 Red Hat, Inc.
   4  *
   5  *  Author:
   6  *    Marco Pesenti Gritti <marco@gnome.org>
   7  *
   8  * Evince is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * Evince is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include "ev-tooltip.h"
  28
  29 #include <gtk/gtklabel.h>
  30
  31 #define DEFAULT_DELAY 500
  32 #define STICKY_DELAY 500
  33 #define STICKY_REVERT_DELAY 1000
  34 #define SPACE_FROM_CURSOR 10
  35
  36 struct _EvTooltipPrivate {
  37         GtkWidget *label;
  38         GTimeVal last_deactivate;
  39         int timer_tag;
  40         gboolean active;
  41 };
  42
  43 G_DEFINE_TYPE (EvTooltip, ev_tooltip, GTK_TYPE_WINDOW)
  44
  45 #define EV_TOOLTIP_GET_PRIVATE(object) \
  46                 (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_TOOLTIP, EvTooltipPrivate))
  47
  48 static gboolean
  49 ev_tooltip_expose_event (GtkWidget      *widget,
  50                          GdkEventExpose *event)
  51 {
  52         gtk_paint_flat_box (widget->style, widget->window,
  53                             GTK_STATE_NORMAL, GTK_SHADOW_OUT,
  54                             NULL, widget, "tooltip", 0, 0,
  55                             widget->allocation.width, widget->allocation.height);
  56
  57         return GTK_WIDGET_CLASS (ev_tooltip_parent_class)->expose_event (widget, event);
  58 }
  59
  60 static void
  61 ev_tooltip_dispose (GObject *object)
  62 {
  63         EvTooltip *tooltip = EV_TOOLTIP (object);
  64
  65         if (tooltip->priv->timer_tag) {
  66                 g_source_remove (tooltip->priv->timer_tag);
  67                 tooltip->priv->timer_tag = 0;
  68         }
  69 }
  70
  71 static void
  72 ev_tooltip_class_init (EvTooltipClass *class)
  73 {
  74         GObjectClass *g_object_class = G_OBJECT_CLASS (class);
  75         GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
  76
  77         g_object_class->dispose = ev_tooltip_dispose;
  78         widget_class->expose_event = ev_tooltip_expose_event;
  79
  80         g_type_class_add_private (g_object_class, sizeof (EvTooltipPrivate));
  81 }
  82
  83 static void
  84 ev_tooltip_init (EvTooltip *tooltip)
  85 {
  86         GtkWidget *window = GTK_WIDGET (tooltip);
  87         GtkWidget *label;
  88
  89         tooltip->priv = EV_TOOLTIP_GET_PRIVATE (tooltip);
  90
  91         gtk_widget_set_app_paintable (GTK_WIDGET (tooltip), TRUE);
  92         gtk_window_set_resizable (GTK_WINDOW (tooltip), FALSE);
  93         gtk_widget_set_name (window, "gtk-tooltips");
  94
  95         label = gtk_label_new (NULL);
  96         gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
  97         gtk_container_add (GTK_CONTAINER (window), label);
  98         gtk_container_set_border_width (GTK_CONTAINER (window), 3);
  99         tooltip->priv->label = label;
 100
 101         gtk_widget_show (label);
 102 }
 103
 104 /* Public functions */
 105
 106 GtkWidget *
 107 ev_tooltip_new (GtkWidget *parent)
 108 {
 109         GtkWidget *tooltip;
 110         GtkWidget *toplevel;
 111
 112         tooltip = g_object_new (EV_TYPE_TOOLTIP, NULL);
 113
 114         GTK_WINDOW (tooltip)->type = GTK_WINDOW_POPUP;
 115         EV_TOOLTIP (tooltip)->parent = parent;
 116
 117         toplevel = gtk_widget_get_toplevel (parent);
 118         gtk_window_set_transient_for (GTK_WINDOW (tooltip), GTK_WINDOW (toplevel));
 119
 120         return tooltip;
 121 }
 122
 123 void
 124 ev_tooltip_set_text (EvTooltip *tooltip, const char *text)
 125 {
 126         gtk_label_set_text (GTK_LABEL (tooltip->priv->label), text);
 127 }
 128
 129 void
 130 ev_tooltip_set_position (EvTooltip *tooltip, int x, int y)
 131 {
 132         int root_x, root_y;
 133
 134         if (tooltip->parent != NULL) {
 135                 gdk_window_get_origin (tooltip->parent->window, &root_x, &root_y);
 136         }
 137
 138         gtk_window_move (GTK_WINDOW (tooltip),
 139                          x + root_x + SPACE_FROM_CURSOR,
 140                          y + root_y + SPACE_FROM_CURSOR);
 141 }
 142
 143 static gboolean
 144 ev_tooltip_recently_shown (EvTooltip *tooltip)
 145 {
 146         GTimeVal now;
 147         glong msec;
 148
 149         g_get_current_time (&now);
 150
 151         msec = (now.tv_sec  - tooltip->priv->last_deactivate.tv_sec) * 1000 +
 152                (now.tv_usec - tooltip->priv->last_deactivate.tv_usec) / 1000;
 153
 154         return (msec < STICKY_REVERT_DELAY);
 155 }
 156
 157 static gint
 158 ev_tooltip_timeout (gpointer data)
 159 {
 160         GtkWidget *tooltip = GTK_WIDGET (data);
 161
 162         gtk_widget_show (tooltip);
 163
 164         return FALSE;
 165 }
 166
 167 void
 168 ev_tooltip_activate (EvTooltip *tooltip)
 169 {
 170         int delay;
 171
 172         if (tooltip->priv->active) {
 173                 return;
 174         } else {
 175                 tooltip->priv->active = TRUE;
 176         }
 177
 178         if (ev_tooltip_recently_shown (tooltip)) {
 179                 delay = STICKY_DELAY;
 180         } else {
 181                 delay = DEFAULT_DELAY;
 182         }
 183
 184         tooltip->priv->timer_tag = g_timeout_add (delay, ev_tooltip_timeout,
 185                                                   (gpointer)tooltip);
 186 }
 187
 188 void
 189 ev_tooltip_deactivate (EvTooltip *tooltip)
 190 {
 191         if (!tooltip->priv->active) {
 192                 return;
 193         } else {
 194                 tooltip->priv->active = FALSE;
 195         }
 196
 197         if (tooltip->priv->timer_tag) {
 198                 g_source_remove (tooltip->priv->timer_tag);
 199                 tooltip->priv->timer_tag = 0;
 200         }
 201
 202         gtk_widget_hide (GTK_WIDGET (tooltip));
 203
 204         g_get_current_time (&tooltip->priv->last_deactivate);
 205 }