class MASKING_DLL_DECLSPEC ScrollObject
Implements the basic functionality of a widget that can scroll things.
Inheritance:
ScrollObject
Public Methods
-
![[more]](icon1.gif)
virtual void SetMin(double min)
- Sets the minimum value to which the object can scroll.
-
virtual void SetMax(double max)
- Sets the maximum value to which the object can scroll.
-
virtual void SetRange(double min, double max)
- A shortcut for SetMin() and SetMax()
-
virtual void SetPosition(double pos)
- Sets the position of the scroll object.
-
virtual void SetIncrement(double inc)
- Sets the value by which the object can scroll.
-
virtual void Setup(double min, double max, double pos, double inc)
- A shortcut for all of the above functions
-
virtual void Increment()
- Increments the object's position by the increment value.
-
virtual void Decrement()
- Decrements the object's position by the increment value.
-
virtual double GetMin()
- Returns the minimum value of the scroll object
-
virtual double GetMax()
- Returns the maximum value of the scroll object
-
virtual double GetRange()
- Returns the scroll object's range (ie.
-
virtual double GetPosition()
- Returns the position of the scroll object
-
virtual double GetIncrement()
- Returns the increment value
Protected Fields
-
double min
- The minimum value the object can scroll to
-
double max
- The maximum value the object can scroll to
-
double pos
- The current position of the scroll object
-
double inc
- The increment value of the scroll object
Documentation
Implements the basic functionality of a widget that can scroll things.
That's not a widget that can be scrolled, but a widget that does the
scrolling! ScrollObject is quite generic so it works with doubles instead
of ints like most scroll widgets (sliders, scrollers, etc.) so if you
use it to scroll integer values, you'll have to do a bit of casting.
double min
-
The minimum value the object can scroll to
- double max
-
The maximum value the object can scroll to
- double pos
-
The current position of the scroll object
- double inc
-
The increment value of the scroll object
- virtual void SetMin(double min)
-
Sets the minimum value to which the object can scroll. Default is 0.
- virtual void SetMax(double max)
-
Sets the maximum value to which the object can scroll. Default is 100.
- virtual void SetRange(double min, double max)
-
A shortcut for SetMin() and SetMax()
- virtual void SetPosition(double pos)
-
Sets the position of the scroll object. The position is clipped to the
object's range. Default is 0.
- virtual void SetIncrement(double inc)
-
Sets the value by which the object can scroll. Default is 1. Must be positive!
- virtual void Setup(double min, double max, double pos, double inc)
-
A shortcut for all of the above functions
- virtual void Increment()
-
Increments the object's position by the increment value.
The new position is clipped by the maximum value.
- virtual void Decrement()
-
Decrements the object's position by the increment value.
The new position is clipped by the minimum value.
- virtual double GetMin()
-
Returns the minimum value of the scroll object
- virtual double GetMax()
-
Returns the maximum value of the scroll object
- virtual double GetRange()
-
Returns the scroll object's range (ie. max - min).
- virtual double GetPosition()
-
Returns the position of the scroll object
- virtual double GetIncrement()
-
Returns the increment value
- Direct child classes:
- SpinBox
Scroller
Progress
Alphabetic index Hierarchy of classes
Back to front page
|
page generated with DOC++