logo top
Main Page   Widgets   Namespaces   Book  

Gtk::Adjustment Class Reference

A class representing an adjustable bounded value. More...

Inheritance diagram for Gtk::Adjustment:

Inheritance graph
List of all members.

Public Methods

virtual ~Adjustment ()
GtkAdjustment* gobj ()
const GtkAdjustment* gobj () const
 Adjustment (double value, double lower, double upper, double step_increment=1, double page_increment=10, double page_size=0)
void changed ()
void value_changed ()
void clamp_page (double lower, double upper)
void set_value (double value)
double get_value () const
 Gets the current value of the adjustment.

double get_lower () const
double get_upper () const
double get_step_increment () const
double get_page_increment () const
double get_page_size () const
void set_lower (double lower)
void set_upper (double upper)
void set_step_increment (double incr)
void set_page_increment (double incr)
void set_page_size (double size)
Glib::SignalProxy0<void> signal_changed ()
Glib::SignalProxy0<void> signal_value_changed ()

Protected Methods

virtual void on_changed ()
virtual void on_value_changed ()


class Range
class HScrollbar
class VScrollbar

Related Functions

(Note that these are not member functions.)

Gtk::Adjustment* wrap (GtkAdjustment* object, bool take_copy=false)

Detailed Description

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.

Constructor & Destructor Documentation

virtual Gtk::Adjustment::~Adjustment (   [virtual]

Gtk::Adjustment::Adjustment ( double    value,
double    lower,
double    upper,
double    step_increment = 1,
double    page_increment = 10,
double    page_size = 0

Member Function Documentation

void Gtk::Adjustment::changed (  

void Gtk::Adjustment::clamp_page ( double    lower,
double    upper

double Gtk::Adjustment::get_lower (   const

double Gtk::Adjustment::get_page_increment (   const

double Gtk::Adjustment::get_page_size (   const

double Gtk::Adjustment::get_step_increment (   const

double Gtk::Adjustment::get_upper (   const

double Gtk::Adjustment::get_value (   const

Gets the current value of the adjustment.

See set_value().

The current value of the adjustment.

const GtkAdjustment* Gtk::Adjustment::gobj (   const [inline]

Reimplemented from Gtk::Object.

GtkAdjustment* Gtk::Adjustment::gobj (   [inline]

Reimplemented from Gtk::Object.

virtual void Gtk::Adjustment::on_changed (   [protected, virtual]

virtual void Gtk::Adjustment::on_value_changed (   [protected, virtual]

void Gtk::Adjustment::set_lower ( double    lower

void Gtk::Adjustment::set_page_increment ( double    incr

void Gtk::Adjustment::set_page_size ( double    size

void Gtk::Adjustment::set_step_increment ( double    incr

void Gtk::Adjustment::set_upper ( double    upper

void Gtk::Adjustment::set_value ( double    value

Glib::SignalProxy0<void> Gtk::Adjustment::signal_changed (  

void changed()

Glib::SignalProxy0<void> Gtk::Adjustment::signal_value_changed (  

void value_changed()

void Gtk::Adjustment::value_changed (  

Friends And Related Function Documentation

friend class HScrollbar [friend]

friend class Range [friend]

friend class VScrollbar [friend]

Gtk::Adjustment* wrap ( GtkAdjustment*    object,
bool    take_copy = false

The documentation for this class was generated from the following file:
Generated for gtkmm by Doxygen 1.3-rc1 © 1997-2001