1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
32 #include "gtkorientable.h"
34 #include "gtktypeutils.h"
35 #include "gtkprivate.h"
38 #define RULER_WIDTH 14
39 #define MINIMUM_INCR 5
40 #define MAXIMUM_SUBDIVIDE 5
41 #define MAXIMUM_SCALES 10
43 #define ROUND(x) ((int) ((x) + 0.5))
45 struct _GtkRulerPrivate
47 GtkOrientation orientation;
48 GtkRulerMetric *metric;
50 cairo_surface_t *backing_store;
56 gdouble lower; /* The upper limit of the ruler (in points) */
57 gdouble max_size; /* The maximum size of the ruler */
58 gdouble position; /* The position of the mark on the ruler */
59 gdouble upper; /* The lower limit of the ruler */
73 static void gtk_ruler_set_property (GObject *object,
77 static void gtk_ruler_get_property (GObject *object,
81 static void gtk_ruler_realize (GtkWidget *widget);
82 static void gtk_ruler_unrealize (GtkWidget *widget);
83 static void gtk_ruler_size_request (GtkWidget *widget,
84 GtkRequisition *requisition);
85 static void gtk_ruler_size_allocate (GtkWidget *widget,
86 GtkAllocation *allocation);
87 static gboolean gtk_ruler_motion_notify (GtkWidget *widget,
88 GdkEventMotion *event);
89 static gboolean gtk_ruler_draw (GtkWidget *widget,
91 static void gtk_ruler_make_pixmap (GtkRuler *ruler);
92 static void gtk_ruler_draw_ticks (GtkRuler *ruler);
93 static void gtk_ruler_real_draw_ticks (GtkRuler *ruler,
95 static void gtk_ruler_real_draw_pos (GtkRuler *ruler,
99 static const GtkRulerMetric ruler_metrics[] =
101 { "Pixel", "Pi", 1.0, { 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000 }, { 1, 5, 10, 50, 100 }},
102 { "Inches", "In", 72.0, { 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 }, { 1, 2, 4, 8, 16 }},
103 { "Centimeters", "Cn", 28.35, { 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000 }, { 1, 5, 10, 50, 100 }},
107 G_DEFINE_TYPE_WITH_CODE (GtkRuler, gtk_ruler, GTK_TYPE_WIDGET,
108 G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE,
113 gtk_ruler_class_init (GtkRulerClass *class)
115 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
116 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
118 gobject_class->set_property = gtk_ruler_set_property;
119 gobject_class->get_property = gtk_ruler_get_property;
121 widget_class->realize = gtk_ruler_realize;
122 widget_class->unrealize = gtk_ruler_unrealize;
123 widget_class->size_request = gtk_ruler_size_request;
124 widget_class->size_allocate = gtk_ruler_size_allocate;
125 widget_class->motion_notify_event = gtk_ruler_motion_notify;
126 widget_class->draw = gtk_ruler_draw;
128 class->draw_ticks = gtk_ruler_real_draw_ticks;
129 class->draw_pos = gtk_ruler_real_draw_pos;
131 g_object_class_override_property (gobject_class,
135 g_object_class_install_property (gobject_class,
137 g_param_spec_double ("lower",
139 P_("Lower limit of ruler"),
143 GTK_PARAM_READWRITE));
145 g_object_class_install_property (gobject_class,
147 g_param_spec_double ("upper",
149 P_("Upper limit of ruler"),
153 GTK_PARAM_READWRITE));
155 g_object_class_install_property (gobject_class,
157 g_param_spec_double ("position",
159 P_("Position of mark on the ruler"),
163 GTK_PARAM_READWRITE));
165 g_object_class_install_property (gobject_class,
167 g_param_spec_double ("max-size",
169 P_("Maximum size of the ruler"),
173 GTK_PARAM_READWRITE));
177 * The metric used for the ruler.
181 g_object_class_install_property (gobject_class,
183 g_param_spec_enum ("metric",
185 P_("The metric used for the ruler"),
186 GTK_TYPE_METRIC_TYPE,
188 GTK_PARAM_READWRITE));
190 g_type_class_add_private (gobject_class, sizeof (GtkRulerPrivate));
194 gtk_ruler_init (GtkRuler *ruler)
196 GtkRulerPrivate *priv;
198 ruler->priv = G_TYPE_INSTANCE_GET_PRIVATE (ruler,
203 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
205 priv->backing_store = NULL;
208 priv->slider_size = 0;
214 gtk_ruler_set_metric (ruler, GTK_PIXELS);
218 gtk_ruler_set_property (GObject *object,
223 GtkRuler *ruler = GTK_RULER (object);
224 GtkRulerPrivate *priv = ruler->priv;
228 case PROP_ORIENTATION:
229 priv->orientation = g_value_get_enum (value);
230 gtk_widget_queue_resize (GTK_WIDGET (ruler));
233 gtk_ruler_set_range (ruler, g_value_get_double (value), priv->upper,
234 priv->position, priv->max_size);
237 gtk_ruler_set_range (ruler, priv->lower, g_value_get_double (value),
238 priv->position, priv->max_size);
241 gtk_ruler_set_range (ruler, priv->lower, priv->upper,
242 g_value_get_double (value), priv->max_size);
245 gtk_ruler_set_range (ruler, priv->lower, priv->upper,
246 priv->position, g_value_get_double (value));
249 gtk_ruler_set_metric (ruler, g_value_get_enum (value));
252 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
258 gtk_ruler_get_property (GObject *object,
263 GtkRuler *ruler = GTK_RULER (object);
264 GtkRulerPrivate *priv = ruler->priv;
268 case PROP_ORIENTATION:
269 g_value_set_enum (value, priv->orientation);
272 g_value_set_double (value, priv->lower);
275 g_value_set_double (value, priv->upper);
278 g_value_set_double (value, priv->position);
281 g_value_set_double (value, priv->max_size);
284 g_value_set_enum (value, gtk_ruler_get_metric (ruler));
287 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
294 * @orientation: the ruler's orientation.
296 * Creates a new #GtkRuler with the given orientation.
298 * Return value: a new #GtkRuler.
303 gtk_ruler_new (GtkOrientation orientation)
305 return g_object_new (GTK_TYPE_RULER,
306 "orientation", orientation,
311 * gtk_ruler_invalidate_ticks:
312 * @ruler: the ruler to invalidate
314 * For performance reasons, #GtkRuler keeps a backbuffer containing the
315 * prerendered contents of the ticks. To cause a repaint this buffer,
316 * call this function instead of gtk_widget_queue_draw().
319 gtk_ruler_invalidate_ticks (GtkRuler *ruler)
321 g_return_if_fail (GTK_IS_RULER (ruler));
323 if (ruler->priv->backing_store == NULL)
326 gtk_ruler_draw_ticks (ruler);
327 gtk_widget_queue_draw (GTK_WIDGET (ruler));
331 gtk_ruler_set_metric (GtkRuler *ruler,
332 GtkMetricType metric)
334 GtkRulerPrivate *priv;
336 g_return_if_fail (GTK_IS_RULER (ruler));
340 priv->metric = (GtkRulerMetric *) &ruler_metrics[metric];
342 g_object_notify (G_OBJECT (ruler), "metric");
344 gtk_ruler_invalidate_ticks (ruler);
348 * gtk_ruler_get_metric:
349 * @ruler: a #GtkRuler
351 * Gets the units used for a #GtkRuler. See gtk_ruler_set_metric().
353 * Return value: the units currently used for @ruler
356 gtk_ruler_get_metric (GtkRuler *ruler)
358 GtkRulerPrivate *priv;
361 g_return_val_if_fail (GTK_IS_RULER (ruler), 0);
365 for (i = 0; i < G_N_ELEMENTS (ruler_metrics); i++)
366 if (priv->metric == &ruler_metrics[i])
369 g_assert_not_reached ();
375 * gtk_ruler_set_range:
376 * @ruler: the gtkruler
377 * @lower: the lower limit of the ruler
378 * @upper: the upper limit of the ruler
379 * @position: the mark on the ruler
380 * @max_size: the maximum size of the ruler used when calculating the space to
383 * This sets the range of the ruler.
386 gtk_ruler_set_range (GtkRuler *ruler,
392 GtkRulerPrivate *priv;
394 g_return_if_fail (GTK_IS_RULER (ruler));
398 g_object_freeze_notify (G_OBJECT (ruler));
399 if (priv->lower != lower)
402 g_object_notify (G_OBJECT (ruler), "lower");
404 if (priv->upper != upper)
407 g_object_notify (G_OBJECT (ruler), "upper");
409 if (priv->position != position)
411 priv->position = position;
412 g_object_notify (G_OBJECT (ruler), "position");
414 if (priv->max_size != max_size)
416 priv->max_size = max_size;
417 g_object_notify (G_OBJECT (ruler), "max-size");
419 g_object_thaw_notify (G_OBJECT (ruler));
421 gtk_ruler_invalidate_ticks (ruler);
425 * gtk_ruler_get_range:
426 * @ruler: a #GtkRuler
427 * @lower: (allow-none): location to store lower limit of the ruler, or %NULL
428 * @upper: (allow-none): location to store upper limit of the ruler, or %NULL
429 * @position: (allow-none): location to store the current position of the mark on the ruler, or %NULL
430 * @max_size: location to store the maximum size of the ruler used when calculating
431 * the space to leave for the text, or %NULL.
433 * Retrieves values indicating the range and current position of a #GtkRuler.
434 * See gtk_ruler_set_range().
437 gtk_ruler_get_range (GtkRuler *ruler,
443 GtkRulerPrivate *priv;
445 g_return_if_fail (GTK_IS_RULER (ruler));
450 *lower = priv->lower;
452 *upper = priv->upper;
454 *position = priv->position;
456 *max_size = priv->max_size;
460 gtk_ruler_draw_ticks (GtkRuler *ruler)
462 GtkRulerPrivate *priv = ruler->priv;
465 g_return_if_fail (GTK_IS_RULER (ruler));
467 if (priv->backing_store == NULL)
470 cr = cairo_create (priv->backing_store);
472 if (GTK_RULER_GET_CLASS (ruler)->draw_ticks)
473 GTK_RULER_GET_CLASS (ruler)->draw_ticks (ruler, cr);
479 gtk_ruler_realize (GtkWidget *widget)
481 GtkAllocation allocation;
484 GdkWindowAttr attributes;
485 gint attributes_mask;
487 ruler = GTK_RULER (widget);
489 gtk_widget_set_realized (widget, TRUE);
491 gtk_widget_get_allocation (widget, &allocation);
493 attributes.window_type = GDK_WINDOW_CHILD;
494 attributes.x = allocation.x;
495 attributes.y = allocation.y;
496 attributes.width = allocation.width;
497 attributes.height = allocation.height;
498 attributes.wclass = GDK_INPUT_OUTPUT;
499 attributes.visual = gtk_widget_get_visual (widget);
500 attributes.event_mask = gtk_widget_get_events (widget);
501 attributes.event_mask |= (GDK_EXPOSURE_MASK |
502 GDK_POINTER_MOTION_MASK |
503 GDK_POINTER_MOTION_HINT_MASK);
505 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
507 window = gdk_window_new (gtk_widget_get_parent_window (widget),
508 &attributes, attributes_mask);
509 gtk_widget_set_window (widget, window);
510 gdk_window_set_user_data (window, ruler);
512 gtk_widget_style_attach (widget);
513 gtk_style_set_background (gtk_widget_get_style (widget),
514 window, GTK_STATE_ACTIVE);
516 gtk_ruler_make_pixmap (ruler);
520 gtk_ruler_unrealize (GtkWidget *widget)
522 GtkRuler *ruler = GTK_RULER (widget);
523 GtkRulerPrivate *priv = ruler->priv;
525 if (priv->backing_store)
527 cairo_surface_destroy (priv->backing_store);
528 priv->backing_store = NULL;
531 GTK_WIDGET_CLASS (gtk_ruler_parent_class)->unrealize (widget);
535 gtk_ruler_size_request (GtkWidget *widget,
536 GtkRequisition *requisition)
538 GtkRuler *ruler = GTK_RULER (widget);
539 GtkRulerPrivate *priv = ruler->priv;
542 style = gtk_widget_get_style (widget);
544 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
546 requisition->width = style->xthickness * 2 + 1;
547 requisition->height = style->ythickness * 2 + RULER_WIDTH;
551 requisition->width = style->xthickness * 2 + RULER_WIDTH;
552 requisition->height = style->ythickness * 2 + 1;
557 gtk_ruler_size_allocate (GtkWidget *widget,
558 GtkAllocation *allocation)
560 GtkRuler *ruler = GTK_RULER (widget);
561 GtkAllocation old_allocation;
564 gtk_widget_get_allocation (widget, &old_allocation);
565 resized = (old_allocation.width != allocation->width ||
566 old_allocation.height != allocation->height);
568 gtk_widget_set_allocation (widget, allocation);
570 if (gtk_widget_get_realized (widget))
572 gdk_window_move_resize (gtk_widget_get_window (widget),
573 allocation->x, allocation->y,
574 allocation->width, allocation->height);
577 gtk_ruler_make_pixmap (ruler);
582 gtk_ruler_motion_notify (GtkWidget *widget,
583 GdkEventMotion *event)
585 GtkAllocation allocation;
586 GtkRuler *ruler = GTK_RULER (widget);
587 GtkRulerPrivate *priv = ruler->priv;
591 gdk_event_request_motions (event);
595 gtk_widget_get_allocation (widget, &allocation);
596 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
597 priv->position = priv->lower + ((priv->upper - priv->lower) * x) / allocation.width;
599 priv->position = priv->lower + ((priv->upper - priv->lower) * y) / allocation.height;
601 g_object_notify (G_OBJECT (ruler), "position");
603 gtk_widget_queue_draw (widget);
609 gtk_ruler_draw (GtkWidget *widget,
612 GtkRuler *ruler = GTK_RULER (widget);
613 GtkRulerPrivate *priv = ruler->priv;
615 cairo_set_source_surface (cr, priv->backing_store, 0, 0);
618 if (GTK_RULER_GET_CLASS (ruler)->draw_pos)
619 GTK_RULER_GET_CLASS (ruler)->draw_pos (ruler, cr);
625 gtk_ruler_make_pixmap (GtkRuler *ruler)
627 GtkRulerPrivate *priv = ruler->priv;
628 GtkAllocation allocation;
631 widget = GTK_WIDGET (ruler);
633 gtk_widget_get_allocation (widget, &allocation);
635 if (priv->backing_store)
636 cairo_surface_destroy (priv->backing_store);
638 priv->backing_store = gdk_window_create_similar_surface (gtk_widget_get_window (widget),
646 gtk_ruler_draw_ticks (ruler);
650 gtk_ruler_real_draw_ticks (GtkRuler *ruler,
653 GtkWidget *widget = GTK_WIDGET (ruler);
654 GtkRulerPrivate *priv = ruler->priv;
661 gint length, ideal_length;
662 gdouble lower, upper; /* Upper and lower limits, in ruler units */
663 gdouble increment; /* Number of pixels per unit */
664 gint scale; /* Number of units per major unit */
666 gdouble start, end, cur;
674 PangoRectangle logical_rect, ink_rect;
676 style = gtk_widget_get_style (widget);
678 xthickness = style->xthickness;
679 ythickness = style->ythickness;
681 layout = gtk_widget_create_pango_layout (widget, "012456789");
682 pango_layout_get_extents (layout, &ink_rect, &logical_rect);
684 digit_height = PANGO_PIXELS (ink_rect.height) + 2;
685 digit_offset = ink_rect.y;
687 w = gtk_widget_get_allocated_width (widget);
688 h = gtk_widget_get_allocated_height (widget);
690 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
693 height = h - ythickness * 2;
698 height = w - ythickness * 2;
701 #define DETAILE(private) (priv->orientation == GTK_ORIENTATION_HORIZONTAL ? "hruler" : "vruler");
703 gdk_cairo_set_source_color (cr, &style->fg[gtk_widget_get_state (widget)]);
705 gtk_paint_box (style, cr,
706 GTK_STATE_NORMAL, GTK_SHADOW_OUT,
708 priv->orientation == GTK_ORIENTATION_HORIZONTAL ?
713 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
730 upper = priv->upper / priv->metric->pixels_per_unit;
731 lower = priv->lower / priv->metric->pixels_per_unit;
733 if ((upper - lower) == 0)
736 increment = (gdouble) width / (upper - lower);
738 /* determine the scale H
739 * We calculate the text size as for the vruler, so that the result
740 * for the scale looks consistent with an accompanying vruler
742 /* determine the scale V
743 * use the maximum extents of the ruler to determine the largest
744 * possible number to be displayed. Calculate the height in pixels
745 * of this displayed text. Use this height to find a scale which
746 * leaves sufficient room for drawing the ruler.
748 scale = ceil (priv->max_size / priv->metric->pixels_per_unit);
749 g_snprintf (unit_str, sizeof (unit_str), "%d", scale);
751 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
753 text_width = strlen (unit_str) * digit_height + 1;
755 for (scale = 0; scale < MAXIMUM_SCALES; scale++)
756 if (priv->metric->ruler_scale[scale] * fabs(increment) > 2 * text_width)
761 text_height = strlen (unit_str) * digit_height + 1;
763 for (scale = 0; scale < MAXIMUM_SCALES; scale++)
764 if (priv->metric->ruler_scale[scale] * fabs(increment) > 2 * text_height)
768 if (scale == MAXIMUM_SCALES)
769 scale = MAXIMUM_SCALES - 1;
771 /* drawing starts here */
773 for (i = MAXIMUM_SUBDIVIDE - 1; i >= 0; i--)
775 subd_incr = (gdouble) priv->metric->ruler_scale[scale] /
776 (gdouble) priv->metric->subdivide[i];
777 if (subd_incr * fabs(increment) <= MINIMUM_INCR)
780 /* Calculate the length of the tickmarks. Make sure that
781 * this length increases for each set of ticks
783 ideal_length = height / (i + 1) - 1;
784 if (ideal_length > ++length)
785 length = ideal_length;
789 start = floor (lower / subd_incr) * subd_incr;
790 end = ceil (upper / subd_incr) * subd_incr;
794 start = floor (upper / subd_incr) * subd_incr;
795 end = ceil (lower / subd_incr) * subd_incr;
798 for (cur = start; cur <= end; cur += subd_incr)
800 pos = ROUND ((cur - lower) * increment);
802 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
805 pos, height + ythickness - length,
811 height + xthickness - length, pos,
819 g_snprintf (unit_str, sizeof (unit_str), "%d", (int) cur);
821 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
823 pango_layout_set_text (layout, unit_str, -1);
824 pango_layout_get_extents (layout, &logical_rect, NULL);
826 gtk_paint_layout (style,
828 gtk_widget_get_state (widget),
832 pos + 2, ythickness + PANGO_PIXELS (logical_rect.y - digit_offset),
837 for (j = 0; j < (int) strlen (unit_str); j++)
839 pango_layout_set_text (layout, unit_str + j, 1);
840 pango_layout_get_extents (layout, NULL, &logical_rect);
842 gtk_paint_layout (style,
844 gtk_widget_get_state (widget),
849 pos + digit_height * j + 2 + PANGO_PIXELS (logical_rect.y - digit_offset),
860 g_object_unref (layout);
864 gtk_ruler_real_draw_pos (GtkRuler *ruler,
867 GtkWidget *widget = GTK_WIDGET (ruler);
868 GtkRulerPrivate *priv = ruler->priv;
870 gint x, y, width, height;
871 gint bs_width, bs_height;
876 style = gtk_widget_get_style (widget);
877 xthickness = style->xthickness;
878 ythickness = style->ythickness;
879 width = gtk_widget_get_allocated_width (widget);
880 height = gtk_widget_get_allocated_height (widget);
882 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
884 height -= ythickness * 2;
886 bs_width = height / 2 + 2;
887 bs_width |= 1; /* make sure it's odd */
888 bs_height = bs_width / 2 + 1;
892 width -= xthickness * 2;
894 bs_height = width / 2 + 2;
895 bs_height |= 1; /* make sure it's odd */
896 bs_width = bs_height / 2 + 1;
899 if ((bs_width > 0) && (bs_height > 0))
901 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
903 increment = (gdouble) width / (priv->upper - priv->lower);
905 x = ROUND ((priv->position - priv->lower) * increment) + (xthickness - bs_width) / 2 - 1;
906 y = (height + bs_height) / 2 + ythickness;
910 increment = (gdouble) height / (priv->upper - priv->lower);
912 x = (width + bs_width) / 2 + xthickness;
913 y = ROUND ((priv->position - priv->lower) * increment) + (ythickness - bs_height) / 2 - 1;
916 gdk_cairo_set_source_color (cr, &style->fg[gtk_widget_get_state (widget)]);
918 cairo_move_to (cr, x, y);
920 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
922 cairo_line_to (cr, x + bs_width / 2.0, y + bs_height);
923 cairo_line_to (cr, x + bs_width, y);
927 cairo_line_to (cr, x + bs_width, y + bs_height / 2.0);
928 cairo_line_to (cr, x, y + bs_height);