GtkAdjustment — A representation of an adjustable bounded value
GtkAdjustment * | gtk_adjustment_new () |
double | gtk_adjustment_get_value () |
void | gtk_adjustment_set_value () |
void | gtk_adjustment_clamp_page () |
void | gtk_adjustment_configure () |
double | gtk_adjustment_get_lower () |
double | gtk_adjustment_get_page_increment () |
double | gtk_adjustment_get_page_size () |
double | gtk_adjustment_get_step_increment () |
double | gtk_adjustment_get_minimum_increment () |
double | gtk_adjustment_get_upper () |
void | gtk_adjustment_set_lower () |
void | gtk_adjustment_set_page_increment () |
void | gtk_adjustment_set_page_size () |
void | gtk_adjustment_set_step_increment () |
void | gtk_adjustment_set_upper () |
double | lower | Read / Write |
double | page-increment | Read / Write |
double | page-size | Read / Write |
double | step-increment | Read / Write |
double | upper | Read / Write |
double | value | Read / Write |
void | changed | No Recursion |
void | value-changed | No Recursion |
GObject ╰── GInitiallyUnowned ╰── GtkAdjustment
#include <gtk/gtk.h>
The GtkAdjustment object represents a value which has an associated lower and upper bound, together with step and page increments, and a page size. It is used within several GTK+ widgets, including GtkSpinButton, GtkViewport, and GtkRange (which is a base class for GtkScrollbar and GtkScale).
The GtkAdjustment object does not update the value itself. Instead it is left up to the owner of the GtkAdjustment to control the value.
GtkAdjustment * gtk_adjustment_new (double value
,double lower
,double upper
,double step_increment
,double page_increment
,double page_size
);
Creates a new GtkAdjustment.
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 |
a new GtkAdjustment
double
gtk_adjustment_get_value (GtkAdjustment *adjustment
);
Gets the current value of the adjustment. See gtk_adjustment_set_value()
.
adjustment |
The current value of the adjustment
void gtk_adjustment_set_value (GtkAdjustment *adjustment
,double value
);
Sets the GtkAdjustment value. The value is clamped to lie between “lower” and “upper”.
Note that for adjustments which are used in a GtkScrollbar, the effective range of allowed values goes from “lower” to “upper” - “page-size”.
adjustment | ||
value | the new value |
void gtk_adjustment_clamp_page (GtkAdjustment *adjustment
,double lower
,double upper
);
Updates the “value” property to ensure that the range between lower
and upper
is in the current page (i.e. between “value” and “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 “value-changed” signal will be emitted if the value is changed.
adjustment | ||
lower | the lower value | |
upper | the upper value |
void gtk_adjustment_configure (GtkAdjustment *adjustment
,double value
,double lower
,double upper
,double step_increment
,double page_increment
,double page_size
);
Sets all properties of the adjustment at once.
Use this function to avoid multiple emissions of the “changed” signal. See gtk_adjustment_set_lower()
for an alternative way of compressing multiple emissions of “changed” into one.
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 |
double
gtk_adjustment_get_lower (GtkAdjustment *adjustment
);
Retrieves the minimum value of the adjustment.
adjustment |
The current minimum value of the adjustment
double
gtk_adjustment_get_page_increment (GtkAdjustment *adjustment
);
Retrieves the page increment of the adjustment.
adjustment |
The current page increment of the adjustment
double
gtk_adjustment_get_page_size (GtkAdjustment *adjustment
);
Retrieves the page size of the adjustment.
adjustment |
The current page size of the adjustment
double
gtk_adjustment_get_step_increment (GtkAdjustment *adjustment
);
Retrieves the step increment of the adjustment.
adjustment |
The current step increment of the adjustment.
double
gtk_adjustment_get_minimum_increment (GtkAdjustment *adjustment
);
Gets the smaller of step increment and page increment.
adjustment |
the minimum increment of adjustment
double
gtk_adjustment_get_upper (GtkAdjustment *adjustment
);
Retrieves the maximum value of the adjustment.
adjustment |
The current maximum value of the adjustment
void gtk_adjustment_set_lower (GtkAdjustment *adjustment
,double lower
);
Sets the minimum value of the adjustment.
When setting multiple adjustment properties via their individual setters, multiple “changed” signals will be emitted. However, since the emission of the “changed” signal is tied to the emission of the “notify” signals of the changed properties, it’s possible to compress the “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 gtk_adjustment_configure()
has the same effect of compressing “changed” emissions.
adjustment | ||
lower | the new minimum value |
void gtk_adjustment_set_page_increment (GtkAdjustment *adjustment
,double page_increment
);
Sets the page increment of the adjustment.
See gtk_adjustment_set_lower()
about how to compress multiple emissions of the “changed” signal when setting multiple adjustment properties.
adjustment | ||
page_increment | the new page increment |
void gtk_adjustment_set_page_size (GtkAdjustment *adjustment
,double page_size
);
Sets the page size of the adjustment.
See gtk_adjustment_set_lower()
about how to compress multiple emissions of the GtkAdjustment::changed signal when setting multiple adjustment properties.
adjustment | ||
page_size | the new page size |
void gtk_adjustment_set_step_increment (GtkAdjustment *adjustment
,double step_increment
);
Sets the step increment of the adjustment.
See gtk_adjustment_set_lower()
about how to compress multiple emissions of the “changed” signal when setting multiple adjustment properties.
adjustment | ||
step_increment | the new step increment |
void gtk_adjustment_set_upper (GtkAdjustment *adjustment
,double upper
);
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 gtk_adjustment_set_lower()
about how to compress multiple emissions of the “changed” signal when setting multiple adjustment properties.
adjustment | ||
upper | the new maximum value |
typedef struct _GtkAdjustment GtkAdjustment;
The GtkAdjustment contains only private fields and should not be directly accessed.
“lower”
property“lower” double
The minimum value of the adjustment.
Owner: GtkAdjustment
Flags: Read / Write
Default value: 0
“page-increment”
property“page-increment” double
The page increment of the adjustment.
Owner: GtkAdjustment
Flags: Read / Write
Default value: 0
“page-size”
property“page-size” double
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.
Owner: GtkAdjustment
Flags: Read / Write
Default value: 0
“step-increment”
property“step-increment” double
The step increment of the adjustment.
Owner: GtkAdjustment
Flags: Read / Write
Default value: 0
“upper”
property“upper” double
The maximum value of the adjustment. Note that values will be restricted by upper - page-size
if the page-size property is nonzero.
Owner: GtkAdjustment
Flags: Read / Write
Default value: 0
“value”
property“value” double
The value of the adjustment.
Owner: GtkAdjustment
Flags: Read / Write
Default value: 0
“changed”
signalvoid user_function (GtkAdjustment *adjustment, gpointer user_data)
Emitted when one or more of the GtkAdjustment properties have been changed, other than the “value” property.
adjustment | the object which received the signal | |
user_data | user data set when the signal handler was connected. |
Flags: No Recursion
“value-changed”
signalvoid user_function (GtkAdjustment *adjustment, gpointer user_data)
Emitted when the “value” property has been changed.
adjustment | the object which received the signal | |
user_data | user data set when the signal handler was connected. |
Flags: No Recursion
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkAdjustment.html