![]() |
![]() |
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.
Public 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. | |
void | changed () |
Emits a "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 ). | |
double | get_lower () const |
Retrieve the lower member variable. | |
double | get_page_increment () const |
Retrieve the page_increment variable. | |
double | get_page_size () const |
Retrieve the page_size variable. | |
double | get_step_increment () const |
Retrieve the step_increment variable. | |
double | get_upper () const |
Retrieve the upper member variable. | |
double | get_value () const |
Gets the current value of the adjustment. | |
const GtkAdjustment* | gobj () const |
Provides access to the underlying C GtkObject. | |
GtkAdjustment* | gobj () |
Provides access to the underlying C GtkObject. | |
void | set_lower (double lower) |
Sets the lower member variable. | |
void | set_page_increment (double incr) |
Sets the page_increment member variable. | |
void | set_page_size (double size) |
Sets the page_size member variable. | |
void | set_step_increment (double incr) |
Sets the step_increment member variable. | |
void | set_upper (double upper) |
Sets the upper member variable. | |
void | set_value (double value) |
Sets the current value of the Adjustment. | |
Glib::SignalProxy0<void> | signal_changed () |
Glib::SignalProxy0<void> | signal_value_changed () |
void | value_changed () |
Emits a "value_changed" signal from the Adjustment. | |
virtual | ~Adjustment () |
Protected Member Functions | |
virtual void | on_changed () |
virtual void | on_value_changed () |
Friends | |
class | HScrollbar |
class | Range |
class | VScrollbar |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::Adjustment* | wrap (GtkAdjustment* object, bool take_copy=false) |
|
|
|
Constructor to create an Adjustment object.
|
|
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.
|
|
Retrieve the lower member variable.
|
|
Retrieve the page_increment variable.
|
|
Retrieve the page_size variable.
|
|
Retrieve the step_increment variable.
|
|
Retrieve the upper member variable.
|
|
Gets the current value of the adjustment. See set_value().
|
|
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Object. |
|
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Object. |
|
|
|
|
|
Sets the lower member variable.
|
|
Sets the page_increment member variable.
|
|
Sets the page_size member variable.
|
|
Sets the step_increment member variable.
|
|
Sets the upper member variable.
|
|
Sets the current value of the Adjustment.
|
|
|
|
|
|
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. |
|
|
|
|
|
|
|
|