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];
68 static void gtk_scale_set_property (GObject *object,
72 static void gtk_scale_get_property (GObject *object,
76 static void gtk_scale_style_set (GtkWidget *widget,
78 static void gtk_scale_get_range_border (GtkRange *range,
80 static void gtk_scale_finalize (GObject *object);
81 static void gtk_scale_screen_changed (GtkWidget *widget,
82 GdkScreen *old_screen);
84 G_DEFINE_ABSTRACT_TYPE (GtkScale, gtk_scale, GTK_TYPE_RANGE)
87 single_string_accumulator (GSignalInvocationHint *ihint,
89 const GValue *handler_return,
92 gboolean continue_emission;
95 str = g_value_get_string (handler_return);
96 g_value_set_string (return_accu, str);
97 continue_emission = str == NULL;
99 return continue_emission;
103 #define add_slider_binding(binding_set, keyval, mask, scroll) \
104 gtk_binding_entry_add_signal (binding_set, keyval, mask, \
105 I_("move_slider"), 1, \
106 GTK_TYPE_SCROLL_TYPE, scroll)
109 gtk_scale_class_init (GtkScaleClass *class)
111 GObjectClass *gobject_class;
112 GtkWidgetClass *widget_class;
113 GtkRangeClass *range_class;
114 GtkBindingSet *binding_set;
116 gobject_class = G_OBJECT_CLASS (class);
117 range_class = (GtkRangeClass*) class;
118 widget_class = (GtkWidgetClass*) class;
120 gobject_class->set_property = gtk_scale_set_property;
121 gobject_class->get_property = gtk_scale_get_property;
122 gobject_class->finalize = gtk_scale_finalize;
124 widget_class->style_set = gtk_scale_style_set;
125 widget_class->screen_changed = gtk_scale_screen_changed;
127 range_class->get_range_border = gtk_scale_get_range_border;
129 signals[FORMAT_VALUE] =
130 g_signal_new (I_("format_value"),
131 G_TYPE_FROM_CLASS (gobject_class),
133 G_STRUCT_OFFSET (GtkScaleClass, format_value),
134 single_string_accumulator, NULL,
135 _gtk_marshal_STRING__DOUBLE,
139 g_object_class_install_property (gobject_class,
141 g_param_spec_int ("digits",
143 P_("The number of decimal places that are displayed in the value"),
147 GTK_PARAM_READWRITE));
149 g_object_class_install_property (gobject_class,
151 g_param_spec_boolean ("draw-value",
153 P_("Whether the current value is displayed as a string next to the slider"),
155 GTK_PARAM_READWRITE));
157 g_object_class_install_property (gobject_class,
159 g_param_spec_enum ("value-pos",
160 P_("Value Position"),
161 P_("The position in which the current value is displayed"),
162 GTK_TYPE_POSITION_TYPE,
164 GTK_PARAM_READWRITE));
166 gtk_widget_class_install_style_property (widget_class,
167 g_param_spec_int ("slider-length",
169 P_("Length of scale's slider"),
173 GTK_PARAM_READABLE));
175 gtk_widget_class_install_style_property (widget_class,
176 g_param_spec_int ("value-spacing",
178 P_("Space between value text and the slider/trough area"),
182 GTK_PARAM_READABLE));
184 /* All bindings (even arrow keys) are on both h/v scale, because
185 * blind users etc. don't care about scale orientation.
188 binding_set = gtk_binding_set_by_class (class);
190 add_slider_binding (binding_set, GDK_Left, 0,
191 GTK_SCROLL_STEP_LEFT);
193 add_slider_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
194 GTK_SCROLL_PAGE_LEFT);
196 add_slider_binding (binding_set, GDK_KP_Left, 0,
197 GTK_SCROLL_STEP_LEFT);
199 add_slider_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
200 GTK_SCROLL_PAGE_LEFT);
202 add_slider_binding (binding_set, GDK_Right, 0,
203 GTK_SCROLL_STEP_RIGHT);
205 add_slider_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
206 GTK_SCROLL_PAGE_RIGHT);
208 add_slider_binding (binding_set, GDK_KP_Right, 0,
209 GTK_SCROLL_STEP_RIGHT);
211 add_slider_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
212 GTK_SCROLL_PAGE_RIGHT);
214 add_slider_binding (binding_set, GDK_Up, 0,
217 add_slider_binding (binding_set, GDK_Up, GDK_CONTROL_MASK,
220 add_slider_binding (binding_set, GDK_KP_Up, 0,
223 add_slider_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK,
226 add_slider_binding (binding_set, GDK_Down, 0,
227 GTK_SCROLL_STEP_DOWN);
229 add_slider_binding (binding_set, GDK_Down, GDK_CONTROL_MASK,
230 GTK_SCROLL_PAGE_DOWN);
232 add_slider_binding (binding_set, GDK_KP_Down, 0,
233 GTK_SCROLL_STEP_DOWN);
235 add_slider_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK,
236 GTK_SCROLL_PAGE_DOWN);
238 add_slider_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK,
239 GTK_SCROLL_PAGE_LEFT);
241 add_slider_binding (binding_set, GDK_KP_Page_Up, GDK_CONTROL_MASK,
242 GTK_SCROLL_PAGE_LEFT);
244 add_slider_binding (binding_set, GDK_Page_Up, 0,
247 add_slider_binding (binding_set, GDK_KP_Page_Up, 0,
250 add_slider_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK,
251 GTK_SCROLL_PAGE_RIGHT);
253 add_slider_binding (binding_set, GDK_KP_Page_Down, GDK_CONTROL_MASK,
254 GTK_SCROLL_PAGE_RIGHT);
256 add_slider_binding (binding_set, GDK_Page_Down, 0,
257 GTK_SCROLL_PAGE_DOWN);
259 add_slider_binding (binding_set, GDK_KP_Page_Down, 0,
260 GTK_SCROLL_PAGE_DOWN);
262 /* Logical bindings (vs. visual bindings above) */
264 add_slider_binding (binding_set, GDK_plus, 0,
265 GTK_SCROLL_STEP_FORWARD);
267 add_slider_binding (binding_set, GDK_minus, 0,
268 GTK_SCROLL_STEP_BACKWARD);
270 add_slider_binding (binding_set, GDK_plus, GDK_CONTROL_MASK,
271 GTK_SCROLL_PAGE_FORWARD);
273 add_slider_binding (binding_set, GDK_minus, GDK_CONTROL_MASK,
274 GTK_SCROLL_PAGE_BACKWARD);
277 add_slider_binding (binding_set, GDK_KP_Add, 0,
278 GTK_SCROLL_STEP_FORWARD);
280 add_slider_binding (binding_set, GDK_KP_Subtract, 0,
281 GTK_SCROLL_STEP_BACKWARD);
283 add_slider_binding (binding_set, GDK_KP_Add, GDK_CONTROL_MASK,
284 GTK_SCROLL_PAGE_FORWARD);
286 add_slider_binding (binding_set, GDK_KP_Subtract, GDK_CONTROL_MASK,
287 GTK_SCROLL_PAGE_BACKWARD);
290 add_slider_binding (binding_set, GDK_Home, 0,
293 add_slider_binding (binding_set, GDK_KP_Home, 0,
296 add_slider_binding (binding_set, GDK_End, 0,
299 add_slider_binding (binding_set, GDK_KP_End, 0,
302 g_type_class_add_private (gobject_class, sizeof (GtkScalePrivate));
306 gtk_scale_set_property (GObject *object,
313 scale = GTK_SCALE (object);
318 gtk_scale_set_digits (scale, g_value_get_int (value));
320 case PROP_DRAW_VALUE:
321 gtk_scale_set_draw_value (scale, g_value_get_boolean (value));
324 gtk_scale_set_value_pos (scale, g_value_get_enum (value));
327 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
333 gtk_scale_get_property (GObject *object,
340 scale = GTK_SCALE (object);
345 g_value_set_int (value, scale->digits);
347 case PROP_DRAW_VALUE:
348 g_value_set_boolean (value, scale->draw_value);
351 g_value_set_enum (value, scale->value_pos);
354 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
360 gtk_scale_init (GtkScale *scale)
364 range = GTK_RANGE (scale);
366 GTK_WIDGET_SET_FLAGS (scale, GTK_CAN_FOCUS);
368 range->slider_size_fixed = TRUE;
369 range->has_stepper_a = FALSE;
370 range->has_stepper_b = FALSE;
371 range->has_stepper_c = FALSE;
372 range->has_stepper_d = FALSE;
374 scale->draw_value = TRUE;
375 scale->value_pos = GTK_POS_TOP;
377 range->round_digits = scale->digits;
381 gtk_scale_set_digits (GtkScale *scale,
386 g_return_if_fail (GTK_IS_SCALE (scale));
388 range = GTK_RANGE (scale);
390 digits = CLAMP (digits, -1, MAX_DIGITS);
392 if (scale->digits != digits)
394 scale->digits = digits;
395 if (scale->draw_value)
396 range->round_digits = digits;
398 _gtk_scale_clear_layout (scale);
399 gtk_widget_queue_resize (GTK_WIDGET (scale));
401 g_object_notify (G_OBJECT (scale), "digits");
406 gtk_scale_get_digits (GtkScale *scale)
408 g_return_val_if_fail (GTK_IS_SCALE (scale), -1);
410 return scale->digits;
414 gtk_scale_set_draw_value (GtkScale *scale,
417 g_return_if_fail (GTK_IS_SCALE (scale));
419 draw_value = draw_value != FALSE;
421 if (scale->draw_value != draw_value)
423 scale->draw_value = draw_value;
425 GTK_RANGE (scale)->round_digits = scale->digits;
427 GTK_RANGE (scale)->round_digits = -1;
429 _gtk_scale_clear_layout (scale);
431 gtk_widget_queue_resize (GTK_WIDGET (scale));
433 g_object_notify (G_OBJECT (scale), "draw-value");
438 gtk_scale_get_draw_value (GtkScale *scale)
440 g_return_val_if_fail (GTK_IS_SCALE (scale), FALSE);
442 return scale->draw_value;
446 gtk_scale_set_value_pos (GtkScale *scale,
449 g_return_if_fail (GTK_IS_SCALE (scale));
451 if (scale->value_pos != pos)
453 scale->value_pos = pos;
455 _gtk_scale_clear_layout (scale);
456 if (GTK_WIDGET_VISIBLE (scale) && GTK_WIDGET_MAPPED (scale))
457 gtk_widget_queue_resize (GTK_WIDGET (scale));
459 g_object_notify (G_OBJECT (scale), "value-pos");
464 gtk_scale_get_value_pos (GtkScale *scale)
466 g_return_val_if_fail (GTK_IS_SCALE (scale), 0);
468 return scale->value_pos;
472 gtk_scale_get_range_border (GtkRange *range,
479 widget = GTK_WIDGET (range);
480 scale = GTK_SCALE (range);
482 _gtk_scale_get_value_size (scale, &w, &h);
489 if (scale->draw_value)
492 gtk_widget_style_get (widget, "value-spacing", &value_spacing, NULL);
494 switch (scale->value_pos)
497 border->left += w + value_spacing;
500 border->right += w + value_spacing;
503 border->top += h + value_spacing;
506 border->bottom += h + value_spacing;
512 /* FIXME this could actually be static at the moment. */
514 _gtk_scale_get_value_size (GtkScale *scale,
520 g_return_if_fail (GTK_IS_SCALE (scale));
522 if (scale->draw_value)
525 PangoRectangle logical_rect;
528 range = GTK_RANGE (scale);
530 layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
532 txt = _gtk_scale_format_value (scale, range->adjustment->lower);
533 pango_layout_set_text (layout, txt, -1);
536 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
539 *width = logical_rect.width;
541 *height = logical_rect.height;
543 txt = _gtk_scale_format_value (scale, range->adjustment->upper);
544 pango_layout_set_text (layout, txt, -1);
547 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
550 *width = MAX (*width, logical_rect.width);
552 *height = MAX (*height, logical_rect.height);
554 g_object_unref (layout);
567 gtk_scale_style_set (GtkWidget *widget,
573 range = GTK_RANGE (widget);
575 gtk_widget_style_get (widget,
576 "slider-length", &slider_length,
579 range->min_slider_size = slider_length;
581 _gtk_scale_clear_layout (GTK_SCALE (widget));
583 (* GTK_WIDGET_CLASS (gtk_scale_parent_class)->style_set) (widget, previous);
587 gtk_scale_screen_changed (GtkWidget *widget,
588 GdkScreen *old_screen)
590 _gtk_scale_clear_layout (GTK_SCALE (widget));
594 * _gtk_scale_format_value:
595 * @scale: a #GtkScale
596 * @value: adjustment value
598 * Emits #GtkScale::format-value signal to format the value,
599 * if no user signal handlers, falls back to a default format.
601 * Return value: formatted value
604 _gtk_scale_format_value (GtkScale *scale,
609 g_signal_emit (scale,
610 signals[FORMAT_VALUE],
618 /* insert a LRM, to prevent -20 to come out as 20- in RTL locales */
619 return g_strdup_printf ("\342\200\216%0.*f", scale->digits, value);
623 gtk_scale_finalize (GObject *object)
627 g_return_if_fail (GTK_IS_SCALE (object));
629 scale = GTK_SCALE (object);
631 _gtk_scale_clear_layout (scale);
633 G_OBJECT_CLASS (gtk_scale_parent_class)->finalize (object);
637 * gtk_scale_get_layout:
638 * @scale: A #GtkScale
640 * Gets the #PangoLayout used to display the scale.
641 * The returned object is owned by the scale so does
642 * not need to be freed by the caller.
644 * Return value: the #PangoLayout for this scale, or %NULL
645 * if the #GtkScale:draw-value property is %FALSE.
650 gtk_scale_get_layout (GtkScale *scale)
652 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
655 g_return_val_if_fail (GTK_IS_SCALE (scale), NULL);
659 if (scale->draw_value)
660 priv->layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
663 if (scale->draw_value)
665 txt = _gtk_scale_format_value (scale,
666 GTK_RANGE (scale)->adjustment->value);
667 pango_layout_set_text (priv->layout, txt, -1);
675 * gtk_scale_get_layout_offsets:
676 * @scale: a #GtkScale
677 * @x: location to store X offset of layout, or %NULL
678 * @y: location to store Y offset of layout, or %NULL
680 * Obtains the coordinates where the scale will draw the
681 * #PangoLayout representing the text in the scale. Remember
682 * when using the #PangoLayout function you need to convert to
683 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
685 * If the #GtkScale:draw-value property is %FALSE, the return
686 * values are undefined.
691 gtk_scale_get_layout_offsets (GtkScale *scale,
698 g_return_if_fail (GTK_IS_SCALE (scale));
700 if (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets)
701 (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets) (scale, &local_x, &local_y);
710 void _gtk_scale_clear_layout (GtkScale *scale)
712 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
714 g_return_if_fail (GTK_IS_SCALE (scale));
718 g_object_unref (priv->layout);
723 #define __GTK_SCALE_C__
724 #include "gtkaliasdef.c"