Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk::Adjustment Class Reference

A GtkAdjustment C++ wrapper class. More...

#include <xfc/gtk/adjustment.hh>

Inheritance diagram for Xfc::Gtk::Adjustment:

Xfc::Gtk::Object Xfc::G::Object Xfc::G::TypeInstance Xfc::Trackable List of all members.

Signal Prototypes

Public Member Functions

Accessors
Methods
Signal Proxies

Detailed Description

A GtkAdjustment C++ wrapper class.

The 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 widgets, including SpinButton, Viewport, and Range (which is a base class for HScrollbar, VScrollbar, HScale, and VScale).

The Adjustment object does not update the value itself. Instead it is left up to the owner of the Adjustment to control the value. The owner of the Adjustment typically calls the value_changed() and changed() methods after changing the value and its bounds. This results in the emission of the value_changed or changed signal respectively.

See also: the Adjustment and Range Widget HOWTOs and example.


Constructor & Destructor Documentation

Xfc::Gtk::Adjustment::Adjustment ( GtkAdjustment *  adjustment,
bool  owns_reference = false 
) [explicit, protected]

Construct a new Adjustment from an existing GtkAdjustment.

Parameters:
adjustment A pointer to a GtkAdjustment.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The adjustment can be a newly created GtkAdjustment or an existing GtkAdjustment. (see G::Object::Object).

Xfc::Gtk::Adjustment::Adjustment ( double  lower,
double  upper,
double  step_increment,
double  page_increment,
double  page_size 
)

Construct a new Adjustment.

Parameters:
lower The minimum value.
upper The maximum value.
step_increment The step increment.
page_increment The page increment.
page_size The page size.
The step_increment is the increment to use to make minor changes to the value. In a Scrollbar this increment is used when the mouse is clicked on the arrows at the top and bottom of the scrollbar, to scroll by a small amount. The page_increment is the increment to use to make major changes to the value. In a Scrollbar this increment is used when the mouse is clicked in the trough, to scroll by a large amount. The page size in a Scrollbar is the size of the area which is currently visible.

Xfc::Gtk::Adjustment::Adjustment ( double  value,
double  lower,
double  upper,
double  step_increment,
double  page_increment,
double  page_size 
)

Construct a new Adjustment.

Parameters:
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.
The step increment is the increment to use to make minor changes to the value. The page increment is the increment to use to make major changes to the value.

Xfc::Gtk::Adjustment::Adjustment ( GtkAdjustment *  adjustment,
bool  owns_reference = false 
) [explicit, protected]

Construct a new Adjustment from an existing GtkAdjustment.

Parameters:
adjustment A pointer to a GtkAdjustment.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The adjustment can be a newly created GtkAdjustment or an existing GtkAdjustment. (see G::Object::Object).

Xfc::Gtk::Adjustment::Adjustment ( double  lower,
double  upper,
double  step_increment,
double  page_increment,
double  page_size 
)

Construct a new Adjustment.

Parameters:
lower The minimum value.
upper The maximum value.
step_increment The step increment.
page_increment The page increment.
page_size The page size.
The step_increment is the increment to use to make minor changes to the value. In a Scrollbar this increment is used when the mouse is clicked on the arrows at the top and bottom of the scrollbar, to scroll by a small amount. The page_increment is the increment to use to make major changes to the value. In a Scrollbar this increment is used when the mouse is clicked in the trough, to scroll by a large amount. The page size in a Scrollbar is the size of the area which is currently visible.

Xfc::Gtk::Adjustment::Adjustment ( double  value,
double  lower,
double  upper,
double  step_increment,
double  page_increment,
double  page_size 
)

Construct a new Adjustment.

Parameters:
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.
The step increment is the increment to use to make minor changes to the value. The page increment is the increment to use to make major changes to the value.


Member Function Documentation

void Xfc::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.

void Xfc::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.

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

Updates the Adjustment value to ensure that the range between lower and upper is in the current page (i.e.

between value and value + page_size).

Parameters:
lower The lower value.
upper The upper value.
If the 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.

void Xfc::Gtk::Adjustment::set_value ( double  value  ) 

Sets the Adjustment value.

Parameters:
value The new value.

void Xfc::Gtk::Adjustment::set_range ( double  lower,
double  upper,
double  step_increment,
double  page_increment,
double  page_size 
)

Sets the Adjustment fields other than the value.

Parameters:
lower The minimum value.
upper The maximum value.
step_increment The step increment.
page_increment The page increment.
page_size The page size.
The step increment is the increment to use to make minor changes to the value. The page increment is the increment to use to make major changes to the value.


Member Data Documentation

const ChangedSignalType Xfc::Gtk::Adjustment::changed_signal [static, protected]

Adjustment changed signal (see signal_changed()).

Calls a slot with the signature:

< void function();
<

const ValueChangedSignalType Xfc::Gtk::Adjustment::value_changed_signal [static, protected]

Adjustment value changed signal (see signal_value_changed()).

Calls a slot with the signature:

< void function();
<


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3