ui::Scroller Class Reference

Inheritance diagram for ui::Scroller:

Inheritance graph
[legend]
Collaboration diagram for ui::Scroller:

Collaboration graph
[legend]
List of all members.

Detailed Description

Scroller is the "thumb 'n sliding' part of a Scrollbar. In code, it is very similar to Slider.


Public Types

enum  ORIENTATION { VERTICAL, HORIZONTAL }

Public Member Functions

 Scroller (int orientation)
 Scroller (float min, float max)
 Scroller (float min, float max, float value)
 Scroller (float min, float max, float value, int orientation)
float getMaximum () const
void setMaximum (float m)
float getMinimum () const
void setMinimum (float m)
void setValue (float v)
float getValue () const
void setOrientation (int o)
int getOrientation () const
bool isAdjusting () const
void setAdjusting (bool adjusting)
void addChangeListener (event::ChangeListener *l)
void removeChangeListener (event::ChangeListener *l)
void setThumbSize (int percentage)
int getThumbSize () const


Member Enumeration Documentation

enum ui::Scroller::ORIENTATION
 

Component orientation.

Enumeration values:
VERTICAL  Defines a vertically laid out Range Component.
HORIZONTAL  Defines a horizontally laid out Range Component.


Member Function Documentation

float ui::Scroller::getMaximum  )  const
 

Returns the maximum value in this range.

void ui::Scroller::setMaximum float  m  ) 
 

Sets the maximum value in this range.

float ui::Scroller::getMinimum  )  const
 

Returns the minimum value in this range.

void ui::Scroller::setMinimum float  m  ) 
 

Sets the minimum value in this range.

void ui::Scroller::setValue float  v  ) 
 

Sets the current value for this Range. Note that the value is bounds checked with the range minimum and maximum values.

float ui::Scroller::getValue  )  const
 

Returns the current value for this Range.

void ui::Scroller::setOrientation int  o  ) 
 

Sets the orientation of this Range. Can either be HORIZONTAL or VERTICAL.

int ui::Scroller::getOrientation  )  const
 

Returns the orientation of this Range.


Generated on Mon Jun 20 19:41:53 2005 for UI by doxygen 1.3.1 using KingsTools