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/.
31 #include "gtkmarshalers.h"
32 #include "gdk/gdkkeysyms.h"
33 #include "gtkbindings.h"
36 #define MAX_DIGITS (64) /* don't change this,
37 * a) you don't need to and
38 * b) you might cause buffer owerflows in
39 * unrelated code portions otherwise
42 #define GTK_SCALE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SCALE, GtkScalePrivate))
44 typedef struct _GtkScalePrivate GtkScalePrivate;
46 struct _GtkScalePrivate
63 static guint signals[LAST_SIGNAL];
64 static GtkRangeClass *parent_class = NULL;
66 static void gtk_scale_class_init (GtkScaleClass *klass);
67 static void gtk_scale_init (GtkScale *scale);
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);
85 gtk_scale_get_type (void)
87 static GType scale_type = 0;
91 static const GTypeInfo scale_info =
93 sizeof (GtkScaleClass),
95 NULL, /* base_finalize */
96 (GClassInitFunc) gtk_scale_class_init,
97 NULL, /* class_finalize */
98 NULL, /* class_data */
101 (GInstanceInitFunc) gtk_scale_init,
102 NULL, /* value_table */
105 scale_type = g_type_register_static (GTK_TYPE_RANGE, "GtkScale",
106 &scale_info, G_TYPE_FLAG_ABSTRACT);
113 single_string_accumulator (GSignalInvocationHint *ihint,
115 const GValue *handler_return,
118 gboolean continue_emission;
121 str = g_value_get_string (handler_return);
122 g_value_set_string (return_accu, str);
123 continue_emission = str == NULL;
125 return continue_emission;
129 #define add_slider_binding(binding_set, keyval, mask, scroll) \
130 gtk_binding_entry_add_signal (binding_set, keyval, mask, \
132 GTK_TYPE_SCROLL_TYPE, scroll)
135 gtk_scale_class_init (GtkScaleClass *class)
137 GObjectClass *gobject_class;
138 GtkWidgetClass *widget_class;
139 GtkRangeClass *range_class;
140 GtkBindingSet *binding_set;
142 gobject_class = G_OBJECT_CLASS (class);
143 range_class = (GtkRangeClass*) class;
144 widget_class = (GtkWidgetClass*) class;
146 parent_class = g_type_class_peek_parent (class);
148 gobject_class->set_property = gtk_scale_set_property;
149 gobject_class->get_property = gtk_scale_get_property;
150 gobject_class->finalize = gtk_scale_finalize;
152 widget_class->style_set = gtk_scale_style_set;
153 widget_class->screen_changed = gtk_scale_screen_changed;
155 range_class->get_range_border = gtk_scale_get_range_border;
157 signals[FORMAT_VALUE] =
158 g_signal_new ("format_value",
159 G_TYPE_FROM_CLASS (gobject_class),
161 G_STRUCT_OFFSET (GtkScaleClass, format_value),
162 single_string_accumulator, NULL,
163 _gtk_marshal_STRING__DOUBLE,
167 g_object_class_install_property (gobject_class,
169 g_param_spec_int ("digits",
171 P_("The number of decimal places that are displayed in the value"),
177 g_object_class_install_property (gobject_class,
179 g_param_spec_boolean ("draw_value",
181 P_("Whether the current value is displayed as a string next to the slider"),
185 g_object_class_install_property (gobject_class,
187 g_param_spec_enum ("value_pos",
188 P_("Value Position"),
189 P_("The position in which the current value is displayed"),
190 GTK_TYPE_POSITION_TYPE,
194 gtk_widget_class_install_style_property (widget_class,
195 g_param_spec_int ("slider_length",
197 P_("Length of scale's slider"),
203 gtk_widget_class_install_style_property (widget_class,
204 g_param_spec_int ("value_spacing",
206 P_("Space between value text and the slider/trough area"),
212 /* All bindings (even arrow keys) are on both h/v scale, because
213 * blind users etc. don't care about scale orientation.
216 binding_set = gtk_binding_set_by_class (class);
218 add_slider_binding (binding_set, GDK_Left, 0,
219 GTK_SCROLL_STEP_LEFT);
221 add_slider_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
222 GTK_SCROLL_PAGE_LEFT);
224 add_slider_binding (binding_set, GDK_KP_Left, 0,
225 GTK_SCROLL_STEP_LEFT);
227 add_slider_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
228 GTK_SCROLL_PAGE_LEFT);
230 add_slider_binding (binding_set, GDK_Right, 0,
231 GTK_SCROLL_STEP_RIGHT);
233 add_slider_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
234 GTK_SCROLL_PAGE_RIGHT);
236 add_slider_binding (binding_set, GDK_KP_Right, 0,
237 GTK_SCROLL_STEP_RIGHT);
239 add_slider_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
240 GTK_SCROLL_PAGE_RIGHT);
242 add_slider_binding (binding_set, GDK_Up, 0,
245 add_slider_binding (binding_set, GDK_Up, GDK_CONTROL_MASK,
248 add_slider_binding (binding_set, GDK_KP_Up, 0,
251 add_slider_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK,
254 add_slider_binding (binding_set, GDK_Down, 0,
255 GTK_SCROLL_STEP_DOWN);
257 add_slider_binding (binding_set, GDK_Down, GDK_CONTROL_MASK,
258 GTK_SCROLL_PAGE_DOWN);
260 add_slider_binding (binding_set, GDK_KP_Down, 0,
261 GTK_SCROLL_STEP_DOWN);
263 add_slider_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK,
264 GTK_SCROLL_PAGE_DOWN);
266 add_slider_binding (binding_set, GDK_Page_Up, 0,
267 GTK_SCROLL_PAGE_LEFT);
269 add_slider_binding (binding_set, GDK_KP_Page_Up, 0,
270 GTK_SCROLL_PAGE_LEFT);
272 add_slider_binding (binding_set, GDK_Page_Up, 0,
275 add_slider_binding (binding_set, GDK_KP_Page_Up, 0,
278 add_slider_binding (binding_set, GDK_Page_Down, 0,
279 GTK_SCROLL_PAGE_RIGHT);
281 add_slider_binding (binding_set, GDK_KP_Page_Down, 0,
282 GTK_SCROLL_PAGE_RIGHT);
284 add_slider_binding (binding_set, GDK_Page_Down, 0,
285 GTK_SCROLL_PAGE_DOWN);
287 add_slider_binding (binding_set, GDK_KP_Page_Down, 0,
288 GTK_SCROLL_PAGE_DOWN);
290 /* Logical bindings (vs. visual bindings above) */
292 add_slider_binding (binding_set, GDK_plus, 0,
293 GTK_SCROLL_STEP_FORWARD);
295 add_slider_binding (binding_set, GDK_minus, 0,
296 GTK_SCROLL_STEP_BACKWARD);
298 add_slider_binding (binding_set, GDK_plus, GDK_CONTROL_MASK,
299 GTK_SCROLL_PAGE_FORWARD);
301 add_slider_binding (binding_set, GDK_minus, GDK_CONTROL_MASK,
302 GTK_SCROLL_PAGE_BACKWARD);
305 add_slider_binding (binding_set, GDK_KP_Add, 0,
306 GTK_SCROLL_STEP_FORWARD);
308 add_slider_binding (binding_set, GDK_KP_Subtract, 0,
309 GTK_SCROLL_STEP_BACKWARD);
311 add_slider_binding (binding_set, GDK_KP_Add, GDK_CONTROL_MASK,
312 GTK_SCROLL_PAGE_FORWARD);
314 add_slider_binding (binding_set, GDK_KP_Subtract, GDK_CONTROL_MASK,
315 GTK_SCROLL_PAGE_BACKWARD);
318 add_slider_binding (binding_set, GDK_Home, 0,
321 add_slider_binding (binding_set, GDK_KP_Home, 0,
324 add_slider_binding (binding_set, GDK_End, 0,
327 add_slider_binding (binding_set, GDK_KP_End, 0,
330 g_type_class_add_private (gobject_class, sizeof (GtkScalePrivate));
334 gtk_scale_set_property (GObject *object,
341 scale = GTK_SCALE (object);
346 gtk_scale_set_digits (scale, g_value_get_int (value));
348 case PROP_DRAW_VALUE:
349 gtk_scale_set_draw_value (scale, g_value_get_boolean (value));
352 gtk_scale_set_value_pos (scale, g_value_get_enum (value));
355 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
361 gtk_scale_get_property (GObject *object,
368 scale = GTK_SCALE (object);
373 g_value_set_int (value, scale->digits);
375 case PROP_DRAW_VALUE:
376 g_value_set_boolean (value, scale->draw_value);
379 g_value_set_enum (value, scale->value_pos);
382 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
388 gtk_scale_init (GtkScale *scale)
392 range = GTK_RANGE (scale);
394 GTK_WIDGET_SET_FLAGS (scale, GTK_CAN_FOCUS);
396 range->slider_size_fixed = TRUE;
397 range->has_stepper_a = FALSE;
398 range->has_stepper_b = FALSE;
399 range->has_stepper_c = FALSE;
400 range->has_stepper_d = FALSE;
402 scale->draw_value = TRUE;
403 scale->value_pos = GTK_POS_TOP;
405 range->round_digits = scale->digits;
409 gtk_scale_set_digits (GtkScale *scale,
414 g_return_if_fail (GTK_IS_SCALE (scale));
416 range = GTK_RANGE (scale);
418 digits = CLAMP (digits, -1, MAX_DIGITS);
420 if (scale->digits != digits)
422 scale->digits = digits;
423 if (scale->draw_value)
424 range->round_digits = digits;
426 _gtk_scale_clear_layout (scale);
427 gtk_widget_queue_resize (GTK_WIDGET (scale));
429 g_object_notify (G_OBJECT (scale), "digits");
434 gtk_scale_get_digits (GtkScale *scale)
436 g_return_val_if_fail (GTK_IS_SCALE (scale), -1);
438 return scale->digits;
442 gtk_scale_set_draw_value (GtkScale *scale,
445 g_return_if_fail (GTK_IS_SCALE (scale));
447 draw_value = draw_value != FALSE;
449 if (scale->draw_value != draw_value)
451 scale->draw_value = draw_value;
453 GTK_RANGE (scale)->round_digits = scale->digits;
455 GTK_RANGE (scale)->round_digits = -1;
457 _gtk_scale_clear_layout (scale);
459 gtk_widget_queue_resize (GTK_WIDGET (scale));
461 g_object_notify (G_OBJECT (scale), "draw_value");
466 gtk_scale_get_draw_value (GtkScale *scale)
468 g_return_val_if_fail (GTK_IS_SCALE (scale), FALSE);
470 return scale->draw_value;
474 gtk_scale_set_value_pos (GtkScale *scale,
477 g_return_if_fail (GTK_IS_SCALE (scale));
479 if (scale->value_pos != pos)
481 scale->value_pos = pos;
483 _gtk_scale_clear_layout (scale);
484 if (GTK_WIDGET_VISIBLE (scale) && GTK_WIDGET_MAPPED (scale))
485 gtk_widget_queue_resize (GTK_WIDGET (scale));
487 g_object_notify (G_OBJECT (scale), "value_pos");
492 gtk_scale_get_value_pos (GtkScale *scale)
494 g_return_val_if_fail (GTK_IS_SCALE (scale), 0);
496 return scale->value_pos;
500 gtk_scale_get_range_border (GtkRange *range,
507 widget = GTK_WIDGET (range);
508 scale = GTK_SCALE (range);
510 _gtk_scale_get_value_size (scale, &w, &h);
517 if (scale->draw_value)
520 gtk_widget_style_get (widget, "value_spacing", &value_spacing, NULL);
522 switch (scale->value_pos)
525 border->left += w + value_spacing;
528 border->right += w + value_spacing;
531 border->top += h + value_spacing;
534 border->bottom += h + value_spacing;
540 /* FIXME this could actually be static at the moment. */
542 _gtk_scale_get_value_size (GtkScale *scale,
548 g_return_if_fail (GTK_IS_SCALE (scale));
550 if (scale->draw_value)
553 PangoRectangle logical_rect;
556 range = GTK_RANGE (scale);
558 layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
560 txt = _gtk_scale_format_value (scale, range->adjustment->lower);
561 pango_layout_set_text (layout, txt, -1);
564 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
567 *width = logical_rect.width;
569 *height = logical_rect.height;
571 txt = _gtk_scale_format_value (scale, range->adjustment->upper);
572 pango_layout_set_text (layout, txt, -1);
575 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
578 *width = MAX (*width, logical_rect.width);
580 *height = MAX (*height, logical_rect.height);
582 g_object_unref (layout);
595 gtk_scale_style_set (GtkWidget *widget,
601 range = GTK_RANGE (widget);
603 gtk_widget_style_get (widget,
604 "slider_length", &slider_length,
607 range->min_slider_size = slider_length;
609 _gtk_scale_clear_layout (GTK_SCALE (widget));
611 (* GTK_WIDGET_CLASS (parent_class)->style_set) (widget, previous);
615 gtk_scale_screen_changed (GtkWidget *widget,
616 GdkScreen *old_screen)
618 _gtk_scale_clear_layout (GTK_SCALE (widget));
622 * _gtk_scale_format_value:
623 * @scale: a #GtkScale
624 * @value: adjustment value
626 * Emits "format_value" signal to format the value, if no user
627 * signal handlers, falls back to a default format.
629 * Return value: formatted value
632 _gtk_scale_format_value (GtkScale *scale,
637 g_signal_emit (scale,
638 signals[FORMAT_VALUE],
646 return g_strdup_printf ("%0.*f", scale->digits,
651 gtk_scale_finalize (GObject *object)
655 g_return_if_fail (GTK_IS_SCALE (object));
657 scale = GTK_SCALE (object);
659 _gtk_scale_clear_layout (scale);
661 G_OBJECT_CLASS (parent_class)->finalize (object);
665 * gtk_scale_get_layout:
666 * @scale: A #GtkScale
668 * Gets the #PangoLayout used to display the scale. The returned object
669 * is owned by the scale so does not need to be freed by the caller.
671 * Return value: the #PangoLayout for this scale, or %NULL if the draw_value property
677 gtk_scale_get_layout (GtkScale *scale)
679 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
682 g_return_val_if_fail (GTK_IS_SCALE (scale), NULL);
686 if (scale->draw_value)
687 priv->layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
690 if (scale->draw_value)
692 txt = _gtk_scale_format_value (scale,
693 GTK_RANGE (scale)->adjustment->value);
694 pango_layout_set_text (priv->layout, txt, -1);
702 * gtk_scale_get_layout_offsets:
703 * @scale: a #GtkScale
704 * @x: location to store X offset of layout, or %NULL
705 * @y: location to store Y offset of layout, or %NULL
707 * Obtains the coordinates where the scale will draw the #PangoLayout
708 * representing the text in the scale. Remember
709 * when using the #PangoLayout function you need to convert to
710 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
712 * If the draw_value property is %FALSE, the return values are
718 gtk_scale_get_layout_offsets (GtkScale *scale,
722 gint local_x, local_y;
724 g_return_if_fail (GTK_IS_SCALE (scale));
726 if (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets)
727 (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets) (scale, &local_x, &local_y);
736 void _gtk_scale_clear_layout (GtkScale *scale)
738 GtkScalePrivate *priv = GTK_SCALE_GET_PRIVATE (scale);
740 g_return_if_fail (GTK_IS_SCALE (scale));
744 g_object_unref (priv->layout);