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, GTK_TYPE_OBJECT)
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 value = CLAMP (value, adjustment->lower, adjustment->upper);
364 if (value != adjustment->value)
366 adjustment->value = value;
368 gtk_adjustment_value_changed (adjustment);
373 * gtk_adjustment_get_lower:
374 * @adjustment: a #GtkAdjustment
376 * Retrieves the minimum value of the adjustment.
378 * Return value: The current minimum value of the adjustment.
383 gtk_adjustment_get_lower (GtkAdjustment *adjustment)
385 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
387 return adjustment->lower;
391 * gtk_adjustment_set_lower:
392 * @adjustment: a #GtkAdjustment
393 * @lower: the new minimum value
395 * Sets the minimum value of the adjustment.
397 * When setting multiple adjustment properties via their individual
398 * setters, multiple "changed" signals will be emitted. However, since
399 * the emission of the "changed" signal is tied to the emission of the
400 * "GObject::notify" signals of the changed properties, it's possible
401 * to compress the "changed" signals into one by calling
402 * g_object_freeze_notify() and g_object_thaw_notify() around the
403 * calls to the individual setters.
405 * Alternatively, using a single g_object_set() for all the properties
406 * to change, or using gtk_adjustment_configure() has the same effect
407 * of compressing "changed" emissions.
412 gtk_adjustment_set_lower (GtkAdjustment *adjustment,
415 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
417 if (lower != adjustment->lower)
418 g_object_set (adjustment, "lower", lower, NULL);
422 * gtk_adjustment_get_upper:
423 * @adjustment: a #GtkAdjustment
425 * Retrieves the maximum value of the adjustment.
427 * Return value: The current maximum value of the adjustment.
432 gtk_adjustment_get_upper (GtkAdjustment *adjustment)
434 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
436 return adjustment->upper;
440 * gtk_adjustment_set_upper:
441 * @adjustment: a #GtkAdjustment
442 * @upper: the new maximum value
444 * Sets the maximum value of the adjustment.
446 * Note that values will be restricted by
447 * <literal>upper - page-size</literal> if the page-size
448 * property is nonzero.
450 * See gtk_adjustment_set_lower() about how to compress multiple
451 * emissions of the "changed" signal when setting multiple adjustment
457 gtk_adjustment_set_upper (GtkAdjustment *adjustment,
460 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
462 if (upper != adjustment->upper)
463 g_object_set (adjustment, "upper", upper, NULL);
467 * gtk_adjustment_get_step_increment:
468 * @adjustment: a #GtkAdjustment
470 * Retrieves the step increment of the adjustment.
472 * Return value: The current step increment of the adjustment.
477 gtk_adjustment_get_step_increment (GtkAdjustment *adjustment)
479 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
481 return adjustment->step_increment;
485 * gtk_adjustment_set_step_increment:
486 * @adjustment: a #GtkAdjustment
487 * @step_increment: the new step increment
489 * Sets the step increment of the adjustment.
491 * See gtk_adjustment_set_lower() about how to compress multiple
492 * emissions of the "changed" signal when setting multiple adjustment
498 gtk_adjustment_set_step_increment (GtkAdjustment *adjustment,
499 gdouble step_increment)
501 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
503 if (step_increment != adjustment->step_increment)
504 g_object_set (adjustment, "step-increment", step_increment, NULL);
508 * gtk_adjustment_get_page_increment:
509 * @adjustment: a #GtkAdjustment
511 * Retrieves the page increment of the adjustment.
513 * Return value: The current page increment of the adjustment.
518 gtk_adjustment_get_page_increment (GtkAdjustment *adjustment)
520 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
522 return adjustment->page_increment;
526 * gtk_adjustment_set_page_increment:
527 * @adjustment: a #GtkAdjustment
528 * @page_increment: the new page increment
530 * Sets the page increment of the adjustment.
532 * See gtk_adjustment_set_lower() about how to compress multiple
533 * emissions of the "changed" signal when setting multiple adjustment
539 gtk_adjustment_set_page_increment (GtkAdjustment *adjustment,
540 gdouble page_increment)
542 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
544 if (page_increment != adjustment->page_increment)
545 g_object_set (adjustment, "page-increment", page_increment, NULL);
549 * gtk_adjustment_get_page_size:
550 * @adjustment: a #GtkAdjustment
552 * Retrieves the page size of the adjustment.
554 * Return value: The current page size of the adjustment.
559 gtk_adjustment_get_page_size (GtkAdjustment *adjustment)
561 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
563 return adjustment->page_size;
567 * gtk_adjustment_set_page_size:
568 * @adjustment: a #GtkAdjustment
569 * @page_size: the new page size
571 * Sets the page size of the adjustment.
573 * See gtk_adjustment_set_lower() about how to compress multiple
574 * emissions of the "changed" signal when setting multiple adjustment
580 gtk_adjustment_set_page_size (GtkAdjustment *adjustment,
583 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
585 if (page_size != adjustment->page_size)
586 g_object_set (adjustment, "page-size", page_size, NULL);
590 * gtk_adjustment_configure:
591 * @adjustment: a #GtkAdjustment
592 * @value: the new value
593 * @lower: the new minimum value
594 * @upper: the new maximum value
595 * @step_increment: the new step increment
596 * @page_increment: the new page increment
597 * @page_size: the new page size
599 * Sets all properties of the adjustment at once.
601 * Use this function to avoid multiple emissions of the "changed"
602 * signal. See gtk_adjustment_set_lower() for an alternative way
603 * of compressing multiple emissions of "changed" into one.
608 gtk_adjustment_configure (GtkAdjustment *adjustment,
612 gdouble step_increment,
613 gdouble page_increment,
616 gboolean value_changed = FALSE;
617 guint64 old_stamp = adjustment_changed_stamp;
619 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
621 g_object_freeze_notify (G_OBJECT (adjustment));
623 g_object_set (adjustment,
626 "step-increment", step_increment,
627 "page-increment", page_increment,
628 "page-size", page_size,
631 /* don't use CLAMP() so we don't end up below lower if upper - page_size
632 * is smaller than lower
634 value = MIN (value, upper - page_size);
635 value = MAX (value, lower);
637 if (value != adjustment->value)
639 /* set value manually to make sure "changed" is emitted with the
640 * new value in place and is emitted before "value-changed"
642 adjustment->value = value;
643 value_changed = TRUE;
646 g_object_thaw_notify (G_OBJECT (adjustment));
648 if (old_stamp == adjustment_changed_stamp)
649 gtk_adjustment_changed (adjustment); /* force emission before ::value-changed */
652 gtk_adjustment_value_changed (adjustment);
656 gtk_adjustment_changed (GtkAdjustment *adjustment)
658 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
660 g_signal_emit (adjustment, adjustment_signals[CHANGED], 0);
664 gtk_adjustment_value_changed (GtkAdjustment *adjustment)
666 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
668 g_signal_emit (adjustment, adjustment_signals[VALUE_CHANGED], 0);
669 g_object_notify (G_OBJECT (adjustment), "value");
673 gtk_adjustment_clamp_page (GtkAdjustment *adjustment,
677 gboolean need_emission;
679 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
681 lower = CLAMP (lower, adjustment->lower, adjustment->upper);
682 upper = CLAMP (upper, adjustment->lower, adjustment->upper);
684 need_emission = FALSE;
686 if (adjustment->value + adjustment->page_size < upper)
688 adjustment->value = upper - adjustment->page_size;
689 need_emission = TRUE;
691 if (adjustment->value > lower)
693 adjustment->value = lower;
694 need_emission = TRUE;
698 gtk_adjustment_value_changed (adjustment);
701 #define __GTK_ADJUSTMENT_C__
702 #include "gtkaliasdef.c"