gtkmm 3.24.10
|
A class representing an adjustable bounded value. More...
#include <gtkmm/adjustment.h>
Public Member Functions | |
Adjustment (Adjustment &&src) noexcept | |
Adjustment & | operator= (Adjustment &&src) noexcept |
~Adjustment () noexcept override | |
GtkAdjustment * | gobj () |
Provides access to the underlying C GObject. | |
const GtkAdjustment * | gobj () const |
Provides access to the underlying C GObject. | |
GtkAdjustment * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | changed () |
Emits a "changed" signal from the Adjustment. | |
void | value_changed () |
Emits a "value_changed" signal from the Adjustment. | |
void | clamp_page (double lower, double upper) |
Updates the Adjustment value to ensure that the range between the parameters lower and upper is in the current page (i.e. between value and value + page_size). | |
void | set_value (double value) |
Sets the current value of the Adjustment. | |
double | get_value () const |
Gets the current value of the adjustment. | |
void | set_lower (double lower) |
Sets the minimum value of the adjustment. | |
double | get_lower () const |
Retrieves the minimum value of the adjustment. | |
void | set_upper (double upper) |
Sets the maximum value of the adjustment. | |
double | get_upper () const |
Retrieves the maximum value of the adjustment. | |
void | set_step_increment (double step_increment) |
Sets the step increment of the adjustment. | |
double | get_step_increment () const |
Retrieves the step increment of the adjustment. | |
void | set_page_increment (double page_increment) |
Sets the page increment of the adjustment. | |
double | get_page_increment () const |
Retrieves the page increment of the adjustment. | |
void | set_page_size (double page_size) |
Sets the page size of the adjustment. | |
double | get_page_size () const |
Retrieves the page size of the adjustment. | |
void | configure (double value, double lower, double upper, double step_increment, double page_increment, double page_size) |
Sets all properties of the adjustment at once. | |
double | get_minimum_increment () const |
Gets the smaller of step increment and page increment. | |
Glib::SignalProxy< void > | signal_changed () |
Glib::SignalProxy< void > | signal_value_changed () |
Glib::PropertyProxy< double > | property_value () |
The value of the adjustment. | |
Glib::PropertyProxy_ReadOnly< double > | property_value () const |
The value of the adjustment. | |
Glib::PropertyProxy< double > | property_lower () |
The minimum value of the adjustment. | |
Glib::PropertyProxy_ReadOnly< double > | property_lower () const |
The minimum value of the adjustment. | |
Glib::PropertyProxy< double > | property_upper () |
The maximum value of the adjustment. | |
Glib::PropertyProxy_ReadOnly< double > | property_upper () const |
The maximum value of the adjustment. | |
Glib::PropertyProxy< double > | property_step_increment () |
The step increment of the adjustment. | |
Glib::PropertyProxy_ReadOnly< double > | property_step_increment () const |
The step increment of the adjustment. | |
Glib::PropertyProxy< double > | property_page_increment () |
The page increment of the adjustment. | |
Glib::PropertyProxy_ReadOnly< double > | property_page_increment () const |
The page increment of the adjustment. | |
Glib::PropertyProxy< double > | property_page_size () |
The page size of the adjustment. | |
Glib::PropertyProxy_ReadOnly< double > | property_page_size () const |
The page size of the adjustment. | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
static Glib::RefPtr< Adjustment > | create (double value, double lower, double upper, double step_increment=1, double page_increment=10, double page_size=0) |
Protected Member Functions | |
Adjustment (double value, double lower, double upper, double step_increment=1, double page_increment=10, double page_size=0) | |
Constructor to create an Adjustment object. | |
virtual void | on_changed () |
This is a default handler for the signal signal_changed(). | |
virtual void | on_value_changed () |
This is a default handler for the signal signal_value_changed(). | |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gtk::Adjustment > | wrap (GtkAdjustment *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
A class representing an adjustable bounded value.
The Gtk::Adjustment 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 gtkmm widgets, including Gtk::SpinButton, Gtk::Viewport, and Gtk::Range (which is a base class for Gtk::HScrollbar, Gtk::VScrollbar, Gtk::HScale, and Gtk::VScale).
The Gtk::Adjustment object does not update the value itself. Instead it is left up to the owner of the Gtk::Adjustment to control the value.
The owner of the Gtk::Adjustment typically calls the value_changed() and changed() functions after changing the value and its bounds. This results in the emission of the "value_changed" or "changed" signal respectively.
|
noexcept |
|
overridenoexcept |
|
protected |
Constructor to create an Adjustment object.
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 |
void Gtk::Adjustment::changed | ( | ) |
Emits a "changed" signal from the Adjustment.
This is typically called by the owner of the Adjustment after it has changed any of the Adjustment fields other than the value.
Updates the Adjustment value to ensure that the range between the parameters lower and upper is in the current page (i.e. between value and value + page_size).
If this range is larger than the page size, then only the start of it will be in the current page. A "changed" signal will be emitted if the value is changed.
lower | The lower value. |
upper | The upper value. |
void Gtk::Adjustment::configure | ( | 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 Gtk::Adjustment::signal_changed() signal. See set_lower() for an alternative way of compressing multiple emissions of Gtk::Adjustment::signal_changed() into one.
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. |
|
static |
double Gtk::Adjustment::get_lower | ( | ) | const |
Retrieves the minimum value of the adjustment.
double Gtk::Adjustment::get_minimum_increment | ( | ) | const |
Gets the smaller of step increment and page increment.
double Gtk::Adjustment::get_page_increment | ( | ) | const |
Retrieves the page increment of the adjustment.
double Gtk::Adjustment::get_page_size | ( | ) | const |
Retrieves the page size of the adjustment.
double Gtk::Adjustment::get_step_increment | ( | ) | const |
Retrieves the step increment of the adjustment.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
double Gtk::Adjustment::get_upper | ( | ) | const |
Retrieves the maximum value of the adjustment.
double Gtk::Adjustment::get_value | ( | ) | const |
Gets the current value of the adjustment.
See set_value().
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkAdjustment * Gtk::Adjustment::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
This is a default handler for the signal signal_changed().
This is a default handler for the signal signal_value_changed().
|
noexcept |
Glib::PropertyProxy< double > Gtk::Adjustment::property_lower | ( | ) |
The minimum value of the adjustment.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Adjustment::property_lower | ( | ) | const |
The minimum value of the adjustment.
Default value: 0
Glib::PropertyProxy< double > Gtk::Adjustment::property_page_increment | ( | ) |
The page increment of the adjustment.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Adjustment::property_page_increment | ( | ) | const |
The page increment of the adjustment.
Default value: 0
Glib::PropertyProxy< double > Gtk::Adjustment::property_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 Gtk::SpinButton.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Adjustment::property_page_size | ( | ) | const |
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 Gtk::SpinButton.
Default value: 0
Glib::PropertyProxy< double > Gtk::Adjustment::property_step_increment | ( | ) |
The step increment of the adjustment.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Adjustment::property_step_increment | ( | ) | const |
The step increment of the adjustment.
Default value: 0
Glib::PropertyProxy< double > Gtk::Adjustment::property_upper | ( | ) |
The maximum value of the adjustment.
Note that values will be restricted by upper - page-size
if the page-size property is nonzero.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Adjustment::property_upper | ( | ) | const |
The maximum value of the adjustment.
Note that values will be restricted by upper - page-size
if the page-size property is nonzero.
Default value: 0
Glib::PropertyProxy< double > Gtk::Adjustment::property_value | ( | ) |
The value of the adjustment.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Adjustment::property_value | ( | ) | const |
The value of the adjustment.
Default value: 0
Sets the minimum value of the adjustment.
When setting multiple adjustment properties via their individual setters, multiple Gtk::Adjustment::signal_changed() signals will be emitted. However, since the emission of the Gtk::Adjustment::signal_changed() signal is tied to the emission of the Glib::Object::signal_notify() signals of the changed properties, it’s possible to compress the Gtk::Adjustment::signal_changed() signals into one by calling Glib::object_freeze_notify() and Glib::object_thaw_notify() around the calls to the individual setters.
Alternatively, using a single Glib::object_set() for all the properties to change, or using configure() has the same effect of compressing Gtk::Adjustment::signal_changed() emissions.
lower | The new minimum value. |
Sets the page increment of the adjustment.
See set_lower() about how to compress multiple emissions of the Gtk::Adjustment::signal_changed() signal when setting multiple adjustment properties.
page_increment | The new page increment. |
Sets the page size of the adjustment.
See set_lower() about how to compress multiple emissions of the GtkAdjustment::changed signal when setting multiple adjustment properties.
page_size | The new page size. |
Sets the step increment of the adjustment.
See set_lower() about how to compress multiple emissions of the Gtk::Adjustment::signal_changed() signal when setting multiple adjustment properties.
step_increment | The new step increment. |
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 set_lower() about how to compress multiple emissions of the Gtk::Adjustment::signal_changed() signal when setting multiple adjustment properties.
upper | The new maximum value. |
Sets the current value of the Adjustment.
value | The new value of the Adjustment. |
Glib::SignalProxy< void > Gtk::Adjustment::signal_changed | ( | ) |
void on_my_changed()
Flags: Run First, No Recurse
Emitted when one or more of the Gtk::Adjustment properties have been changed, other than the Gtk::Adjustment::property_value() property.
Glib::SignalProxy< void > Gtk::Adjustment::signal_value_changed | ( | ) |
void on_my_value_changed()
Flags: Run First, No Recurse
Emitted when the Gtk::Adjustment::property_value() property has been changed.
void Gtk::Adjustment::value_changed | ( | ) |
Emits a "value_changed" signal from the Adjustment.
This is typically called by the owner of the Adjustment after it has changed the Adjustment value field.
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |