Reference Manual
Inti Logo
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

Inti::Gtk::Range Class Reference

A GtkRange C++ wrapper class. More...

#include <inti/gtk/range.h>

Inheritance diagram for Inti::Gtk::Range:

Inti::Gtk::Widget Inti::Gtk::Object Inti::Atk::Implementor Inti::G::Object Inti::G::TypeInterface Inti::G::TypeInstance Inti::MemoryHandler Inti::G::TypeInstance Inti::ReferencedBase Inti::ReferencedBase Inti::Gtk::Scale Inti::Gtk::Scrollbar Inti::Gtk::HScale Inti::Gtk::VScale Inti::Gtk::HScrollbar Inti::Gtk::VScrollbar List of all members.

Public Member Functions

Accessors
Methods
Property Proxies
Signal Proxies

Protected Member Functions

Constructors
Signal Handlers

Detailed Description

A GtkRange C++ wrapper class.

Range is the base class for widgets that show an adjustable range, such as Scale and Scrollbar.


Constructor & Destructor Documentation

Inti::Gtk::Range::Range GtkRange *  range,
bool  reference = false
[explicit, protected]
 

Construct a new Range from an existing GtkRange.

Parameters:
range A pointer to a GtkRange.
reference Set false if the initial reference count is floating, set true if it's not.

The range can be a newly created GtkRange or an existing GtkRange (see G::Object::Object).


Member Function Documentation

Adjustment* Inti::Gtk::Range::get_adjustment  )  const
 

Get the Adjustment which is the "model" object for Range (see set_adjustment() for details).

Returns:
The Adjustemnt.

The return value does not have a reference added, so it should not be unreferenced.

bool Inti::Gtk::Range::get_inverted  )  const
 

Gets the value set by set_inverted().

Returns:
true if the range is inverted.

UpdateType Inti::Gtk::Range::get_policy  )  const
 

Gets the update policy of range (see set_update_policy()).

Returns:
The current update policy.

virtual void Inti::Gtk::Range::on_adjust_bounds double  new_value  )  [protected, virtual]
 

Called when the bounds of the range might need adjusting when a new range value is set.

Parameters:
new_value The new range value.

void Inti::Gtk::Range::set_adjustment Adjustment adjustment  ) 
 

Sets the adjustment to be used as the "model" object for this range widget.

Parameters:
adjustment The Adjustment.

The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings and scrolling, and the page size. The page size is normally 0 for Scale and non-zero for Scrollbar, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.

void Inti::Gtk::Range::set_increments double  step,
double  page
 

Sets the step and page sizes for the range.

Parameters:
step The step size.
page The page size.

The step size is used when the user clicks the Scrollbar arrows or moves GtkScale via arrow keys. The page size is used for example when moving via Page Up or Page Down keys.

void Inti::Gtk::Range::set_inverted bool  setting  ) 
 

Sets whether the lower to higher values should be inverted.

Parameters:
setting Set true to invert the range.

Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. Inverted ranges have higher values at the top or on the left rather than on the bottom or right.

void Inti::Gtk::Range::set_range double  min,
double  max
 

Sets the allowable values in the Range, and clamps the range value to be between min and max.

Parameters:
min The minimum range value.
max The maximum range value.

If the range has a non-zero page size, it is clamped between min and max - page-size.

void Inti::Gtk::Range::set_update_policy UpdateType  policy  ) 
 

Sets the update policy for the range.

Parameters:
policy The update policy.

UPDATE_CONTINUOUS means that anytime the range slider is moved, the range value will change and the value_changed signal will be emitted. UPDATE_DELAYED means that the value will be updated after a brief timeout where no slider motion occurs, so updates are spaced by a short time rather than continuous. UPDATE_DISCONTINUOUS means that the value will only be updated when the user releases the button and ends the slider drag operation.

void Inti::Gtk::Range::set_value double  value  ) 
 

Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them.

Parameters:
value The new value of the range.

The range emits the "value_changed" signal if the value changes.


The documentation for this class was generated from the following file: Main Page - Footer


Generated on Sun Sep 14 20:08:18 2003 for Inti by doxygen 1.3.2 written by Dimitri van Heesch, © 1997-2002