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

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