1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
|
/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include "gtkadjustment.h"
#include "gtkadjustmentprivate.h"
#include "gtkmarshalers.h"
#include "gtkprivate.h"
/**
* GtkAdjustment:
*
* A model for a numeric value.
*
* The `GtkAdjustment` has an associated lower and upper bound.
* It also contains step and page increments, and a page size.
*
* Adjustments are used within several GTK widgets, including
* [class@Gtk.SpinButton], [class@Gtk.Viewport], [class@Gtk.Scrollbar]
* and [class@Gtk.Scale].
*
* The `GtkAdjustment` object does not update the value itself. Instead
* it is left up to the owner of the `GtkAdjustment` to control the value.
*/
struct _GtkAdjustmentPrivate {
double lower;
double upper;
double value;
double step_increment;
double page_increment;
double page_size;
double source;
double target;
guint duration;
guint tick_id;
gint64 start_time;
gint64 end_time;
GdkFrameClock *clock;
};
typedef struct _GtkAdjustmentPrivate GtkAdjustmentPrivate;
enum
{
PROP_0,
PROP_VALUE,
PROP_LOWER,
PROP_UPPER,
PROP_STEP_INCREMENT,
PROP_PAGE_INCREMENT,
PROP_PAGE_SIZE,
NUM_PROPERTIES
};
enum
{
CHANGED,
VALUE_CHANGED,
LAST_SIGNAL
};
static void gtk_adjustment_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void gtk_adjustment_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static void gtk_adjustment_dispatch_properties_changed (GObject *object,
guint n_pspecs,
GParamSpec **pspecs);
static guint adjustment_signals[LAST_SIGNAL] = { 0 };
static GParamSpec *adjustment_props[NUM_PROPERTIES] = { NULL, };
G_DEFINE_TYPE_WITH_PRIVATE (GtkAdjustment, gtk_adjustment, G_TYPE_INITIALLY_UNOWNED)
static void
gtk_adjustment_finalize (GObject *object)
{
GtkAdjustment *adjustment = GTK_ADJUSTMENT (object);
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
if (priv->tick_id)
g_signal_handler_disconnect (priv->clock, priv->tick_id);
if (priv->clock)
g_object_unref (priv->clock);
G_OBJECT_CLASS (gtk_adjustment_parent_class)->finalize (object);
}
static void
gtk_adjustment_class_init (GtkAdjustmentClass *class)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (class);
gobject_class->finalize = gtk_adjustment_finalize;
gobject_class->set_property = gtk_adjustment_set_property;
gobject_class->get_property = gtk_adjustment_get_property;
gobject_class->dispatch_properties_changed = gtk_adjustment_dispatch_properties_changed;
class->changed = NULL;
class->value_changed = NULL;
/**
* GtkAdjustment:value:
*
* The value of the adjustment.
*/
adjustment_props[PROP_VALUE] =
g_param_spec_double ("value", NULL, NULL,
-G_MAXDOUBLE, G_MAXDOUBLE,
0.0,
GTK_PARAM_READWRITE);
/**
* GtkAdjustment:lower:
*
* The minimum value of the adjustment.
*/
adjustment_props[PROP_LOWER] =
g_param_spec_double ("lower", NULL, NULL,
-G_MAXDOUBLE, G_MAXDOUBLE,
0.0,
GTK_PARAM_READWRITE);
/**
* GtkAdjustment:upper:
*
* The maximum value of the adjustment.
*
* Note that values will be restricted by `upper - page-size` if the page-size
* property is nonzero.
*/
adjustment_props[PROP_UPPER] =
g_param_spec_double ("upper", NULL, NULL,
-G_MAXDOUBLE, G_MAXDOUBLE,
0.0,
GTK_PARAM_READWRITE);
/**
* GtkAdjustment:step-increment:
*
* The step increment of the adjustment.
*/
adjustment_props[PROP_STEP_INCREMENT] =
g_param_spec_double ("step-increment", NULL, NULL,
-G_MAXDOUBLE, G_MAXDOUBLE,
0.0,
GTK_PARAM_READWRITE);
/**
* GtkAdjustment:page-increment:
*
* The page increment of the adjustment.
*/
adjustment_props[PROP_PAGE_INCREMENT] =
g_param_spec_double ("page-increment", NULL, NULL,
-G_MAXDOUBLE, G_MAXDOUBLE,
0.0,
GTK_PARAM_READWRITE);
/**
* GtkAdjustment:page-size:
*
* The page size of the adjustment.
*
* Note that the page-size is irrelevant and should be set to zero
* if the adjustment is used for a simple scalar value, e.g. in a
* `GtkSpinButton`.
*/
adjustment_props[PROP_PAGE_SIZE] =
g_param_spec_double ("page-size", NULL, NULL,
-G_MAXDOUBLE, G_MAXDOUBLE,
0.0,
GTK_PARAM_READWRITE);
g_object_class_install_properties (gobject_class, NUM_PROPERTIES, adjustment_props);
/**
* GtkAdjustment::changed:
* @adjustment: the adjustment which emitted the signal
*
* Emitted when one or more of the `GtkAdjustment` properties have been
* changed.
*
* Note that the [property@Gtk.Adjustment:value] property is
* covered by the [signal@Gtk.Adjustment::value-changed] signal.
*/
adjustment_signals[CHANGED] =
g_signal_new (I_("changed"),
G_OBJECT_CLASS_TYPE (class),
G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
G_STRUCT_OFFSET (GtkAdjustmentClass, changed),
NULL, NULL,
NULL,
G_TYPE_NONE, 0);
/**
* GtkAdjustment::value-changed:
* @adjustment: the adjustment which emitted the signal
*
* Emitted when the value has been changed.
*/
adjustment_signals[VALUE_CHANGED] =
g_signal_new (I_("value-changed"),
G_OBJECT_CLASS_TYPE (class),
G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
G_STRUCT_OFFSET (GtkAdjustmentClass, value_changed),
NULL, NULL,
NULL,
G_TYPE_NONE, 0);
}
static void
gtk_adjustment_init (GtkAdjustment *adjustment)
{
}
static void
gtk_adjustment_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkAdjustment *adjustment = GTK_ADJUSTMENT (object);
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
switch (prop_id)
{
case PROP_VALUE:
g_value_set_double (value, priv->value);
break;
case PROP_LOWER:
g_value_set_double (value, priv->lower);
break;
case PROP_UPPER:
g_value_set_double (value, priv->upper);
break;
case PROP_STEP_INCREMENT:
g_value_set_double (value, priv->step_increment);
break;
case PROP_PAGE_INCREMENT:
g_value_set_double (value, priv->page_increment);
break;
case PROP_PAGE_SIZE:
g_value_set_double (value, priv->page_size);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_adjustment_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkAdjustment *adjustment = GTK_ADJUSTMENT (object);
double double_value = g_value_get_double (value);
switch (prop_id)
{
case PROP_VALUE:
gtk_adjustment_set_value (adjustment, double_value);
break;
case PROP_LOWER:
gtk_adjustment_set_lower (adjustment, double_value);
break;
case PROP_UPPER:
gtk_adjustment_set_upper (adjustment, double_value);
break;
case PROP_STEP_INCREMENT:
gtk_adjustment_set_step_increment (adjustment, double_value);
break;
case PROP_PAGE_INCREMENT:
gtk_adjustment_set_page_increment (adjustment, double_value);
break;
case PROP_PAGE_SIZE:
gtk_adjustment_set_page_size (adjustment, double_value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static inline void
emit_value_changed (GtkAdjustment *adjustment)
{
g_signal_emit (adjustment, adjustment_signals[VALUE_CHANGED], 0);
g_object_notify_by_pspec (G_OBJECT (adjustment), adjustment_props[PROP_VALUE]);
}
static void
gtk_adjustment_dispatch_properties_changed (GObject *object,
guint n_pspecs,
GParamSpec **pspecs)
{
gboolean changed = FALSE;
int i;
G_OBJECT_CLASS (gtk_adjustment_parent_class)->dispatch_properties_changed (object, n_pspecs, pspecs);
for (i = 0; i < n_pspecs; i++)
switch (pspecs[i]->param_id)
{
case PROP_LOWER:
case PROP_UPPER:
case PROP_STEP_INCREMENT:
case PROP_PAGE_INCREMENT:
case PROP_PAGE_SIZE:
changed = TRUE;
break;
default:
break;
}
if (changed)
{
g_signal_emit (object, adjustment_signals[CHANGED], 0);
}
}
double
gtk_adjustment_get_bounded_upper (GtkAdjustment *self)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (self);
/* The real upper value is upper - page_size and not below the lower value. */
return MAX (priv->lower, priv->upper - priv->page_size);
}
static double
gtk_adjustment_sanitize_value (GtkAdjustment *self,
double value)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (self);
gdouble upper = gtk_adjustment_get_bounded_upper (self);
return CLAMP (value, priv->lower, upper);
}
/**
* gtk_adjustment_new:
* @value: the initial value
* @lower: the minimum value
* @upper: the maximum value
* @step_increment: the step increment
* @page_increment: the page increment
* @page_size: the page size
*
* Creates a new `GtkAdjustment`.
*
* Returns: a new `GtkAdjustment`
*/
GtkAdjustment *
gtk_adjustment_new (double value,
double lower,
double upper,
double step_increment,
double page_increment,
double page_size)
{
g_return_val_if_fail (lower + page_size <= upper, NULL);
return g_object_new (GTK_TYPE_ADJUSTMENT,
"lower", lower,
"upper", upper,
"step-increment", step_increment,
"page-increment", page_increment,
"page-size", page_size,
"value", value,
NULL);
}
/**
* gtk_adjustment_get_value:
* @adjustment: an adjustment
*
* Gets the current value of the adjustment.
*
* Returns: the current value
*/
double
gtk_adjustment_get_value (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
return priv->value;
}
double
gtk_adjustment_get_target_value (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
if (priv->tick_id)
return priv->target;
else
return priv->value;
}
static void
adjustment_set_value (GtkAdjustment *adjustment,
double value)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
value = gtk_adjustment_sanitize_value (adjustment, value);
if (priv->value != value)
{
priv->value = value;
emit_value_changed (adjustment);
}
}
static void gtk_adjustment_on_frame_clock_update (GdkFrameClock *clock,
GtkAdjustment *adjustment);
static void
gtk_adjustment_begin_updating (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
if (priv->tick_id == 0)
{
priv->tick_id = g_signal_connect (priv->clock, "update",
G_CALLBACK (gtk_adjustment_on_frame_clock_update), adjustment);
gdk_frame_clock_begin_updating (priv->clock);
}
}
static void
gtk_adjustment_end_updating (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
if (priv->tick_id != 0)
{
g_signal_handler_disconnect (priv->clock, priv->tick_id);
priv->tick_id = 0;
gdk_frame_clock_end_updating (priv->clock);
}
}
/* From clutter-easing.c, based on Robert Penner's
* infamous easing equations, MIT license.
*/
static double
ease_out_cubic (double t)
{
double p = t - 1;
return p * p * p + 1;
}
static void
gtk_adjustment_on_frame_clock_update (GdkFrameClock *clock,
GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
gint64 now;
now = gdk_frame_clock_get_frame_time (clock);
if (now < priv->end_time)
{
double t;
t = (now - priv->start_time) / (double) (priv->end_time - priv->start_time);
t = ease_out_cubic (t);
adjustment_set_value (adjustment, priv->source + t * (priv->target - priv->source));
}
else
{
adjustment_set_value (adjustment, priv->target);
gtk_adjustment_end_updating (adjustment);
}
}
static void
gtk_adjustment_set_value_internal (GtkAdjustment *adjustment,
double value,
gboolean animate)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
value = gtk_adjustment_sanitize_value (adjustment, value);
if (animate && priv->duration != 0 && priv->clock != NULL)
{
if (priv->tick_id && priv->target == value)
return;
priv->source = priv->value;
priv->target = value;
priv->start_time = gdk_frame_clock_get_frame_time (priv->clock);
priv->end_time = priv->start_time + 1000 * priv->duration;
gtk_adjustment_begin_updating (adjustment);
}
else
{
gtk_adjustment_end_updating (adjustment);
adjustment_set_value (adjustment, value);
}
}
/**
* gtk_adjustment_set_value:
* @adjustment: an adjustment
* @value: the new value
*
* Sets the `GtkAdjustment` value.
*
* The value is clamped to lie between [property@Gtk.Adjustment:lower]
* and [property@Gtk.Adjustment:upper].
*
* Note that for adjustments which are used in a `GtkScrollbar`,
* the effective range of allowed values goes from
* [property@Gtk.Adjustment:lower] to
* [property@Gtk.Adjustment:upper] - [property@Gtk.Adjustment:page-size].
*/
void
gtk_adjustment_set_value (GtkAdjustment *adjustment,
double value)
{
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (value));
gtk_adjustment_set_value_internal (adjustment, value, FALSE);
}
void
gtk_adjustment_animate_to_value (GtkAdjustment *adjustment,
double value)
{
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (value));
gtk_adjustment_set_value_internal (adjustment, value, TRUE);
}
/**
* gtk_adjustment_get_lower:
* @adjustment: an adjustment
*
* Retrieves the minimum value of the adjustment.
*
* Returns: the minimum value
**/
double
gtk_adjustment_get_lower (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
return priv->lower;
}
/**
* gtk_adjustment_set_lower:
* @adjustment: an adjustment
* @lower: the new minimum value
*
* Sets the minimum value of the adjustment.
*
* When setting multiple adjustment properties via their individual
* setters, multiple [signal@Gtk.Adjustment::changed] signals will
* be emitted. However, since the emission of the
* [signal@Gtk.Adjustment::changed] signal is tied to the emission
* of the ::notify signals of the changed properties, it’s possible
* to compress the [signal@Gtk.Adjustment::changed] signals into one
* by calling g_object_freeze_notify() and g_object_thaw_notify()
* around the calls to the individual setters.
*
* Alternatively, using a single g_object_set() for all the properties
* to change, or using [method@Gtk.Adjustment.configure] has the same effect.
*/
void
gtk_adjustment_set_lower (GtkAdjustment *adjustment,
double lower)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (lower));
if (lower != priv->lower)
{
priv->lower = lower;
g_object_notify_by_pspec (G_OBJECT (adjustment), adjustment_props[PROP_LOWER]);
}
}
/**
* gtk_adjustment_get_upper:
* @adjustment: an adjustment
*
* Retrieves the maximum value of the adjustment.
*
* Returns: the maximum value
*/
double
gtk_adjustment_get_upper (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
return priv->upper;
}
/**
* gtk_adjustment_set_upper:
* @adjustment: an adjustment
* @upper: the new maximum value
*
* Sets the maximum value of the adjustment.
*
* Note that values will be restricted by `upper - page-size`
* if the page-size property is nonzero.
*
* See [method@Gtk.Adjustment.set_lower] about how to compress
* multiple emissions of the [signal@Gtk.Adjustment::changed]
* signal when setting multiple adjustment properties.
*/
void
gtk_adjustment_set_upper (GtkAdjustment *adjustment,
double upper)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (upper));
if (upper != priv->upper)
{
priv->upper = upper;
g_object_notify_by_pspec (G_OBJECT (adjustment), adjustment_props[PROP_UPPER]);
}
}
/**
* gtk_adjustment_get_step_increment:
* @adjustment: an adjustment
*
* Retrieves the step increment of the adjustment.
*
* Returns: the step increment
*/
double
gtk_adjustment_get_step_increment (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
return priv->step_increment;
}
/**
* gtk_adjustment_set_step_increment:
* @adjustment: an adjustment
* @step_increment: the new step increment
*
* Sets the step increment of the adjustment.
*
* See [method@Gtk.Adjustment.set_lower] about how to compress
* multiple emissions of the [signal@Gtk.Adjustment::changed]
* signal when setting multiple adjustment properties.
*/
void
gtk_adjustment_set_step_increment (GtkAdjustment *adjustment,
double step_increment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (step_increment));
if (step_increment != priv->step_increment)
{
priv->step_increment = step_increment;
g_object_notify_by_pspec (G_OBJECT (adjustment), adjustment_props[PROP_STEP_INCREMENT]);
}
}
/**
* gtk_adjustment_get_page_increment:
* @adjustment: an adjustment
*
* Retrieves the page increment of the adjustment.
*
* Returns: the page increment
**/
double
gtk_adjustment_get_page_increment (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
return priv->page_increment;
}
/**
* gtk_adjustment_set_page_increment:
* @adjustment: an adjustment
* @page_increment: the new page increment
*
* Sets the page increment of the adjustment.
*
* See [method@Gtk.Adjustment.set_lower] about how to compress
* multiple emissions of the [signal@Gtk.Adjustment::changed]
* signal when setting multiple adjustment properties.
*/
void
gtk_adjustment_set_page_increment (GtkAdjustment *adjustment,
double page_increment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (page_increment));
if (page_increment != priv->page_increment)
{
priv->page_increment = page_increment;
g_object_notify_by_pspec (G_OBJECT (adjustment), adjustment_props[PROP_PAGE_INCREMENT]);
}
}
/**
* gtk_adjustment_get_page_size:
* @adjustment: an adjustment
*
* Retrieves the page size of the adjustment.
*
* Returns: the page size
**/
double
gtk_adjustment_get_page_size (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0.0);
return priv->page_size;
}
/**
* gtk_adjustment_set_page_size:
* @adjustment: an adjustment
* @page_size: the new page size
*
* Sets the page size of the adjustment.
*
* See [method@Gtk.Adjustment.set_lower] about how to compress
* multiple emissions of the [signal@Gtk.Adjustment::changed]
* signal when setting multiple adjustment properties.
*/
void
gtk_adjustment_set_page_size (GtkAdjustment *adjustment,
double page_size)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (page_size));
if (page_size != priv->page_size)
{
priv->page_size = page_size;
g_object_notify_by_pspec (G_OBJECT (adjustment), adjustment_props[PROP_PAGE_SIZE]);
}
}
/**
* gtk_adjustment_configure:
* @adjustment: an adjustment
* @value: the new value
* @lower: the new minimum value
* @upper: the new maximum value
* @step_increment: the new step increment
* @page_increment: the new page increment
* @page_size: the new page size
*
* Sets all properties of the adjustment at once.
*
* Use this function to avoid multiple emissions of the
* [signal@Gtk.Adjustment::changed] signal. See
* [method@Gtk.Adjustment.set_lower] for an alternative
* way of compressing multiple emissions of
* [signal@Gtk.Adjustment::changed] into one.
*/
void
gtk_adjustment_configure (GtkAdjustment *adjustment,
double value,
double lower,
double upper,
double step_increment,
double page_increment,
double page_size)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
gboolean value_changed = FALSE;
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (lower + page_size <= upper);
g_object_freeze_notify (G_OBJECT (adjustment));
gtk_adjustment_set_lower (adjustment, lower);
gtk_adjustment_set_upper (adjustment, upper);
gtk_adjustment_set_step_increment (adjustment, step_increment);
gtk_adjustment_set_page_increment (adjustment, page_increment);
gtk_adjustment_set_page_size (adjustment, page_size);
value = gtk_adjustment_sanitize_value (adjustment, value);
if (value != priv->value)
{
/* set value manually to make sure "changed" is emitted with the
* new value in place and is emitted before "value-changed"
*/
priv->value = value;
value_changed = TRUE;
}
/* The dispatch_properties_changed implementation will emit ::changed! */
g_object_thaw_notify (G_OBJECT (adjustment));
if (value_changed)
emit_value_changed (adjustment);
}
/**
* gtk_adjustment_clamp_page:
* @adjustment: an adjustment
* @lower: the lower value
* @upper: the upper value
*
* Updates the value of the adjustment to ensure that the
* given range is contained in the current page.
*
* The current page goes from `value` to `value` + `page-size`.
* If the range is larger than the page size, then only the
* start of it will be in the current page.
*
* A [signal@Gtk.Adjustment::value-changed] signal will be emitted
* if the value is changed.
*/
void
gtk_adjustment_clamp_page (GtkAdjustment *adjustment,
double lower,
double upper)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
gboolean need_emission;
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
g_return_if_fail (isfinite (lower) && isfinite (upper));
lower = CLAMP (lower, priv->lower, priv->upper);
upper = CLAMP (upper, priv->lower, priv->upper);
need_emission = FALSE;
if (priv->value + priv->page_size < upper)
{
priv->value = upper - priv->page_size;
need_emission = TRUE;
}
if (priv->value > lower)
{
priv->value = lower;
need_emission = TRUE;
}
if (need_emission)
emit_value_changed (adjustment);
}
/**
* gtk_adjustment_get_minimum_increment:
* @adjustment: an adjustment
*
* Gets the smaller of step increment and page increment.
*
* Returns: the minimum increment
*/
double
gtk_adjustment_get_minimum_increment (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
double minimum_increment;
g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), 0);
if (priv->step_increment != 0 && priv->page_increment != 0)
{
if (ABS (priv->step_increment) < ABS (priv->page_increment))
minimum_increment = priv->step_increment;
else
minimum_increment = priv->page_increment;
}
else if (priv->step_increment == 0 && priv->page_increment == 0)
{
minimum_increment = 0;
}
else if (priv->step_increment == 0)
{
minimum_increment = priv->page_increment;
}
else
{
minimum_increment = priv->step_increment;
}
return minimum_increment;
}
void
gtk_adjustment_enable_animation (GtkAdjustment *adjustment,
GdkFrameClock *clock,
guint duration)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
if (priv->clock != clock)
{
if (priv->tick_id)
{
adjustment_set_value (adjustment, priv->target);
g_signal_handler_disconnect (priv->clock, priv->tick_id);
priv->tick_id = 0;
gdk_frame_clock_end_updating (priv->clock);
}
if (priv->clock)
g_object_unref (priv->clock);
priv->clock = clock;
if (priv->clock)
g_object_ref (priv->clock);
}
priv->duration = duration;
}
guint
gtk_adjustment_get_animation_duration (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
return priv->duration;
}
gboolean
gtk_adjustment_is_animating (GtkAdjustment *adjustment)
{
GtkAdjustmentPrivate *priv = gtk_adjustment_get_instance_private (adjustment);
return priv->tick_id != 0;
}
|