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