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 "gtkprivate.h"
37 #define RULER_WIDTH 14
38 #define MINIMUM_INCR 5
39 #define MAXIMUM_SUBDIVIDE 5
40 #define MAXIMUM_SCALES 10
42 #define ROUND(x) ((int) ((x) + 0.5))
44 struct _GtkRulerPrivate
46 GtkOrientation orientation;
47 GtkRulerMetric *metric;
49 GdkPixmap *backing_store;
55 gdouble lower; /* The upper limit of the ruler (in points) */
56 gdouble max_size; /* The maximum size of the ruler */
57 gdouble position; /* The position of the mark on the ruler */
58 gdouble upper; /* The lower limit of the ruler */
72 static void gtk_ruler_set_property (GObject *object,
76 static void gtk_ruler_get_property (GObject *object,
80 static void gtk_ruler_realize (GtkWidget *widget);
81 static void gtk_ruler_unrealize (GtkWidget *widget);
82 static void gtk_ruler_size_request (GtkWidget *widget,
83 GtkRequisition *requisition);
84 static void gtk_ruler_size_allocate (GtkWidget *widget,
85 GtkAllocation *allocation);
86 static gboolean gtk_ruler_motion_notify (GtkWidget *widget,
87 GdkEventMotion *event);
88 static gboolean gtk_ruler_expose (GtkWidget *widget,
89 GdkEventExpose *event);
90 static void gtk_ruler_make_pixmap (GtkRuler *ruler);
91 static void gtk_ruler_real_draw_ticks (GtkRuler *ruler);
92 static void gtk_ruler_real_draw_pos (GtkRuler *ruler);
95 static const GtkRulerMetric ruler_metrics[] =
97 { "Pixel", "Pi", 1.0, { 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000 }, { 1, 5, 10, 50, 100 }},
98 { "Inches", "In", 72.0, { 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 }, { 1, 2, 4, 8, 16 }},
99 { "Centimeters", "Cn", 28.35, { 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000 }, { 1, 5, 10, 50, 100 }},
103 G_DEFINE_TYPE_WITH_CODE (GtkRuler, gtk_ruler, GTK_TYPE_WIDGET,
104 G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE,
109 gtk_ruler_class_init (GtkRulerClass *class)
111 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
112 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
114 gobject_class->set_property = gtk_ruler_set_property;
115 gobject_class->get_property = gtk_ruler_get_property;
117 widget_class->realize = gtk_ruler_realize;
118 widget_class->unrealize = gtk_ruler_unrealize;
119 widget_class->size_request = gtk_ruler_size_request;
120 widget_class->size_allocate = gtk_ruler_size_allocate;
121 widget_class->motion_notify_event = gtk_ruler_motion_notify;
122 widget_class->expose_event = gtk_ruler_expose;
124 class->draw_ticks = gtk_ruler_real_draw_ticks;
125 class->draw_pos = gtk_ruler_real_draw_pos;
127 g_object_class_override_property (gobject_class,
131 g_object_class_install_property (gobject_class,
133 g_param_spec_double ("lower",
135 P_("Lower limit of ruler"),
139 GTK_PARAM_READWRITE));
141 g_object_class_install_property (gobject_class,
143 g_param_spec_double ("upper",
145 P_("Upper limit of ruler"),
149 GTK_PARAM_READWRITE));
151 g_object_class_install_property (gobject_class,
153 g_param_spec_double ("position",
155 P_("Position of mark on the ruler"),
159 GTK_PARAM_READWRITE));
161 g_object_class_install_property (gobject_class,
163 g_param_spec_double ("max-size",
165 P_("Maximum size of the ruler"),
169 GTK_PARAM_READWRITE));
173 * The metric used for the ruler.
177 g_object_class_install_property (gobject_class,
179 g_param_spec_enum ("metric",
181 P_("The metric used for the ruler"),
182 GTK_TYPE_METRIC_TYPE,
184 GTK_PARAM_READWRITE));
186 g_type_class_add_private (gobject_class, sizeof (GtkRulerPrivate));
190 gtk_ruler_init (GtkRuler *ruler)
192 GtkRulerPrivate *priv;
194 ruler->priv = G_TYPE_INSTANCE_GET_PRIVATE (ruler,
199 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
201 priv->backing_store = NULL;
204 priv->slider_size = 0;
210 gtk_ruler_set_metric (ruler, GTK_PIXELS);
214 gtk_ruler_set_property (GObject *object,
219 GtkRuler *ruler = GTK_RULER (object);
220 GtkRulerPrivate *priv = ruler->priv;
224 case PROP_ORIENTATION:
225 priv->orientation = g_value_get_enum (value);
226 gtk_widget_queue_resize (GTK_WIDGET (ruler));
229 gtk_ruler_set_range (ruler, g_value_get_double (value), priv->upper,
230 priv->position, priv->max_size);
233 gtk_ruler_set_range (ruler, priv->lower, g_value_get_double (value),
234 priv->position, priv->max_size);
237 gtk_ruler_set_range (ruler, priv->lower, priv->upper,
238 g_value_get_double (value), priv->max_size);
241 gtk_ruler_set_range (ruler, priv->lower, priv->upper,
242 priv->position, g_value_get_double (value));
245 gtk_ruler_set_metric (ruler, g_value_get_enum (value));
248 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
254 gtk_ruler_get_property (GObject *object,
259 GtkRuler *ruler = GTK_RULER (object);
260 GtkRulerPrivate *priv = ruler->priv;
264 case PROP_ORIENTATION:
265 g_value_set_enum (value, priv->orientation);
268 g_value_set_double (value, priv->lower);
271 g_value_set_double (value, priv->upper);
274 g_value_set_double (value, priv->position);
277 g_value_set_double (value, priv->max_size);
280 g_value_set_enum (value, gtk_ruler_get_metric (ruler));
283 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
290 * @orientation: the ruler's orientation.
292 * Creates a new #GtkRuler with the given orientation.
294 * Return value: a new #GtkRuler.
299 gtk_ruler_new (GtkOrientation orientation)
301 return g_object_new (GTK_TYPE_RULER,
302 "orientation", orientation,
307 gtk_ruler_set_metric (GtkRuler *ruler,
308 GtkMetricType metric)
310 GtkRulerPrivate *priv;
312 g_return_if_fail (GTK_IS_RULER (ruler));
316 priv->metric = (GtkRulerMetric *) &ruler_metrics[metric];
318 if (gtk_widget_is_drawable (GTK_WIDGET (ruler)))
319 gtk_widget_queue_draw (GTK_WIDGET (ruler));
321 g_object_notify (G_OBJECT (ruler), "metric");
325 * gtk_ruler_get_metric:
326 * @ruler: a #GtkRuler
328 * Gets the units used for a #GtkRuler. See gtk_ruler_set_metric().
330 * Return value: the units currently used for @ruler
333 gtk_ruler_get_metric (GtkRuler *ruler)
335 GtkRulerPrivate *priv;
338 g_return_val_if_fail (GTK_IS_RULER (ruler), 0);
342 for (i = 0; i < G_N_ELEMENTS (ruler_metrics); i++)
343 if (priv->metric == &ruler_metrics[i])
346 g_assert_not_reached ();
352 * gtk_ruler_set_range:
353 * @ruler: the gtkruler
354 * @lower: the lower limit of the ruler
355 * @upper: the upper limit of the ruler
356 * @position: the mark on the ruler
357 * @max_size: the maximum size of the ruler used when calculating the space to
360 * This sets the range of the ruler.
363 gtk_ruler_set_range (GtkRuler *ruler,
369 GtkRulerPrivate *priv;
371 g_return_if_fail (GTK_IS_RULER (ruler));
375 g_object_freeze_notify (G_OBJECT (ruler));
376 if (priv->lower != lower)
379 g_object_notify (G_OBJECT (ruler), "lower");
381 if (priv->upper != upper)
384 g_object_notify (G_OBJECT (ruler), "upper");
386 if (priv->position != position)
388 priv->position = position;
389 g_object_notify (G_OBJECT (ruler), "position");
391 if (priv->max_size != max_size)
393 priv->max_size = max_size;
394 g_object_notify (G_OBJECT (ruler), "max-size");
396 g_object_thaw_notify (G_OBJECT (ruler));
398 if (gtk_widget_is_drawable (GTK_WIDGET (ruler)))
399 gtk_widget_queue_draw (GTK_WIDGET (ruler));
403 * gtk_ruler_get_range:
404 * @ruler: a #GtkRuler
405 * @lower: (allow-none): location to store lower limit of the ruler, or %NULL
406 * @upper: (allow-none): location to store upper limit of the ruler, or %NULL
407 * @position: (allow-none): location to store the current position of the mark on the ruler, or %NULL
408 * @max_size: location to store the maximum size of the ruler used when calculating
409 * the space to leave for the text, or %NULL.
411 * Retrieves values indicating the range and current position of a #GtkRuler.
412 * See gtk_ruler_set_range().
415 gtk_ruler_get_range (GtkRuler *ruler,
421 GtkRulerPrivate *priv;
423 g_return_if_fail (GTK_IS_RULER (ruler));
428 *lower = priv->lower;
430 *upper = priv->upper;
432 *position = priv->position;
434 *max_size = priv->max_size;
438 gtk_ruler_draw_ticks (GtkRuler *ruler)
440 g_return_if_fail (GTK_IS_RULER (ruler));
442 if (GTK_RULER_GET_CLASS (ruler)->draw_ticks)
443 GTK_RULER_GET_CLASS (ruler)->draw_ticks (ruler);
447 gtk_ruler_draw_pos (GtkRuler *ruler)
449 g_return_if_fail (GTK_IS_RULER (ruler));
451 if (GTK_RULER_GET_CLASS (ruler)->draw_pos)
452 GTK_RULER_GET_CLASS (ruler)->draw_pos (ruler);
457 gtk_ruler_realize (GtkWidget *widget)
460 GdkWindowAttr attributes;
461 gint attributes_mask;
463 ruler = GTK_RULER (widget);
465 gtk_widget_set_realized (widget, TRUE);
467 attributes.window_type = GDK_WINDOW_CHILD;
468 attributes.x = widget->allocation.x;
469 attributes.y = widget->allocation.y;
470 attributes.width = widget->allocation.width;
471 attributes.height = widget->allocation.height;
472 attributes.wclass = GDK_INPUT_OUTPUT;
473 attributes.visual = gtk_widget_get_visual (widget);
474 attributes.colormap = gtk_widget_get_colormap (widget);
475 attributes.event_mask = gtk_widget_get_events (widget);
476 attributes.event_mask |= (GDK_EXPOSURE_MASK |
477 GDK_POINTER_MOTION_MASK |
478 GDK_POINTER_MOTION_HINT_MASK);
480 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
482 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
483 gdk_window_set_user_data (widget->window, ruler);
485 widget->style = gtk_style_attach (widget->style, widget->window);
486 gtk_style_set_background (widget->style, widget->window, GTK_STATE_ACTIVE);
488 gtk_ruler_make_pixmap (ruler);
492 gtk_ruler_unrealize (GtkWidget *widget)
494 GtkRuler *ruler = GTK_RULER (widget);
495 GtkRulerPrivate *priv = ruler->priv;
497 if (priv->backing_store)
499 g_object_unref (priv->backing_store);
500 priv->backing_store = NULL;
503 GTK_WIDGET_CLASS (gtk_ruler_parent_class)->unrealize (widget);
507 gtk_ruler_size_request (GtkWidget *widget,
508 GtkRequisition *requisition)
510 GtkRuler *ruler = GTK_RULER (widget);
511 GtkRulerPrivate *priv = ruler->priv;
513 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
515 requisition->width = widget->style->xthickness * 2 + 1;
516 requisition->height = widget->style->ythickness * 2 + RULER_WIDTH;
520 requisition->width = widget->style->xthickness * 2 + RULER_WIDTH;
521 requisition->height = widget->style->ythickness * 2 + 1;
526 gtk_ruler_size_allocate (GtkWidget *widget,
527 GtkAllocation *allocation)
529 GtkRuler *ruler = GTK_RULER (widget);
531 widget->allocation = *allocation;
533 if (gtk_widget_get_realized (widget))
535 gdk_window_move_resize (widget->window,
536 allocation->x, allocation->y,
537 allocation->width, allocation->height);
539 gtk_ruler_make_pixmap (ruler);
544 gtk_ruler_motion_notify (GtkWidget *widget,
545 GdkEventMotion *event)
547 GtkRuler *ruler = GTK_RULER (widget);
548 GtkRulerPrivate *priv = ruler->priv;
552 gdk_event_request_motions (event);
556 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
557 priv->position = priv->lower + ((priv->upper - priv->lower) * x) / widget->allocation.width;
559 priv->position = priv->lower + ((priv->upper - priv->lower) * y) / widget->allocation.height;
561 g_object_notify (G_OBJECT (ruler), "position");
563 /* Make sure the ruler has been allocated already */
564 if (priv->backing_store != NULL)
565 gtk_ruler_draw_pos (ruler);
571 gtk_ruler_expose (GtkWidget *widget,
572 GdkEventExpose *event)
574 if (gtk_widget_is_drawable (widget))
576 GtkRuler *ruler = GTK_RULER (widget);
577 GtkRulerPrivate *priv = ruler->priv;
580 gtk_ruler_draw_ticks (ruler);
582 cr = gdk_cairo_create (widget->window);
583 gdk_cairo_set_source_pixmap (cr, priv->backing_store, 0, 0);
584 gdk_cairo_rectangle (cr, &event->area);
588 gtk_ruler_draw_pos (ruler);
595 gtk_ruler_make_pixmap (GtkRuler *ruler)
597 GtkRulerPrivate *priv = ruler->priv;
602 widget = GTK_WIDGET (ruler);
604 if (priv->backing_store)
606 gdk_drawable_get_size (priv->backing_store, &width, &height);
607 if ((width == widget->allocation.width) &&
608 (height == widget->allocation.height))
611 g_object_unref (priv->backing_store);
614 priv->backing_store = gdk_pixmap_new (widget->window,
615 widget->allocation.width,
616 widget->allocation.height,
624 gtk_ruler_real_draw_ticks (GtkRuler *ruler)
626 GtkWidget *widget = GTK_WIDGET (ruler);
627 GtkRulerPrivate *priv = ruler->priv;
633 gint length, ideal_length;
634 gdouble lower, upper; /* Upper and lower limits, in ruler units */
635 gdouble increment; /* Number of pixels per unit */
636 gint scale; /* Number of units per major unit */
638 gdouble start, end, cur;
646 PangoRectangle logical_rect, ink_rect;
648 if (!gtk_widget_is_drawable (widget))
651 xthickness = widget->style->xthickness;
652 ythickness = widget->style->ythickness;
654 layout = gtk_widget_create_pango_layout (widget, "012456789");
655 pango_layout_get_extents (layout, &ink_rect, &logical_rect);
657 digit_height = PANGO_PIXELS (ink_rect.height) + 2;
658 digit_offset = ink_rect.y;
660 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
662 width = widget->allocation.width;
663 height = widget->allocation.height - ythickness * 2;
667 width = widget->allocation.height;
668 height = widget->allocation.width - ythickness * 2;
671 #define DETAILE(private) (priv->orientation == GTK_ORIENTATION_HORIZONTAL ? "hruler" : "vruler");
673 gtk_paint_box (widget->style, priv->backing_store,
674 GTK_STATE_NORMAL, GTK_SHADOW_OUT,
676 priv->orientation == GTK_ORIENTATION_HORIZONTAL ?
679 widget->allocation.width, widget->allocation.height);
681 cr = gdk_cairo_create (priv->backing_store);
682 gdk_cairo_set_source_color (cr, &widget->style->fg[widget->state]);
684 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
689 widget->allocation.width - 2 * xthickness,
698 widget->allocation.height - 2 * ythickness);
701 upper = priv->upper / priv->metric->pixels_per_unit;
702 lower = priv->lower / priv->metric->pixels_per_unit;
704 if ((upper - lower) == 0)
707 increment = (gdouble) width / (upper - lower);
709 /* determine the scale H
710 * We calculate the text size as for the vruler, so that the result
711 * for the scale looks consistent with an accompanying vruler
713 /* determine the scale V
714 * use the maximum extents of the ruler to determine the largest
715 * possible number to be displayed. Calculate the height in pixels
716 * of this displayed text. Use this height to find a scale which
717 * leaves sufficient room for drawing the ruler.
719 scale = ceil (priv->max_size / priv->metric->pixels_per_unit);
720 g_snprintf (unit_str, sizeof (unit_str), "%d", scale);
722 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
724 text_width = strlen (unit_str) * digit_height + 1;
726 for (scale = 0; scale < MAXIMUM_SCALES; scale++)
727 if (priv->metric->ruler_scale[scale] * fabs(increment) > 2 * text_width)
732 text_height = strlen (unit_str) * digit_height + 1;
734 for (scale = 0; scale < MAXIMUM_SCALES; scale++)
735 if (priv->metric->ruler_scale[scale] * fabs(increment) > 2 * text_height)
739 if (scale == MAXIMUM_SCALES)
740 scale = MAXIMUM_SCALES - 1;
742 /* drawing starts here */
744 for (i = MAXIMUM_SUBDIVIDE - 1; i >= 0; i--)
746 subd_incr = (gdouble) priv->metric->ruler_scale[scale] /
747 (gdouble) priv->metric->subdivide[i];
748 if (subd_incr * fabs(increment) <= MINIMUM_INCR)
751 /* Calculate the length of the tickmarks. Make sure that
752 * this length increases for each set of ticks
754 ideal_length = height / (i + 1) - 1;
755 if (ideal_length > ++length)
756 length = ideal_length;
760 start = floor (lower / subd_incr) * subd_incr;
761 end = ceil (upper / subd_incr) * subd_incr;
765 start = floor (upper / subd_incr) * subd_incr;
766 end = ceil (lower / subd_incr) * subd_incr;
769 for (cur = start; cur <= end; cur += subd_incr)
771 pos = ROUND ((cur - lower) * increment);
773 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
776 pos, height + ythickness - length,
782 height + xthickness - length, pos,
789 g_snprintf (unit_str, sizeof (unit_str), "%d", (int) cur);
791 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
793 pango_layout_set_text (layout, unit_str, -1);
794 pango_layout_get_extents (layout, &logical_rect, NULL);
796 gtk_paint_layout (widget->style,
798 gtk_widget_get_state (widget),
803 pos + 2, ythickness + PANGO_PIXELS (logical_rect.y - digit_offset),
808 for (j = 0; j < (int) strlen (unit_str); j++)
810 pango_layout_set_text (layout, unit_str + j, 1);
811 pango_layout_get_extents (layout, NULL, &logical_rect);
813 gtk_paint_layout (widget->style,
815 gtk_widget_get_state (widget),
821 pos + digit_height * j + 2 + PANGO_PIXELS (logical_rect.y - digit_offset),
833 g_object_unref (layout);
837 gtk_ruler_real_draw_pos (GtkRuler *ruler)
839 GtkWidget *widget = GTK_WIDGET (ruler);
840 GtkRulerPrivate *priv = ruler->priv;
843 gint bs_width, bs_height;
848 if (gtk_widget_is_drawable (widget))
850 xthickness = widget->style->xthickness;
851 ythickness = widget->style->ythickness;
852 width = widget->allocation.width;
853 height = widget->allocation.height;
855 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
857 height -= ythickness * 2;
859 bs_width = height / 2 + 2;
860 bs_width |= 1; /* make sure it's odd */
861 bs_height = bs_width / 2 + 1;
865 width -= xthickness * 2;
867 bs_height = width / 2 + 2;
868 bs_height |= 1; /* make sure it's odd */
869 bs_width = bs_height / 2 + 1;
872 if ((bs_width > 0) && (bs_height > 0))
874 cairo_t *cr = gdk_cairo_create (widget->window);
876 /* If a backing store exists, restore the ruler */
877 if (priv->backing_store) {
878 cairo_t *cr = gdk_cairo_create (widget->window);
880 gdk_cairo_set_source_pixmap (cr, priv->backing_store, 0, 0);
881 cairo_rectangle (cr, priv->xsrc, priv->ysrc, bs_width, bs_height);
887 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
889 increment = (gdouble) width / (priv->upper - priv->lower);
891 x = ROUND ((priv->position - priv->lower) * increment) + (xthickness - bs_width) / 2 - 1;
892 y = (height + bs_height) / 2 + ythickness;
896 increment = (gdouble) height / (priv->upper - priv->lower);
898 x = (width + bs_width) / 2 + xthickness;
899 y = ROUND ((priv->position - priv->lower) * increment) + (ythickness - bs_height) / 2 - 1;
902 gdk_cairo_set_source_color (cr, &widget->style->fg[widget->state]);
904 cairo_move_to (cr, x, y);
906 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
908 cairo_line_to (cr, x + bs_width / 2.0, y + bs_height);
909 cairo_line_to (cr, x + bs_width, y);
913 cairo_line_to (cr, x + bs_width, y + bs_height / 2.0);
914 cairo_line_to (cr, x, y + bs_height);