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