1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 * Copyright (C) 2001 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gtkmarshalers.h"
33 #include "gdk/gdkkeysyms.h"
34 #include "gtkbindings.h"
35 #include "gtkprivate.h"
39 #define MAX_DIGITS (64) /* don't change this,
40 * a) you don't need to and
41 * b) you might cause buffer owerflows in
42 * unrelated code portions otherwise
45 #define GTK_SCALE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SCALE, GtkScalePrivate))
47 typedef struct _GtkScalePrivate GtkScalePrivate;
49 struct _GtkScalePrivate
66 static guint signals[LAST_SIGNAL];
67 static GtkRangeClass *parent_class = NULL;
69 static void gtk_scale_class_init (GtkScaleClass *klass);
70 static void gtk_scale_init (GtkScale *scale);
71 static void gtk_scale_set_property (GObject *object,
75 static void gtk_scale_get_property (GObject *object,
79 static void gtk_scale_style_set (GtkWidget *widget,
81 static void gtk_scale_get_range_border (GtkRange *range,
83 static void gtk_scale_finalize (GObject *object);
84 static void gtk_scale_screen_changed (GtkWidget *widget,
85 GdkScreen *old_screen);
88 gtk_scale_get_type (void)
90 static GType scale_type = 0;
94 static const GTypeInfo scale_info =
96 sizeof (GtkScaleClass),
98 NULL, /* base_finalize */
99 (GClassInitFunc) gtk_scale_class_init,
100 NULL, /* class_finalize */
101 NULL, /* class_data */
104 (GInstanceInitFunc) gtk_scale_init,
105 NULL, /* value_table */
108 scale_type = g_type_register_static (GTK_TYPE_RANGE, "GtkScale",
109 &scale_info, G_TYPE_FLAG_ABSTRACT);
116 single_string_accumulator (GSignalInvocationHint *ihint,
118 const GValue *handler_return,
121 gboolean continue_emission;
124 str = g_value_get_string (handler_return);
125 g_value_set_string (return_accu, str);
126 continue_emission = str == NULL;
128 return continue_emission;
132 #define add_slider_binding(binding_set, keyval, mask, scroll) \
133 gtk_binding_entry_add_signal (binding_set, keyval, mask, \
135 GTK_TYPE_SCROLL_TYPE, scroll)
138 gtk_scale_class_init (GtkScaleClass *class)
140 GObjectClass *gobject_class;
141 GtkWidgetClass *widget_class;
142 GtkRangeClass *range_class;
143 GtkBindingSet *binding_set;
145 gobject_class = G_OBJECT_CLASS (class);
146 range_class = (GtkRangeClass*) class;
147 widget_class = (GtkWidgetClass*) class;
149 parent_class = g_type_class_peek_parent (class);
151 gobject_class->set_property = gtk_scale_set_property;
152 gobject_class->get_property = gtk_scale_get_property;
153 gobject_class->finalize = gtk_scale_finalize;
155 widget_class->style_set = gtk_scale_style_set;
156 widget_class->screen_changed = gtk_scale_screen_changed;
158 range_class->get_range_border = gtk_scale_get_range_border;
160 signals[FORMAT_VALUE] =
161 g_signal_new ("format_value",
162 G_TYPE_FROM_CLASS (gobject_class),
164 G_STRUCT_OFFSET (GtkScaleClass, format_value),
165 single_string_accumulator, NULL,
166 _gtk_marshal_STRING__DOUBLE,
170 g_object_class_install_property (gobject_class,
172 g_param_spec_int ("digits",
174 P_("The number of decimal places that are displayed in the value"),
178 GTK_PARAM_READWRITE));
180 g_object_class_install_property (gobject_class,
182 g_param_spec_boolean ("draw-value",
184 P_("Whether the current value is displayed as a string next to the slider"),
186 GTK_PARAM_READWRITE));
188 g_object_class_install_property (gobject_class,
190 g_param_spec_enum ("value-pos",
191 P_("Value Position"),
192 P_("The position in which the current value is displayed"),
193 GTK_TYPE_POSITION_TYPE,
195 GTK_PARAM_READWRITE));
197 gtk_widget_class_install_style_property (widget_class,
198 g_param_spec_int ("slider-length",
200 P_("Length of scale's slider"),
204 GTK_PARAM_READABLE));
206 gtk_widget_class_install_style_property (widget_class,
207 g_param_spec_int ("value-spacing",
209 P_("Space between value text and the slider/trough area"),
213 GTK_PARAM_READABLE));
215 /* All bindings (even arrow keys) are on both h/v scale, because
216 * blind users etc. don't care about scale orientation.
219 binding_set = gtk_binding_set_by_class (class);
221 add_slider_binding (binding_set, GDK_Left, 0,
222 GTK_SCROLL_STEP_LEFT);
224 add_slider_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
225 GTK_SCROLL_PAGE_LEFT);
227 add_slider_binding (binding_set, GDK_KP_Left, 0,
228 GTK_SCROLL_STEP_LEFT);
230 add_slider_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
231 GTK_SCROLL_PAGE_LEFT);
233 add_slider_binding (binding_set, GDK_Right, 0,
234 GTK_SCROLL_STEP_RIGHT);
236 add_slider_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
237 GTK_SCROLL_PAGE_RIGHT);
239 add_slider_binding (binding_set, GDK_KP_Right, 0,
240 GTK_SCROLL_STEP_RIGHT);
242 add_slider_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
243 GTK_SCROLL_PAGE_RIGHT);
245 add_slider_binding (binding_set, GDK_Up, 0,
248 add_slider_binding (binding_set, GDK_Up, GDK_CONTROL_MASK,
251 add_slider_binding (binding_set, GDK_KP_Up, 0,
254 add_slider_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK,
257 add_slider_binding (binding_set, GDK_Down, 0,
258 GTK_SCROLL_STEP_DOWN);
260 add_slider_binding (binding_set, GDK_Down, GDK_CONTROL_MASK,
261 GTK_SCROLL_PAGE_DOWN);
263 add_slider_binding (binding_set, GDK_KP_Down, 0,
264 GTK_SCROLL_STEP_DOWN);
266 add_slider_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK,
267 GTK_SCROLL_PAGE_DOWN);
269 add_slider_binding (binding_set, GDK_Page_Up, 0,
270 GTK_SCROLL_PAGE_LEFT);
272 add_slider_binding (binding_set, GDK_KP_Page_Up, 0,
273 GTK_SCROLL_PAGE_LEFT);
275 add_slider_binding (binding_set, GDK_Page_Up, 0,
278 add_slider_binding (binding_set, GDK_KP_Page_Up, 0,
281 add_slider_binding (binding_set, GDK_Page_Down, 0,
282 GTK_SCROLL_PAGE_RIGHT);
284 add_slider_binding (binding_set, GDK_KP_Page_Down, 0,
285 GTK_SCROLL_PAGE_RIGHT);
287 add_slider_binding (binding_set, GDK_Page_Down, 0,
288 GTK_SCROLL_PAGE_DOWN);
290 add_slider_binding (binding_set, GDK_KP_Page_Down, 0,
291 GTK_SCROLL_PAGE_DOWN);
293 /* Logical bindings (vs. visual bindings above) */
295 add_slider_binding (binding_set, GDK_plus, 0,
296 GTK_SCROLL_STEP_FORWARD);
298 add_slider_binding (binding_set, GDK_minus, 0,
299 GTK_SCROLL_STEP_BACKWARD);
301 add_slider_binding (binding_set, GDK_plus, GDK_CONTROL_MASK,
302 GTK_SCROLL_PAGE_FORWARD);
304 add_slider_binding (binding_set, GDK_minus, GDK_CONTROL_MASK,
305 GTK_SCROLL_PAGE_BACKWARD);
308 add_slider_binding (binding_set, GDK_KP_Add, 0,
309 GTK_SCROLL_STEP_FORWARD);
311 add_slider_binding (binding_set, GDK_KP_Subtract, 0,
312 GTK_SCROLL_STEP_BACKWARD);
314 add_slider_binding (binding_set, GDK_KP_Add, GDK_CONTROL_MASK,
315 GTK_SCROLL_PAGE_FORWARD);
317 add_slider_binding (binding_set, GDK_KP_Subtract, GDK_CONTROL_MASK,
318 GTK_SCROLL_PAGE_BACKWARD);
321 add_slider_binding (binding_set, GDK_Home, 0,
324 add_slider_binding (binding_set, GDK_KP_Home, 0,
327 add_slider_binding (binding_set, GDK_End, 0,
330 add_slider_binding (binding_set, GDK_KP_End, 0,
333 g_type_class_add_private (gobject_class, sizeof (GtkScalePrivate));
337 gtk_scale_set_property (GObject *object,
344 scale = GTK_SCALE (object);
349 gtk_scale_set_digits (scale, g_value_get_int (value));
351 case PROP_DRAW_VALUE:
352 gtk_scale_set_draw_value (scale, g_value_get_boolean (value));
355 gtk_scale_set_value_pos (scale, g_value_get_enum (value));
358 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
364 gtk_scale_get_property (GObject *object,
371 scale = GTK_SCALE (object);
376 g_value_set_int (value, scale->digits);
378 case PROP_DRAW_VALUE:
379 g_value_set_boolean (value, scale->draw_value);
382 g_value_set_enum (value, scale->value_pos);
385 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
391 gtk_scale_init (GtkScale *scale)
395 range = GTK_RANGE (scale);
397 GTK_WIDGET_SET_FLAGS (scale, GTK_CAN_FOCUS);
399 range->slider_size_fixed = TRUE;
400 range->has_stepper_a = FALSE;
401 range->has_stepper_b = FALSE;
402 range->has_stepper_c = FALSE;
403 range->has_stepper_d = FALSE;
405 scale->draw_value = TRUE;
406 scale->value_pos = GTK_POS_TOP;
408 range->round_digits = scale->digits;
412 gtk_scale_set_digits (GtkScale *scale,
417 g_return_if_fail (GTK_IS_SCALE (scale));
419 range = GTK_RANGE (scale);
421 digits = CLAMP (digits, -1, MAX_DIGITS);
423 if (scale->digits != digits)
425 scale->digits = digits;
426 if (scale->draw_value)
427 range->round_digits = digits;
429 _gtk_scale_clear_layout (scale);
430 gtk_widget_queue_resize (GTK_WIDGET (scale));
432 g_object_notify (G_OBJECT (scale), "digits");
437 gtk_scale_get_digits (GtkScale *scale)
439 g_return_val_if_fail (GTK_IS_SCALE (scale), -1);
441 return scale->digits;
445 gtk_scale_set_draw_value (GtkScale *scale,
448 g_return_if_fail (GTK_IS_SCALE (scale));
450 draw_value = draw_value != FALSE;
452 if (scale->draw_value != draw_value)
454 scale->draw_value = draw_value;
456 GTK_RANGE (scale)->round_digits = scale->digits;
458 GTK_RANGE (scale)->round_digits = -1;
460 _gtk_scale_clear_layout (scale);
462 gtk_widget_queue_resize (GTK_WIDGET (scale));
464 g_object_notify (G_OBJECT (scale), "draw_value");
469 gtk_scale_get_draw_value (GtkScale *scale)
471 g_return_val_if_fail (GTK_IS_SCALE (scale), FALSE);
473 return scale->draw_value;
477 gtk_scale_set_value_pos (GtkScale *scale,
480 g_return_if_fail (GTK_IS_SCALE (scale));
482 if (scale->value_pos != pos)
484 scale->value_pos = pos;
486 _gtk_scale_clear_layout (scale);
487 if (GTK_WIDGET_VISIBLE (scale) && GTK_WIDGET_MAPPED (scale))
488 gtk_widget_queue_resize (GTK_WIDGET (scale));
490 g_object_notify (G_OBJECT (scale), "value_pos");
495 gtk_scale_get_value_pos (GtkScale *scale)
497 g_return_val_if_fail (GTK_IS_SCALE (scale), 0);
499 return scale->value_pos;
503 gtk_scale_get_range_border (GtkRange *range,
510 widget = GTK_WIDGET (range);
511 scale = GTK_SCALE (range);
513 _gtk_scale_get_value_size (scale, &w, &h);
520 if (scale->draw_value)
523 gtk_widget_style_get (widget, "value_spacing", &value_spacing, NULL);
525 switch (scale->value_pos)
528 border->left += w + value_spacing;
531 border->right += w + value_spacing;
534 border->top += h + value_spacing;
537 border->bottom += h + value_spacing;
543 /* FIXME this could actually be static at the moment. */
545 _gtk_scale_get_value_size (GtkScale *scale,
551 g_return_if_fail (GTK_IS_SCALE (scale));
553 if (scale->draw_value)
556 PangoRectangle logical_rect;
559 range = GTK_RANGE (scale);
561 layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
563 txt = _gtk_scale_format_value (scale, range->adjustment->lower);
564 pango_layout_set_text (layout, txt, -1);
567 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
570 *width = logical_rect.width;
572 *height = logical_rect.height;
574 txt = _gtk_scale_format_value (scale, range->adjustment->upper);
575 pango_layout_set_text (layout, txt, -1);
578 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
581 *width = MAX (*width, logical_rect.width);
583 *height = MAX (*height, logical_rect.height);
585 g_object_unref (layout);
598 gtk_scale_style_set (GtkWidget *widget,
604 range = GTK_RANGE (widget);
606 gtk_widget_style_get (widget,
607 "slider_length", &slider_length,
610 range->min_slider_size = slider_length;
612 _gtk_scale_clear_layout (GTK_SCALE (widget));
614 (* GTK_WIDGET_CLASS (parent_class)->style_set) (widget, previous);
618 gtk_scale_screen_changed (GtkWidget *widget,
619 GdkScreen *old_screen)
621 _gtk_scale_clear_layout (GTK_SCALE (widget));
625 * _gtk_scale_format_value:
626 * @scale: a #GtkScale
627 * @value: adjustment value
629 * Emits "format_value" signal to format the value, if no user
630 * signal handlers, falls back to a default format.
632 * Return value: formatted value
635 _gtk_scale_format_value (GtkScale *scale,
640 g_signal_emit (scale,
641 signals[FORMAT_VALUE],
649 return g_strdup_printf ("%0.*f", scale->digits,
654 gtk_scale_finalize (GObject *object)
658 g_return_if_fail (GTK_IS_SCALE (object));
660 scale = GTK_SCALE (object);
662 _gtk_scale_clear_layout (scale);
664 G_OBJECT_CLASS (parent_class)->finalize (object);
668 * gtk_scale_get_layout:
669 * @scale: A #GtkScale
671 * Gets the #PangoLayout used to display the scale. The returned object
672 * is owned by the scale so does not need to be freed by the caller.
674 * Return value: the #PangoLayout for this scale, or %NULL if the draw_value property
680 gtk_scale_get_layout (GtkScale *scale)
682 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
685 g_return_val_if_fail (GTK_IS_SCALE (scale), NULL);
689 if (scale->draw_value)
690 priv->layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
693 if (scale->draw_value)
695 txt = _gtk_scale_format_value (scale,
696 GTK_RANGE (scale)->adjustment->value);
697 pango_layout_set_text (priv->layout, txt, -1);
705 * gtk_scale_get_layout_offsets:
706 * @scale: a #GtkScale
707 * @x: location to store X offset of layout, or %NULL
708 * @y: location to store Y offset of layout, or %NULL
710 * Obtains the coordinates where the scale will draw the #PangoLayout
711 * representing the text in the scale. Remember
712 * when using the #PangoLayout function you need to convert to
713 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
715 * If the draw_value property is %FALSE, the return values are
721 gtk_scale_get_layout_offsets (GtkScale *scale,
725 gint local_x, local_y;
727 g_return_if_fail (GTK_IS_SCALE (scale));
729 if (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets)
730 (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets) (scale, &local_x, &local_y);
739 void _gtk_scale_clear_layout (GtkScale *scale)
741 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
743 g_return_if_fail (GTK_IS_SCALE (scale));
747 g_object_unref (priv->layout);
752 #define __GTK_SCALE_C__
753 #include "gtkaliasdef.c"