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/.
33 #include "gtkmarshalers.h"
34 #include "gdk/gdkkeysyms.h"
35 #include "gtkbindings.h"
38 #define MAX_DIGITS (64) /* don't change this,
39 * a) you don't need to and
40 * b) you might cause buffer owerflows in
41 * unrelated code portions otherwise
44 #define GTK_SCALE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SCALE, GtkScalePrivate))
46 typedef struct _GtkScalePrivate GtkScalePrivate;
48 struct _GtkScalePrivate
65 static guint signals[LAST_SIGNAL];
66 static GtkRangeClass *parent_class = NULL;
68 static void gtk_scale_class_init (GtkScaleClass *klass);
69 static void gtk_scale_init (GtkScale *scale);
70 static void gtk_scale_set_property (GObject *object,
74 static void gtk_scale_get_property (GObject *object,
78 static void gtk_scale_style_set (GtkWidget *widget,
80 static void gtk_scale_get_range_border (GtkRange *range,
82 static void gtk_scale_finalize (GObject *object);
83 static void gtk_scale_screen_changed (GtkWidget *widget,
84 GdkScreen *old_screen);
87 gtk_scale_get_type (void)
89 static GType scale_type = 0;
93 static const GTypeInfo scale_info =
95 sizeof (GtkScaleClass),
97 NULL, /* base_finalize */
98 (GClassInitFunc) gtk_scale_class_init,
99 NULL, /* class_finalize */
100 NULL, /* class_data */
103 (GInstanceInitFunc) gtk_scale_init,
104 NULL, /* value_table */
107 scale_type = g_type_register_static (GTK_TYPE_RANGE, "GtkScale",
108 &scale_info, G_TYPE_FLAG_ABSTRACT);
115 single_string_accumulator (GSignalInvocationHint *ihint,
117 const GValue *handler_return,
120 gboolean continue_emission;
123 str = g_value_get_string (handler_return);
124 g_value_set_string (return_accu, str);
125 continue_emission = str == NULL;
127 return continue_emission;
131 #define add_slider_binding(binding_set, keyval, mask, scroll) \
132 gtk_binding_entry_add_signal (binding_set, keyval, mask, \
134 GTK_TYPE_SCROLL_TYPE, scroll)
137 gtk_scale_class_init (GtkScaleClass *class)
139 GObjectClass *gobject_class;
140 GtkWidgetClass *widget_class;
141 GtkRangeClass *range_class;
142 GtkBindingSet *binding_set;
144 gobject_class = G_OBJECT_CLASS (class);
145 range_class = (GtkRangeClass*) class;
146 widget_class = (GtkWidgetClass*) class;
148 parent_class = g_type_class_peek_parent (class);
150 gobject_class->set_property = gtk_scale_set_property;
151 gobject_class->get_property = gtk_scale_get_property;
152 gobject_class->finalize = gtk_scale_finalize;
154 widget_class->style_set = gtk_scale_style_set;
155 widget_class->screen_changed = gtk_scale_screen_changed;
157 range_class->get_range_border = gtk_scale_get_range_border;
159 signals[FORMAT_VALUE] =
160 g_signal_new ("format_value",
161 G_TYPE_FROM_CLASS (gobject_class),
163 G_STRUCT_OFFSET (GtkScaleClass, format_value),
164 single_string_accumulator, NULL,
165 _gtk_marshal_STRING__DOUBLE,
169 g_object_class_install_property (gobject_class,
171 g_param_spec_int ("digits",
173 P_("The number of decimal places that are displayed in the value"),
179 g_object_class_install_property (gobject_class,
181 g_param_spec_boolean ("draw-value",
183 P_("Whether the current value is displayed as a string next to the slider"),
187 g_object_class_install_property (gobject_class,
189 g_param_spec_enum ("value-pos",
190 P_("Value Position"),
191 P_("The position in which the current value is displayed"),
192 GTK_TYPE_POSITION_TYPE,
196 gtk_widget_class_install_style_property (widget_class,
197 g_param_spec_int ("slider-length",
199 P_("Length of scale's slider"),
205 gtk_widget_class_install_style_property (widget_class,
206 g_param_spec_int ("value-spacing",
208 P_("Space between value text and the slider/trough area"),
214 /* All bindings (even arrow keys) are on both h/v scale, because
215 * blind users etc. don't care about scale orientation.
218 binding_set = gtk_binding_set_by_class (class);
220 add_slider_binding (binding_set, GDK_Left, 0,
221 GTK_SCROLL_STEP_LEFT);
223 add_slider_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
224 GTK_SCROLL_PAGE_LEFT);
226 add_slider_binding (binding_set, GDK_KP_Left, 0,
227 GTK_SCROLL_STEP_LEFT);
229 add_slider_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
230 GTK_SCROLL_PAGE_LEFT);
232 add_slider_binding (binding_set, GDK_Right, 0,
233 GTK_SCROLL_STEP_RIGHT);
235 add_slider_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
236 GTK_SCROLL_PAGE_RIGHT);
238 add_slider_binding (binding_set, GDK_KP_Right, 0,
239 GTK_SCROLL_STEP_RIGHT);
241 add_slider_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
242 GTK_SCROLL_PAGE_RIGHT);
244 add_slider_binding (binding_set, GDK_Up, 0,
247 add_slider_binding (binding_set, GDK_Up, GDK_CONTROL_MASK,
250 add_slider_binding (binding_set, GDK_KP_Up, 0,
253 add_slider_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK,
256 add_slider_binding (binding_set, GDK_Down, 0,
257 GTK_SCROLL_STEP_DOWN);
259 add_slider_binding (binding_set, GDK_Down, GDK_CONTROL_MASK,
260 GTK_SCROLL_PAGE_DOWN);
262 add_slider_binding (binding_set, GDK_KP_Down, 0,
263 GTK_SCROLL_STEP_DOWN);
265 add_slider_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK,
266 GTK_SCROLL_PAGE_DOWN);
268 add_slider_binding (binding_set, GDK_Page_Up, 0,
269 GTK_SCROLL_PAGE_LEFT);
271 add_slider_binding (binding_set, GDK_KP_Page_Up, 0,
272 GTK_SCROLL_PAGE_LEFT);
274 add_slider_binding (binding_set, GDK_Page_Up, 0,
277 add_slider_binding (binding_set, GDK_KP_Page_Up, 0,
280 add_slider_binding (binding_set, GDK_Page_Down, 0,
281 GTK_SCROLL_PAGE_RIGHT);
283 add_slider_binding (binding_set, GDK_KP_Page_Down, 0,
284 GTK_SCROLL_PAGE_RIGHT);
286 add_slider_binding (binding_set, GDK_Page_Down, 0,
287 GTK_SCROLL_PAGE_DOWN);
289 add_slider_binding (binding_set, GDK_KP_Page_Down, 0,
290 GTK_SCROLL_PAGE_DOWN);
292 /* Logical bindings (vs. visual bindings above) */
294 add_slider_binding (binding_set, GDK_plus, 0,
295 GTK_SCROLL_STEP_FORWARD);
297 add_slider_binding (binding_set, GDK_minus, 0,
298 GTK_SCROLL_STEP_BACKWARD);
300 add_slider_binding (binding_set, GDK_plus, GDK_CONTROL_MASK,
301 GTK_SCROLL_PAGE_FORWARD);
303 add_slider_binding (binding_set, GDK_minus, GDK_CONTROL_MASK,
304 GTK_SCROLL_PAGE_BACKWARD);
307 add_slider_binding (binding_set, GDK_KP_Add, 0,
308 GTK_SCROLL_STEP_FORWARD);
310 add_slider_binding (binding_set, GDK_KP_Subtract, 0,
311 GTK_SCROLL_STEP_BACKWARD);
313 add_slider_binding (binding_set, GDK_KP_Add, GDK_CONTROL_MASK,
314 GTK_SCROLL_PAGE_FORWARD);
316 add_slider_binding (binding_set, GDK_KP_Subtract, GDK_CONTROL_MASK,
317 GTK_SCROLL_PAGE_BACKWARD);
320 add_slider_binding (binding_set, GDK_Home, 0,
323 add_slider_binding (binding_set, GDK_KP_Home, 0,
326 add_slider_binding (binding_set, GDK_End, 0,
329 add_slider_binding (binding_set, GDK_KP_End, 0,
332 g_type_class_add_private (gobject_class, sizeof (GtkScalePrivate));
336 gtk_scale_set_property (GObject *object,
343 scale = GTK_SCALE (object);
348 gtk_scale_set_digits (scale, g_value_get_int (value));
350 case PROP_DRAW_VALUE:
351 gtk_scale_set_draw_value (scale, g_value_get_boolean (value));
354 gtk_scale_set_value_pos (scale, g_value_get_enum (value));
357 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
363 gtk_scale_get_property (GObject *object,
370 scale = GTK_SCALE (object);
375 g_value_set_int (value, scale->digits);
377 case PROP_DRAW_VALUE:
378 g_value_set_boolean (value, scale->draw_value);
381 g_value_set_enum (value, scale->value_pos);
384 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
390 gtk_scale_init (GtkScale *scale)
394 range = GTK_RANGE (scale);
396 GTK_WIDGET_SET_FLAGS (scale, GTK_CAN_FOCUS);
398 range->slider_size_fixed = TRUE;
399 range->has_stepper_a = FALSE;
400 range->has_stepper_b = FALSE;
401 range->has_stepper_c = FALSE;
402 range->has_stepper_d = FALSE;
404 scale->draw_value = TRUE;
405 scale->value_pos = GTK_POS_TOP;
407 range->round_digits = scale->digits;
411 gtk_scale_set_digits (GtkScale *scale,
416 g_return_if_fail (GTK_IS_SCALE (scale));
418 range = GTK_RANGE (scale);
420 digits = CLAMP (digits, -1, MAX_DIGITS);
422 if (scale->digits != digits)
424 scale->digits = digits;
425 if (scale->draw_value)
426 range->round_digits = digits;
428 _gtk_scale_clear_layout (scale);
429 gtk_widget_queue_resize (GTK_WIDGET (scale));
431 g_object_notify (G_OBJECT (scale), "digits");
436 gtk_scale_get_digits (GtkScale *scale)
438 g_return_val_if_fail (GTK_IS_SCALE (scale), -1);
440 return scale->digits;
444 gtk_scale_set_draw_value (GtkScale *scale,
447 g_return_if_fail (GTK_IS_SCALE (scale));
449 draw_value = draw_value != FALSE;
451 if (scale->draw_value != draw_value)
453 scale->draw_value = draw_value;
455 GTK_RANGE (scale)->round_digits = scale->digits;
457 GTK_RANGE (scale)->round_digits = -1;
459 _gtk_scale_clear_layout (scale);
461 gtk_widget_queue_resize (GTK_WIDGET (scale));
463 g_object_notify (G_OBJECT (scale), "draw_value");
468 gtk_scale_get_draw_value (GtkScale *scale)
470 g_return_val_if_fail (GTK_IS_SCALE (scale), FALSE);
472 return scale->draw_value;
476 gtk_scale_set_value_pos (GtkScale *scale,
479 g_return_if_fail (GTK_IS_SCALE (scale));
481 if (scale->value_pos != pos)
483 scale->value_pos = pos;
485 _gtk_scale_clear_layout (scale);
486 if (GTK_WIDGET_VISIBLE (scale) && GTK_WIDGET_MAPPED (scale))
487 gtk_widget_queue_resize (GTK_WIDGET (scale));
489 g_object_notify (G_OBJECT (scale), "value_pos");
494 gtk_scale_get_value_pos (GtkScale *scale)
496 g_return_val_if_fail (GTK_IS_SCALE (scale), 0);
498 return scale->value_pos;
502 gtk_scale_get_range_border (GtkRange *range,
509 widget = GTK_WIDGET (range);
510 scale = GTK_SCALE (range);
512 _gtk_scale_get_value_size (scale, &w, &h);
519 if (scale->draw_value)
522 gtk_widget_style_get (widget, "value_spacing", &value_spacing, NULL);
524 switch (scale->value_pos)
527 border->left += w + value_spacing;
530 border->right += w + value_spacing;
533 border->top += h + value_spacing;
536 border->bottom += h + value_spacing;
542 /* FIXME this could actually be static at the moment. */
544 _gtk_scale_get_value_size (GtkScale *scale,
550 g_return_if_fail (GTK_IS_SCALE (scale));
552 if (scale->draw_value)
555 PangoRectangle logical_rect;
558 range = GTK_RANGE (scale);
560 layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
562 txt = _gtk_scale_format_value (scale, range->adjustment->lower);
563 pango_layout_set_text (layout, txt, -1);
566 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
569 *width = logical_rect.width;
571 *height = logical_rect.height;
573 txt = _gtk_scale_format_value (scale, range->adjustment->upper);
574 pango_layout_set_text (layout, txt, -1);
577 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
580 *width = MAX (*width, logical_rect.width);
582 *height = MAX (*height, logical_rect.height);
584 g_object_unref (layout);
597 gtk_scale_style_set (GtkWidget *widget,
603 range = GTK_RANGE (widget);
605 gtk_widget_style_get (widget,
606 "slider_length", &slider_length,
609 range->min_slider_size = slider_length;
611 _gtk_scale_clear_layout (GTK_SCALE (widget));
613 (* GTK_WIDGET_CLASS (parent_class)->style_set) (widget, previous);
617 gtk_scale_screen_changed (GtkWidget *widget,
618 GdkScreen *old_screen)
620 _gtk_scale_clear_layout (GTK_SCALE (widget));
624 * _gtk_scale_format_value:
625 * @scale: a #GtkScale
626 * @value: adjustment value
628 * Emits "format_value" signal to format the value, if no user
629 * signal handlers, falls back to a default format.
631 * Return value: formatted value
634 _gtk_scale_format_value (GtkScale *scale,
639 g_signal_emit (scale,
640 signals[FORMAT_VALUE],
648 return g_strdup_printf ("%0.*f", scale->digits,
653 gtk_scale_finalize (GObject *object)
657 g_return_if_fail (GTK_IS_SCALE (object));
659 scale = GTK_SCALE (object);
661 _gtk_scale_clear_layout (scale);
663 G_OBJECT_CLASS (parent_class)->finalize (object);
667 * gtk_scale_get_layout:
668 * @scale: A #GtkScale
670 * Gets the #PangoLayout used to display the scale. The returned object
671 * is owned by the scale so does not need to be freed by the caller.
673 * Return value: the #PangoLayout for this scale, or %NULL if the draw_value property
679 gtk_scale_get_layout (GtkScale *scale)
681 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
684 g_return_val_if_fail (GTK_IS_SCALE (scale), NULL);
688 if (scale->draw_value)
689 priv->layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
692 if (scale->draw_value)
694 txt = _gtk_scale_format_value (scale,
695 GTK_RANGE (scale)->adjustment->value);
696 pango_layout_set_text (priv->layout, txt, -1);
704 * gtk_scale_get_layout_offsets:
705 * @scale: a #GtkScale
706 * @x: location to store X offset of layout, or %NULL
707 * @y: location to store Y offset of layout, or %NULL
709 * Obtains the coordinates where the scale will draw the #PangoLayout
710 * representing the text in the scale. Remember
711 * when using the #PangoLayout function you need to convert to
712 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
714 * If the draw_value property is %FALSE, the return values are
720 gtk_scale_get_layout_offsets (GtkScale *scale,
724 gint local_x, local_y;
726 g_return_if_fail (GTK_IS_SCALE (scale));
728 if (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets)
729 (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets) (scale, &local_x, &local_y);
738 void _gtk_scale_clear_layout (GtkScale *scale)
740 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
742 g_return_if_fail (GTK_IS_SCALE (scale));
746 g_object_unref (priv->layout);