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


Public Member Functions | Static Protected Attributes
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.

Public Member Functions

Static Protected Attributes

Constructors


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:
adjustmentA pointer to a GtkAdjustment.
owns_referenceSet 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:
lowerThe minimum value.
upperThe maximum value.
step_incrementThe step increment.
page_incrementThe page increment.
page_sizeThe 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:
valueThe initial value.
lowerThe minimum value.
upperThe maximum value.
step_incrementThe step increment.
page_incrementThe page increment.
page_sizeThe 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

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::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:
lowerThe lower value.
upperThe 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_range ( double  lower,
double  upper,
double  step_increment,
double  page_increment,
double  page_size 
)

Sets the Adjustment fields other than the value.

Parameters:
lowerThe minimum value.
upperThe maximum value.
step_incrementThe step increment.
page_incrementThe page increment.
page_sizeThe 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.

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

Sets the Adjustment value.

Parameters:
valueThe new value.

Connect to the changed_signal; emitted when one or more of the Adjustment fields have been changed, other than the value field.

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.


Member Data Documentation

Adjustment changed signal (see signal_changed()).

Calls a slot with the signature:

< void function();
<

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