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"
53 static void gtk_adjustment_get_property (GObject *object,
57 static void gtk_adjustment_set_property (GObject *object,
61 static void gtk_adjustment_dispatch_properties_changed (GObject *object,
65 static guint adjustment_signals[LAST_SIGNAL] = { 0 };
67 static guint64 adjustment_changed_stamp = 0; /* protected by global gdk lock */
69 G_DEFINE_TYPE (GtkAdjustment, gtk_adjustment, G_TYPE_INITIALLY_UNOWNED)
72 gtk_adjustment_class_init (GtkAdjustmentClass *class)
74 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
76 gobject_class->set_property = gtk_adjustment_set_property;
77 gobject_class->get_property = gtk_adjustment_get_property;
78 gobject_class->dispatch_properties_changed = gtk_adjustment_dispatch_properties_changed;
80 class->changed = NULL;
81 class->value_changed = NULL;
84 * GtkAdjustment:value:
86 * The value of the adjustment.
90 g_object_class_install_property (gobject_class,
92 g_param_spec_double ("value",
94 P_("The value of the adjustment"),
98 GTK_PARAM_READWRITE));
101 * GtkAdjustment:lower:
103 * The minimum value of the adjustment.
107 g_object_class_install_property (gobject_class,
109 g_param_spec_double ("lower",
111 P_("The minimum value of the adjustment"),
115 GTK_PARAM_READWRITE));
118 * GtkAdjustment:upper:
120 * The maximum value of the adjustment.
121 * Note that values will be restricted by
122 * <literal>upper - page-size</literal> if the page-size
123 * property is nonzero.
127 g_object_class_install_property (gobject_class,
129 g_param_spec_double ("upper",
131 P_("The maximum value of the adjustment"),
135 GTK_PARAM_READWRITE));
138 * GtkAdjustment:step-increment:
140 * The step increment of the adjustment.
144 g_object_class_install_property (gobject_class,
146 g_param_spec_double ("step-increment",
147 P_("Step Increment"),
148 P_("The step increment of the adjustment"),
152 GTK_PARAM_READWRITE));
155 * GtkAdjustment:page-increment:
157 * The page increment of the adjustment.
161 g_object_class_install_property (gobject_class,
163 g_param_spec_double ("page-increment",
164 P_("Page Increment"),
165 P_("The page increment of the adjustment"),
169 GTK_PARAM_READWRITE));
172 * GtkAdjustment:page-size:
174 * The page size of the adjustment.
175 * Note that the page-size is irrelevant and should be set to zero
176 * if the adjustment is used for a simple scalar value, e.g. in a
181 g_object_class_install_property (gobject_class,
183 g_param_spec_double ("page-size",
185 P_("The page size of the adjustment"),
189 GTK_PARAM_READWRITE));
191 adjustment_signals[CHANGED] =
192 g_signal_new (I_("changed"),
193 G_OBJECT_CLASS_TYPE (class),
194 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
195 G_STRUCT_OFFSET (GtkAdjustmentClass, changed),
197 _gtk_marshal_VOID__VOID,
200 adjustment_signals[VALUE_CHANGED] =
201 g_signal_new (I_("value-changed"),
202 G_OBJECT_CLASS_TYPE (class),
203 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
204 G_STRUCT_OFFSET (GtkAdjustmentClass, value_changed),
206 _gtk_marshal_VOID__VOID,
211 gtk_adjustment_init (GtkAdjustment *adjustment)
213 adjustment->value = 0.0;
214 adjustment->lower = 0.0;
215 adjustment->upper = 0.0;
216 adjustment->step_increment = 0.0;
217 adjustment->page_increment = 0.0;
218 adjustment->page_size = 0.0;
222 gtk_adjustment_get_property (GObject *object,
227 GtkAdjustment *adjustment = GTK_ADJUSTMENT (object);
232 g_value_set_double (value, adjustment->value);
235 g_value_set_double (value, adjustment->lower);
238 g_value_set_double (value, adjustment->upper);
240 case PROP_STEP_INCREMENT:
241 g_value_set_double (value, adjustment->step_increment);
243 case PROP_PAGE_INCREMENT:
244 g_value_set_double (value, adjustment->page_increment);
247 g_value_set_double (value, adjustment->page_size);
250 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
256 gtk_adjustment_set_property (GObject *object,
261 GtkAdjustment *adjustment = GTK_ADJUSTMENT (object);
262 gdouble double_value = g_value_get_double (value);
267 gtk_adjustment_set_value (adjustment, double_value);
270 adjustment->lower = double_value;
273 adjustment->upper = double_value;
275 case PROP_STEP_INCREMENT:
276 adjustment->step_increment = double_value;
278 case PROP_PAGE_INCREMENT:
279 adjustment->page_increment = double_value;
282 adjustment->page_size = double_value;
285 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
291 gtk_adjustment_dispatch_properties_changed (GObject *object,
295 gboolean changed = FALSE;
298 G_OBJECT_CLASS (gtk_adjustment_parent_class)->dispatch_properties_changed (object, n_pspecs, pspecs);
300 for (i = 0; i < n_pspecs; i++)
301 switch (pspecs[i]->param_id)
305 case PROP_STEP_INCREMENT:
306 case PROP_PAGE_INCREMENT:
316 adjustment_changed_stamp++;
317 gtk_adjustment_changed (GTK_ADJUSTMENT (object));
322 gtk_adjustment_new (gdouble value,
325 gdouble step_increment,
326 gdouble page_increment,
329 return g_object_new (GTK_TYPE_ADJUSTMENT,
332 "step-increment", step_increment,
333 "page-increment", page_increment,
334 "page-size", page_size,
340 * gtk_adjustment_get_value:
341 * @adjustment: a #GtkAdjustment
343 * Gets the current value of the adjustment. See
344 * gtk_adjustment_set_value ().
346 * Return value: The current value of the adjustment.
349 gtk_adjustment_get_value (GtkAdjustment *adjustment)
351 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
353 return adjustment->value;
357 gtk_adjustment_set_value (GtkAdjustment *adjustment,
360 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
362 /* don't use CLAMP() so we don't end up below lower if upper - page_size
363 * is smaller than lower
365 value = MIN (value, adjustment->upper - adjustment->page_size);
366 value = MAX (value, adjustment->lower);
368 if (value != adjustment->value)
370 adjustment->value = value;
372 gtk_adjustment_value_changed (adjustment);
377 * gtk_adjustment_get_lower:
378 * @adjustment: a #GtkAdjustment
380 * Retrieves the minimum value of the adjustment.
382 * Return value: The current minimum value of the adjustment.
387 gtk_adjustment_get_lower (GtkAdjustment *adjustment)
389 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
391 return adjustment->lower;
395 * gtk_adjustment_set_lower:
396 * @adjustment: a #GtkAdjustment
397 * @lower: the new minimum value
399 * Sets the minimum value of the adjustment.
401 * When setting multiple adjustment properties via their individual
402 * setters, multiple "changed" signals will be emitted. However, since
403 * the emission of the "changed" signal is tied to the emission of the
404 * "GObject::notify" signals of the changed properties, it's possible
405 * to compress the "changed" signals into one by calling
406 * g_object_freeze_notify() and g_object_thaw_notify() around the
407 * calls to the individual setters.
409 * Alternatively, using a single g_object_set() for all the properties
410 * to change, or using gtk_adjustment_configure() has the same effect
411 * of compressing "changed" emissions.
416 gtk_adjustment_set_lower (GtkAdjustment *adjustment,
419 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
421 if (lower != adjustment->lower)
422 g_object_set (adjustment, "lower", lower, NULL);
426 * gtk_adjustment_get_upper:
427 * @adjustment: a #GtkAdjustment
429 * Retrieves the maximum value of the adjustment.
431 * Return value: The current maximum value of the adjustment.
436 gtk_adjustment_get_upper (GtkAdjustment *adjustment)
438 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
440 return adjustment->upper;
444 * gtk_adjustment_set_upper:
445 * @adjustment: a #GtkAdjustment
446 * @upper: the new maximum value
448 * Sets the maximum value of the adjustment.
450 * Note that values will be restricted by
451 * <literal>upper - page-size</literal> if the page-size
452 * property is nonzero.
454 * See gtk_adjustment_set_lower() about how to compress multiple
455 * emissions of the "changed" signal when setting multiple adjustment
461 gtk_adjustment_set_upper (GtkAdjustment *adjustment,
464 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
466 if (upper != adjustment->upper)
467 g_object_set (adjustment, "upper", upper, NULL);
471 * gtk_adjustment_get_step_increment:
472 * @adjustment: a #GtkAdjustment
474 * Retrieves the step increment of the adjustment.
476 * Return value: The current step increment of the adjustment.
481 gtk_adjustment_get_step_increment (GtkAdjustment *adjustment)
483 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
485 return adjustment->step_increment;
489 * gtk_adjustment_set_step_increment:
490 * @adjustment: a #GtkAdjustment
491 * @step_increment: the new step increment
493 * Sets the step increment of the adjustment.
495 * See gtk_adjustment_set_lower() about how to compress multiple
496 * emissions of the "changed" signal when setting multiple adjustment
502 gtk_adjustment_set_step_increment (GtkAdjustment *adjustment,
503 gdouble step_increment)
505 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
507 if (step_increment != adjustment->step_increment)
508 g_object_set (adjustment, "step-increment", step_increment, NULL);
512 * gtk_adjustment_get_page_increment:
513 * @adjustment: a #GtkAdjustment
515 * Retrieves the page increment of the adjustment.
517 * Return value: The current page increment of the adjustment.
522 gtk_adjustment_get_page_increment (GtkAdjustment *adjustment)
524 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
526 return adjustment->page_increment;
530 * gtk_adjustment_set_page_increment:
531 * @adjustment: a #GtkAdjustment
532 * @page_increment: the new page increment
534 * Sets the page increment of the adjustment.
536 * See gtk_adjustment_set_lower() about how to compress multiple
537 * emissions of the "changed" signal when setting multiple adjustment
543 gtk_adjustment_set_page_increment (GtkAdjustment *adjustment,
544 gdouble page_increment)
546 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
548 if (page_increment != adjustment->page_increment)
549 g_object_set (adjustment, "page-increment", page_increment, NULL);
553 * gtk_adjustment_get_page_size:
554 * @adjustment: a #GtkAdjustment
556 * Retrieves the page size of the adjustment.
558 * Return value: The current page size of the adjustment.
563 gtk_adjustment_get_page_size (GtkAdjustment *adjustment)
565 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
567 return adjustment->page_size;
571 * gtk_adjustment_set_page_size:
572 * @adjustment: a #GtkAdjustment
573 * @page_size: the new page size
575 * Sets the page size of the adjustment.
577 * See gtk_adjustment_set_lower() about how to compress multiple
578 * emissions of the "changed" signal when setting multiple adjustment
584 gtk_adjustment_set_page_size (GtkAdjustment *adjustment,
587 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
589 if (page_size != adjustment->page_size)
590 g_object_set (adjustment, "page-size", page_size, NULL);
594 * gtk_adjustment_configure:
595 * @adjustment: a #GtkAdjustment
596 * @value: the new value
597 * @lower: the new minimum value
598 * @upper: the new maximum value
599 * @step_increment: the new step increment
600 * @page_increment: the new page increment
601 * @page_size: the new page size
603 * Sets all properties of the adjustment at once.
605 * Use this function to avoid multiple emissions of the "changed"
606 * signal. See gtk_adjustment_set_lower() for an alternative way
607 * of compressing multiple emissions of "changed" into one.
612 gtk_adjustment_configure (GtkAdjustment *adjustment,
616 gdouble step_increment,
617 gdouble page_increment,
620 gboolean value_changed = FALSE;
621 guint64 old_stamp = adjustment_changed_stamp;
623 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
625 g_object_freeze_notify (G_OBJECT (adjustment));
627 g_object_set (adjustment,
630 "step-increment", step_increment,
631 "page-increment", page_increment,
632 "page-size", page_size,
635 /* don't use CLAMP() so we don't end up below lower if upper - page_size
636 * is smaller than lower
638 value = MIN (value, upper - page_size);
639 value = MAX (value, lower);
641 if (value != adjustment->value)
643 /* set value manually to make sure "changed" is emitted with the
644 * new value in place and is emitted before "value-changed"
646 adjustment->value = value;
647 value_changed = TRUE;
650 g_object_thaw_notify (G_OBJECT (adjustment));
652 if (old_stamp == adjustment_changed_stamp)
653 gtk_adjustment_changed (adjustment); /* force emission before ::value-changed */
656 gtk_adjustment_value_changed (adjustment);
660 gtk_adjustment_changed (GtkAdjustment *adjustment)
662 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
664 g_signal_emit (adjustment, adjustment_signals[CHANGED], 0);
668 gtk_adjustment_value_changed (GtkAdjustment *adjustment)
670 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
672 g_signal_emit (adjustment, adjustment_signals[VALUE_CHANGED], 0);
673 g_object_notify (G_OBJECT (adjustment), "value");
677 gtk_adjustment_clamp_page (GtkAdjustment *adjustment,
681 gboolean need_emission;
683 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
685 lower = CLAMP (lower, adjustment->lower, adjustment->upper);
686 upper = CLAMP (upper, adjustment->lower, adjustment->upper);
688 need_emission = FALSE;
690 if (adjustment->value + adjustment->page_size < upper)
692 adjustment->value = upper - adjustment->page_size;
693 need_emission = TRUE;
695 if (adjustment->value > lower)
697 adjustment->value = lower;
698 need_emission = TRUE;
702 gtk_adjustment_value_changed (adjustment);