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