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/.
28 #include "gtkadjustment.h"
29 #include "gtkmarshalers.h"
30 #include "gtkprivate.h"
35 * SECTION:gtkadjustment
36 * @Short_description: A representation of an adjustable bounded value
37 * @Title: GtkAdjustment
39 * The #GtkAdjustment object represents a value which has an associated lower
40 * and upper bound, together with step and page increments, and a page size.
41 * It is used within several GTK+ widgets, including
42 * #GtkSpinButton, #GtkViewport, and #GtkRange (which is a base class for
43 * #GtkHScrollbar, #GtkVScrollbar, #GtkHScale, and #GtkVScale).
45 * The #GtkAdjustment object does not update the value itself. Instead
46 * it is left up to the owner of the #GtkAdjustment to control the value.
48 * The owner of the #GtkAdjustment typically calls the
49 * gtk_adjustment_value_changed() and gtk_adjustment_changed() functions
50 * after changing the value and its bounds. This results in the emission of the
51 * #GtkAdjustment::value_changed or #GtkAdjustment::changed signal respectively.
74 static void gtk_adjustment_get_property (GObject *object,
78 static void gtk_adjustment_set_property (GObject *object,
82 static void gtk_adjustment_dispatch_properties_changed (GObject *object,
86 static guint adjustment_signals[LAST_SIGNAL] = { 0 };
88 static guint64 adjustment_changed_stamp = 0; /* protected by global gdk lock */
90 G_DEFINE_TYPE (GtkAdjustment, gtk_adjustment, G_TYPE_INITIALLY_UNOWNED)
93 gtk_adjustment_class_init (GtkAdjustmentClass *class)
95 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
97 gobject_class->set_property = gtk_adjustment_set_property;
98 gobject_class->get_property = gtk_adjustment_get_property;
99 gobject_class->dispatch_properties_changed = gtk_adjustment_dispatch_properties_changed;
101 class->changed = NULL;
102 class->value_changed = NULL;
105 * GtkAdjustment:value:
107 * The value of the adjustment.
111 g_object_class_install_property (gobject_class,
113 g_param_spec_double ("value",
115 P_("The value of the adjustment"),
119 GTK_PARAM_READWRITE));
122 * GtkAdjustment:lower:
124 * The minimum value of the adjustment.
128 g_object_class_install_property (gobject_class,
130 g_param_spec_double ("lower",
132 P_("The minimum value of the adjustment"),
136 GTK_PARAM_READWRITE));
139 * GtkAdjustment:upper:
141 * The maximum value of the adjustment.
142 * Note that values will be restricted by
143 * <literal>upper - page-size</literal> if the page-size
144 * property is nonzero.
148 g_object_class_install_property (gobject_class,
150 g_param_spec_double ("upper",
152 P_("The maximum value of the adjustment"),
156 GTK_PARAM_READWRITE));
159 * GtkAdjustment:step-increment:
161 * The step increment of the adjustment.
165 g_object_class_install_property (gobject_class,
167 g_param_spec_double ("step-increment",
168 P_("Step Increment"),
169 P_("The step increment of the adjustment"),
173 GTK_PARAM_READWRITE));
176 * GtkAdjustment:page-increment:
178 * The page increment of the adjustment.
182 g_object_class_install_property (gobject_class,
184 g_param_spec_double ("page-increment",
185 P_("Page Increment"),
186 P_("The page increment of the adjustment"),
190 GTK_PARAM_READWRITE));
193 * GtkAdjustment:page-size:
195 * The page size of the adjustment.
196 * Note that the page-size is irrelevant and should be set to zero
197 * if the adjustment is used for a simple scalar value, e.g. in a
202 g_object_class_install_property (gobject_class,
204 g_param_spec_double ("page-size",
206 P_("The page size of the adjustment"),
210 GTK_PARAM_READWRITE));
213 * GtkAdjustment::changed:
214 * @adjustment: the object which received the signal.
216 * Emitted when one or more of the #GtkAdjustment fields have been changed,
217 * other than the value field.
219 adjustment_signals[CHANGED] =
220 g_signal_new (I_("changed"),
221 G_OBJECT_CLASS_TYPE (class),
222 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
223 G_STRUCT_OFFSET (GtkAdjustmentClass, changed),
225 _gtk_marshal_VOID__VOID,
229 * GtkAdjustment::value-changed:
230 * @adjustment: the object which received the signal.
232 * Emitted when the #GtkAdjustment value field has been changed.
234 adjustment_signals[VALUE_CHANGED] =
235 g_signal_new (I_("value-changed"),
236 G_OBJECT_CLASS_TYPE (class),
237 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
238 G_STRUCT_OFFSET (GtkAdjustmentClass, value_changed),
240 _gtk_marshal_VOID__VOID,
245 gtk_adjustment_init (GtkAdjustment *adjustment)
247 adjustment->value = 0.0;
248 adjustment->lower = 0.0;
249 adjustment->upper = 0.0;
250 adjustment->step_increment = 0.0;
251 adjustment->page_increment = 0.0;
252 adjustment->page_size = 0.0;
256 gtk_adjustment_get_property (GObject *object,
261 GtkAdjustment *adjustment = GTK_ADJUSTMENT (object);
266 g_value_set_double (value, adjustment->value);
269 g_value_set_double (value, adjustment->lower);
272 g_value_set_double (value, adjustment->upper);
274 case PROP_STEP_INCREMENT:
275 g_value_set_double (value, adjustment->step_increment);
277 case PROP_PAGE_INCREMENT:
278 g_value_set_double (value, adjustment->page_increment);
281 g_value_set_double (value, adjustment->page_size);
284 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
290 gtk_adjustment_set_property (GObject *object,
295 GtkAdjustment *adjustment = GTK_ADJUSTMENT (object);
296 gdouble double_value = g_value_get_double (value);
301 gtk_adjustment_set_value (adjustment, double_value);
304 adjustment->lower = double_value;
307 adjustment->upper = double_value;
309 case PROP_STEP_INCREMENT:
310 adjustment->step_increment = double_value;
312 case PROP_PAGE_INCREMENT:
313 adjustment->page_increment = double_value;
316 adjustment->page_size = double_value;
319 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
325 gtk_adjustment_dispatch_properties_changed (GObject *object,
329 gboolean changed = FALSE;
332 G_OBJECT_CLASS (gtk_adjustment_parent_class)->dispatch_properties_changed (object, n_pspecs, pspecs);
334 for (i = 0; i < n_pspecs; i++)
335 switch (pspecs[i]->param_id)
339 case PROP_STEP_INCREMENT:
340 case PROP_PAGE_INCREMENT:
350 adjustment_changed_stamp++;
351 gtk_adjustment_changed (GTK_ADJUSTMENT (object));
356 * gtk_adjustment_new:
357 * @value: the initial value.
358 * @lower: the minimum value.
359 * @upper: the maximum value.
360 * @step_increment: the step increment.
361 * @page_increment: the page increment.
362 * @page_size: the page size.
364 * Creates a new #GtkAdjustment.
366 * Returns: a new #GtkAdjustment.
369 gtk_adjustment_new (gdouble value,
372 gdouble step_increment,
373 gdouble page_increment,
376 return g_object_new (GTK_TYPE_ADJUSTMENT,
379 "step-increment", step_increment,
380 "page-increment", page_increment,
381 "page-size", page_size,
387 * gtk_adjustment_get_value:
388 * @adjustment: a #GtkAdjustment
390 * Gets the current value of the adjustment. See
391 * gtk_adjustment_set_value ().
393 * Return value: The current value of the adjustment.
396 gtk_adjustment_get_value (GtkAdjustment *adjustment)
398 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
400 return adjustment->value;
404 * gtk_adjustment_set_value:
405 * @adjustment: a #GtkAdjustment.
406 * @value: the new value.
408 * Sets the #GtkAdjustment value. The value is clamped to lie between
409 * #GtkAdjustment.lower and #GtkAdjustment.upper.
411 * Note that for adjustments which are used in a #GtkScrollbar, the effective
412 * range of allowed values goes from #GtkAdjustment.lower to
413 * #GtkAdjustment.upper - #GtkAdjustment.page_size.
416 gtk_adjustment_set_value (GtkAdjustment *adjustment,
419 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
421 /* don't use CLAMP() so we don't end up below lower if upper - page_size
422 * is smaller than lower
424 value = MIN (value, adjustment->upper - adjustment->page_size);
425 value = MAX (value, adjustment->lower);
427 if (value != adjustment->value)
429 adjustment->value = value;
431 gtk_adjustment_value_changed (adjustment);
436 * gtk_adjustment_get_lower:
437 * @adjustment: a #GtkAdjustment
439 * Retrieves the minimum value of the adjustment.
441 * Return value: The current minimum value of the adjustment.
446 gtk_adjustment_get_lower (GtkAdjustment *adjustment)
448 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
450 return adjustment->lower;
454 * gtk_adjustment_set_lower:
455 * @adjustment: a #GtkAdjustment
456 * @lower: the new minimum value
458 * Sets the minimum value of the adjustment.
460 * When setting multiple adjustment properties via their individual
461 * setters, multiple "changed" signals will be emitted. However, since
462 * the emission of the "changed" signal is tied to the emission of the
463 * "GObject::notify" signals of the changed properties, it's possible
464 * to compress the "changed" signals into one by calling
465 * g_object_freeze_notify() and g_object_thaw_notify() around the
466 * calls to the individual setters.
468 * Alternatively, using a single g_object_set() for all the properties
469 * to change, or using gtk_adjustment_configure() has the same effect
470 * of compressing "changed" emissions.
475 gtk_adjustment_set_lower (GtkAdjustment *adjustment,
478 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
480 if (lower != adjustment->lower)
481 g_object_set (adjustment, "lower", lower, NULL);
485 * gtk_adjustment_get_upper:
486 * @adjustment: a #GtkAdjustment
488 * Retrieves the maximum value of the adjustment.
490 * Return value: The current maximum value of the adjustment.
495 gtk_adjustment_get_upper (GtkAdjustment *adjustment)
497 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
499 return adjustment->upper;
503 * gtk_adjustment_set_upper:
504 * @adjustment: a #GtkAdjustment
505 * @upper: the new maximum value
507 * Sets the maximum value of the adjustment.
509 * Note that values will be restricted by
510 * <literal>upper - page-size</literal> if the page-size
511 * property is nonzero.
513 * See gtk_adjustment_set_lower() about how to compress multiple
514 * emissions of the "changed" signal when setting multiple adjustment
520 gtk_adjustment_set_upper (GtkAdjustment *adjustment,
523 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
525 if (upper != adjustment->upper)
526 g_object_set (adjustment, "upper", upper, NULL);
530 * gtk_adjustment_get_step_increment:
531 * @adjustment: a #GtkAdjustment
533 * Retrieves the step increment of the adjustment.
535 * Return value: The current step increment of the adjustment.
540 gtk_adjustment_get_step_increment (GtkAdjustment *adjustment)
542 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
544 return adjustment->step_increment;
548 * gtk_adjustment_set_step_increment:
549 * @adjustment: a #GtkAdjustment
550 * @step_increment: the new step increment
552 * Sets the step increment of the adjustment.
554 * See gtk_adjustment_set_lower() about how to compress multiple
555 * emissions of the "changed" signal when setting multiple adjustment
561 gtk_adjustment_set_step_increment (GtkAdjustment *adjustment,
562 gdouble step_increment)
564 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
566 if (step_increment != adjustment->step_increment)
567 g_object_set (adjustment, "step-increment", step_increment, NULL);
571 * gtk_adjustment_get_page_increment:
572 * @adjustment: a #GtkAdjustment
574 * Retrieves the page increment of the adjustment.
576 * Return value: The current page increment of the adjustment.
581 gtk_adjustment_get_page_increment (GtkAdjustment *adjustment)
583 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
585 return adjustment->page_increment;
589 * gtk_adjustment_set_page_increment:
590 * @adjustment: a #GtkAdjustment
591 * @page_increment: the new page increment
593 * Sets the page increment of the adjustment.
595 * See gtk_adjustment_set_lower() about how to compress multiple
596 * emissions of the "changed" signal when setting multiple adjustment
602 gtk_adjustment_set_page_increment (GtkAdjustment *adjustment,
603 gdouble page_increment)
605 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
607 if (page_increment != adjustment->page_increment)
608 g_object_set (adjustment, "page-increment", page_increment, NULL);
612 * gtk_adjustment_get_page_size:
613 * @adjustment: a #GtkAdjustment
615 * Retrieves the page size of the adjustment.
617 * Return value: The current page size of the adjustment.
622 gtk_adjustment_get_page_size (GtkAdjustment *adjustment)
624 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
626 return adjustment->page_size;
630 * gtk_adjustment_set_page_size:
631 * @adjustment: a #GtkAdjustment
632 * @page_size: the new page size
634 * Sets the page size of the adjustment.
636 * See gtk_adjustment_set_lower() about how to compress multiple
637 * emissions of the "changed" signal when setting multiple adjustment
643 gtk_adjustment_set_page_size (GtkAdjustment *adjustment,
646 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
648 if (page_size != adjustment->page_size)
649 g_object_set (adjustment, "page-size", page_size, NULL);
653 * gtk_adjustment_configure:
654 * @adjustment: a #GtkAdjustment
655 * @value: the new value
656 * @lower: the new minimum value
657 * @upper: the new maximum value
658 * @step_increment: the new step increment
659 * @page_increment: the new page increment
660 * @page_size: the new page size
662 * Sets all properties of the adjustment at once.
664 * Use this function to avoid multiple emissions of the "changed"
665 * signal. See gtk_adjustment_set_lower() for an alternative way
666 * of compressing multiple emissions of "changed" into one.
671 gtk_adjustment_configure (GtkAdjustment *adjustment,
675 gdouble step_increment,
676 gdouble page_increment,
679 gboolean value_changed = FALSE;
680 guint64 old_stamp = adjustment_changed_stamp;
682 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
684 g_object_freeze_notify (G_OBJECT (adjustment));
686 g_object_set (adjustment,
689 "step-increment", step_increment,
690 "page-increment", page_increment,
691 "page-size", page_size,
694 /* don't use CLAMP() so we don't end up below lower if upper - page_size
695 * is smaller than lower
697 value = MIN (value, upper - page_size);
698 value = MAX (value, lower);
700 if (value != adjustment->value)
702 /* set value manually to make sure "changed" is emitted with the
703 * new value in place and is emitted before "value-changed"
705 adjustment->value = value;
706 value_changed = TRUE;
709 g_object_thaw_notify (G_OBJECT (adjustment));
711 if (old_stamp == adjustment_changed_stamp)
712 gtk_adjustment_changed (adjustment); /* force emission before ::value-changed */
715 gtk_adjustment_value_changed (adjustment);
719 * gtk_adjustment_changed:
720 * @adjustment: a #GtkAdjustment
722 * Emits a #GtkAdjustment::changed signal from the #GtkAdjustment.
723 * This is typically called by the owner of the #GtkAdjustment after it has
724 * changed any of the #GtkAdjustment fields other than the value.
727 gtk_adjustment_changed (GtkAdjustment *adjustment)
729 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
731 g_signal_emit (adjustment, adjustment_signals[CHANGED], 0);
735 * gtk_adjustment_value_changed:
736 * @adjustment: a #GtkAdjustment
738 * Emits a #GtkAdjustment::value_changed signal from the #GtkAdjustment.
739 * This is typically called by the owner of the #GtkAdjustment after it has
740 * changed the #GtkAdjustment value field.
743 gtk_adjustment_value_changed (GtkAdjustment *adjustment)
745 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
747 g_signal_emit (adjustment, adjustment_signals[VALUE_CHANGED], 0);
748 g_object_notify (G_OBJECT (adjustment), "value");
752 * gtk_adjustment_clamp_page:
753 * @adjustment: a #GtkAdjustment.
754 * @lower: the lower value.
755 * @upper: the upper value.
757 * Updates the #GtkAdjustment #GtkAdjustment.value to ensure that the range
758 * between @lower and @upper is in the current page (i.e. between
759 * #GtkAdjustment.value and #GtkAdjustment.value + #GtkAdjustment.page_size).
760 * If the range is larger than the page size, then only the start of it will
761 * be in the current page.
762 * A #GtkAdjustment::changed signal will be emitted if the value is changed.
765 gtk_adjustment_clamp_page (GtkAdjustment *adjustment,
769 gboolean need_emission;
771 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
773 lower = CLAMP (lower, adjustment->lower, adjustment->upper);
774 upper = CLAMP (upper, adjustment->lower, adjustment->upper);
776 need_emission = FALSE;
778 if (adjustment->value + adjustment->page_size < upper)
780 adjustment->value = upper - adjustment->page_size;
781 need_emission = TRUE;
783 if (adjustment->value > lower)
785 adjustment->value = lower;
786 need_emission = TRUE;
790 gtk_adjustment_value_changed (adjustment);