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