Pileus Git - ~andy/gtk/blob - gtk/gtkruler.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 "gtkruler.h"
  28 #include "gtkintl.h"
  29
  30 enum {
  31   PROP_0,
  32   PROP_LOWER,
  33   PROP_UPPER,
  34   PROP_POSITION,
  35   PROP_MAX_SIZE
  36 };
  37
  38 static void gtk_ruler_class_init    (GtkRulerClass  *klass);
  39 static void gtk_ruler_init          (GtkRuler       *ruler);
  40 static void gtk_ruler_realize       (GtkWidget      *widget);
  41 static void gtk_ruler_unrealize     (GtkWidget      *widget);
  42 static void gtk_ruler_size_allocate (GtkWidget      *widget,
  43                                      GtkAllocation  *allocation);
  44 static gint gtk_ruler_expose        (GtkWidget      *widget,
  45                                      GdkEventExpose *event);
  46 static void gtk_ruler_make_pixmap   (GtkRuler       *ruler);
  47 static void gtk_ruler_set_property  (GObject        *object,
  48                                      guint            prop_id,
  49                                      const GValue   *value,
  50                                      GParamSpec     *pspec);
  51 static void gtk_ruler_get_property  (GObject        *object,
  52                                      guint           prop_id,
  53                                      GValue         *value,
  54                                      GParamSpec     *pspec);
  55
  56 static GtkWidgetClass *parent_class;
  57
  58 static const GtkRulerMetric ruler_metrics[] =
  59 {
  60   {"Pixels", "Pi", 1.0, { 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000 }, { 1, 5, 10, 50, 100 }},
  61   {"Inches", "In", 72.0, { 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 }, { 1, 2, 4, 8, 16 }},
  62   {"Centimeters", "Cn", 28.35, { 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000 }, { 1, 5, 10, 50, 100 }},
  63 };
  64
  65
  66 GType
  67 gtk_ruler_get_type (void)
  68 {
  69   static GType ruler_type = 0;
  70
  71   if (!ruler_type)
  72     {
  73       static const GTypeInfo ruler_info =
  74       {
  75         sizeof (GtkRulerClass),
  76         NULL,           /* base_init */
  77         NULL,           /* base_finalize */
  78         (GClassInitFunc) gtk_ruler_class_init,
  79         NULL,           /* class_finalize */
  80         NULL,           /* class_data */
  81         sizeof (GtkRuler),
  82         0,              /* n_preallocs */
  83         (GInstanceInitFunc) gtk_ruler_init,
  84       };
  85
  86       ruler_type = g_type_register_static (GTK_TYPE_WIDGET, "GtkRuler",
  87                                            &ruler_info, 0);
  88     }
  89
  90   return ruler_type;
  91 }
  92
  93 static void
  94 gtk_ruler_class_init (GtkRulerClass *class)
  95 {
  96   GObjectClass   *gobject_class;
  97   GtkWidgetClass *widget_class;
  98
  99   gobject_class = G_OBJECT_CLASS (class);
 100   widget_class = (GtkWidgetClass*) class;
 101
 102   parent_class = g_type_class_peek_parent (class);
 103
 104   gobject_class->set_property = gtk_ruler_set_property;
 105   gobject_class->get_property = gtk_ruler_get_property;
 106
 107   widget_class->realize = gtk_ruler_realize;
 108   widget_class->unrealize = gtk_ruler_unrealize;
 109   widget_class->size_allocate = gtk_ruler_size_allocate;
 110   widget_class->expose_event = gtk_ruler_expose;
 111
 112   class->draw_ticks = NULL;
 113   class->draw_pos = NULL;
 114
 115   g_object_class_install_property (gobject_class,
 116                                    PROP_LOWER,
 117                                    g_param_spec_double ("lower",
 118                                                         P_("Lower"),
 119                                                         P_("Lower limit of ruler"),
 120                                                         -G_MAXDOUBLE,
 121                                                         G_MAXDOUBLE,
 122                                                         0.0,
 123                                                         G_PARAM_READWRITE));
 124
 125   g_object_class_install_property (gobject_class,
 126                                    PROP_UPPER,
 127                                    g_param_spec_double ("upper",
 128                                                         P_("Upper"),
 129                                                         P_("Upper limit of ruler"),
 130                                                         -G_MAXDOUBLE,
 131                                                         G_MAXDOUBLE,
 132                                                         0.0,
 133                                                         G_PARAM_READWRITE));
 134
 135   g_object_class_install_property (gobject_class,
 136                                    PROP_POSITION,
 137                                    g_param_spec_double ("position",
 138                                                         P_("Position"),
 139                                                         P_("Position of mark on the ruler"),
 140                                                         -G_MAXDOUBLE,
 141                                                         G_MAXDOUBLE,
 142                                                         0.0,
 143                                                         G_PARAM_READWRITE));
 144
 145   g_object_class_install_property (gobject_class,
 146                                    PROP_MAX_SIZE,
 147                                    g_param_spec_double ("max_size",
 148                                                         P_("Max Size"),
 149                                                         P_("Maximum size of the ruler"),
 150                                                         -G_MAXDOUBLE,
 151                                                         G_MAXDOUBLE,
 152                                                         0.0,
 153                                                         G_PARAM_READWRITE));
 154 }
 155
 156 static void
 157 gtk_ruler_init (GtkRuler *ruler)
 158 {
 159   ruler->backing_store = NULL;
 160   ruler->non_gr_exp_gc = NULL;
 161   ruler->xsrc = 0;
 162   ruler->ysrc = 0;
 163   ruler->slider_size = 0;
 164   ruler->lower = 0;
 165   ruler->upper = 0;
 166   ruler->position = 0;
 167   ruler->max_size = 0;
 168
 169   gtk_ruler_set_metric (ruler, GTK_PIXELS);
 170 }
 171
 172 static void
 173 gtk_ruler_set_property (GObject      *object,
 174                         guint         prop_id,
 175                         const GValue *value,
 176                         GParamSpec   *pspec)
 177 {
 178   GtkRuler *ruler = GTK_RULER (object);
 179
 180   switch (prop_id)
 181     {
 182     case PROP_LOWER:
 183       gtk_ruler_set_range (ruler, g_value_get_double (value), ruler->upper,
 184                            ruler->position, ruler->max_size);
 185       break;
 186     case PROP_UPPER:
 187       gtk_ruler_set_range (ruler, ruler->lower, g_value_get_double (value),
 188                            ruler->position, ruler->max_size);
 189       break;
 190     case PROP_POSITION:
 191       gtk_ruler_set_range (ruler, ruler->lower, ruler->upper,
 192                            g_value_get_double (value), ruler->max_size);
 193       break;
 194     case PROP_MAX_SIZE:
 195       gtk_ruler_set_range (ruler, ruler->lower, ruler->upper,
 196                            ruler->position,  g_value_get_double (value));
 197       break;
 198     }
 199 }
 200
 201 static void
 202 gtk_ruler_get_property (GObject      *object,
 203                         guint         prop_id,
 204                         GValue       *value,
 205                         GParamSpec   *pspec)
 206 {
 207   GtkRuler *ruler = GTK_RULER (object);
 208
 209   switch (prop_id)
 210     {
 211     case PROP_LOWER:
 212       g_value_set_double (value, ruler->lower);
 213       break;
 214     case PROP_UPPER:
 215       g_value_set_double (value, ruler->upper);
 216       break;
 217     case PROP_POSITION:
 218       g_value_set_double (value, ruler->position);
 219       break;
 220     case PROP_MAX_SIZE:
 221       g_value_set_double (value, ruler->max_size);
 222       break;
 223     default:
 224       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 225       break;
 226     }
 227 }
 228
 229 void
 230 gtk_ruler_set_metric (GtkRuler      *ruler,
 231                       GtkMetricType  metric)
 232 {
 233   g_return_if_fail (GTK_IS_RULER (ruler));
 234
 235   ruler->metric = (GtkRulerMetric *) &ruler_metrics[metric];
 236
 237   if (GTK_WIDGET_DRAWABLE (ruler))
 238     gtk_widget_queue_draw (GTK_WIDGET (ruler));
 239 }
 240
 241 /**
 242  * gtk_ruler_get_metric:
 243  * @ruler: a #GtkRuler
 244  *
 245  * Gets the units used for a #GtkRuler. See gtk_ruler_set_metric().
 246  *
 247  * Return value: the units currently used for @ruler
 248  **/
 249 GtkMetricType
 250 gtk_ruler_get_metric (GtkRuler *ruler)
 251 {
 252   gint i;
 253
 254   g_return_val_if_fail (GTK_IS_RULER (ruler), 0);
 255
 256   for (i = 0; i < G_N_ELEMENTS (ruler_metrics); i++)
 257     if (ruler->metric == &ruler_metrics[i])
 258       return i;
 259
 260   g_assert_not_reached ();
 261
 262   return 0;
 263 }
 264
 265 void
 266 gtk_ruler_set_range (GtkRuler *ruler,
 267                      gdouble   lower,
 268                      gdouble   upper,
 269                      gdouble   position,
 270                      gdouble   max_size)
 271 {
 272   g_return_if_fail (GTK_IS_RULER (ruler));
 273
 274   g_object_freeze_notify (G_OBJECT (ruler));
 275   if (ruler->lower != lower)
 276     {
 277       ruler->lower = lower;
 278       g_object_notify (G_OBJECT (ruler), "lower");
 279     }
 280   if (ruler->upper != upper)
 281     {
 282       ruler->upper = upper;
 283       g_object_notify (G_OBJECT (ruler), "upper");
 284     }
 285   if (ruler->position != position)
 286     {
 287       ruler->position = position;
 288       g_object_notify (G_OBJECT (ruler), "position");
 289     }
 290   if (ruler->max_size != max_size)
 291     {
 292       ruler->max_size = max_size;
 293       g_object_notify (G_OBJECT (ruler), "max_size");
 294     }
 295   g_object_thaw_notify (G_OBJECT (ruler));
 296
 297   if (GTK_WIDGET_DRAWABLE (ruler))
 298     gtk_widget_queue_draw (GTK_WIDGET (ruler));
 299 }
 300
 301 /**
 302  * gtk_ruler_get_range:
 303  * @ruler: a #GtkRuler
 304  * @lower: location to store lower limit of the ruler, or %NULL
 305  * @upper: location to store upper limit of the ruler, or %NULL
 306  * @position: location to store the current position of the mark on the ruler, or %NULL
 307  * @max_size: location to store the maximum size of the ruler used when calculating
 308  *            the space to leave for the text, or %NULL.
 309  *
 310  * Retrieves values indicating the range and current position of a #GtkRuler.
 311  * See gtk_ruler_set_range().
 312  **/
 313 void
 314 gtk_ruler_get_range (GtkRuler *ruler,
 315                      gdouble  *lower,
 316                      gdouble  *upper,
 317                      gdouble  *position,
 318                      gdouble  *max_size)
 319 {
 320   g_return_if_fail (GTK_IS_RULER (ruler));
 321
 322   if (lower)
 323     *lower = ruler->lower;
 324   if (upper)
 325     *upper = ruler->upper;
 326   if (position)
 327     *position = ruler->position;
 328   if (max_size)
 329     *max_size = ruler->max_size;
 330 }
 331
 332 void
 333 gtk_ruler_draw_ticks (GtkRuler *ruler)
 334 {
 335   g_return_if_fail (GTK_IS_RULER (ruler));
 336
 337   if (GTK_RULER_GET_CLASS (ruler)->draw_ticks)
 338     GTK_RULER_GET_CLASS (ruler)->draw_ticks (ruler);
 339 }
 340
 341 void
 342 gtk_ruler_draw_pos (GtkRuler *ruler)
 343 {
 344   g_return_if_fail (GTK_IS_RULER (ruler));
 345
 346   if (GTK_RULER_GET_CLASS (ruler)->draw_pos)
 347      GTK_RULER_GET_CLASS (ruler)->draw_pos (ruler);
 348 }
 349
 350
 351 static void
 352 gtk_ruler_realize (GtkWidget *widget)
 353 {
 354   GtkRuler *ruler;
 355   GdkWindowAttr attributes;
 356   gint attributes_mask;
 357
 358   ruler = GTK_RULER (widget);
 359   GTK_WIDGET_SET_FLAGS (ruler, GTK_REALIZED);
 360
 361   attributes.window_type = GDK_WINDOW_CHILD;
 362   attributes.x = widget->allocation.x;
 363   attributes.y = widget->allocation.y;
 364   attributes.width = widget->allocation.width;
 365   attributes.height = widget->allocation.height;
 366   attributes.wclass = GDK_INPUT_OUTPUT;
 367   attributes.visual = gtk_widget_get_visual (widget);
 368   attributes.colormap = gtk_widget_get_colormap (widget);
 369   attributes.event_mask = gtk_widget_get_events (widget);
 370   attributes.event_mask |= (GDK_EXPOSURE_MASK |
 371                             GDK_POINTER_MOTION_MASK |
 372                             GDK_POINTER_MOTION_HINT_MASK);
 373
 374   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
 375
 376   widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
 377   gdk_window_set_user_data (widget->window, ruler);
 378
 379   widget->style = gtk_style_attach (widget->style, widget->window);
 380   gtk_style_set_background (widget->style, widget->window, GTK_STATE_ACTIVE);
 381
 382   gtk_ruler_make_pixmap (ruler);
 383 }
 384
 385 static void
 386 gtk_ruler_unrealize (GtkWidget *widget)
 387 {
 388   GtkRuler *ruler = GTK_RULER (widget);
 389
 390   if (ruler->backing_store)
 391     g_object_unref (ruler->backing_store);
 392   if (ruler->non_gr_exp_gc)
 393     g_object_unref (ruler->non_gr_exp_gc);
 394
 395   ruler->backing_store = NULL;
 396   ruler->non_gr_exp_gc = NULL;
 397
 398   if (GTK_WIDGET_CLASS (parent_class)->unrealize)
 399     (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
 400 }
 401
 402 static void
 403 gtk_ruler_size_allocate (GtkWidget     *widget,
 404                          GtkAllocation *allocation)
 405 {
 406   GtkRuler *ruler = GTK_RULER (widget);
 407
 408   widget->allocation = *allocation;
 409
 410   if (GTK_WIDGET_REALIZED (widget))
 411     {
 412       gdk_window_move_resize (widget->window,
 413                               allocation->x, allocation->y,
 414                               allocation->width, allocation->height);
 415
 416       gtk_ruler_make_pixmap (ruler);
 417     }
 418 }
 419
 420 static gint
 421 gtk_ruler_expose (GtkWidget      *widget,
 422                   GdkEventExpose *event)
 423 {
 424   GtkRuler *ruler;
 425
 426   if (GTK_WIDGET_DRAWABLE (widget))
 427     {
 428       ruler = GTK_RULER (widget);
 429
 430       gtk_ruler_draw_ticks (ruler);
 431
 432       gdk_draw_drawable (widget->window,
 433                          ruler->non_gr_exp_gc,
 434                          ruler->backing_store,
 435                          0, 0, 0, 0,
 436                          widget->allocation.width,
 437                          widget->allocation.height);
 438
 439       gtk_ruler_draw_pos (ruler);
 440     }
 441
 442   return FALSE;
 443 }
 444
 445 static void
 446 gtk_ruler_make_pixmap (GtkRuler *ruler)
 447 {
 448   GtkWidget *widget;
 449   gint width;
 450   gint height;
 451
 452   widget = GTK_WIDGET (ruler);
 453
 454   if (ruler->backing_store)
 455     {
 456       gdk_drawable_get_size (ruler->backing_store, &width, &height);
 457       if ((width == widget->allocation.width) &&
 458           (height == widget->allocation.height))
 459         return;
 460
 461       g_object_unref (ruler->backing_store);
 462     }
 463
 464   ruler->backing_store = gdk_pixmap_new (widget->window,
 465                                          widget->allocation.width,
 466                                          widget->allocation.height,
 467                                          -1);
 468
 469   ruler->xsrc = 0;
 470   ruler->ysrc = 0;
 471
 472   if (!ruler->non_gr_exp_gc)
 473     {
 474       ruler->non_gr_exp_gc = gdk_gc_new (widget->window);
 475       gdk_gc_set_exposures (ruler->non_gr_exp_gc, FALSE);
 476     }
 477 }