#include <ScrollBar.h>
Public Member Functions | |
| ScrollBar (Shell *const shell) | |
| virtual | ~ScrollBar (void) |
| Slider::Orientation | GetOrientation () const |
| float | GetCurrentPosition () const |
| float | GetMinimum () const |
| float | GetMaximum () const |
| float | GetRetension () const |
| float | GetStep () const |
| void | SetOrientation (const Slider::Orientation orientation) |
| void | SetCurrentPosition (float position) |
| void | SetMinimum (float minimum) |
| void | SetMaximum (float maximum) |
| void | SetRetension (float retension) |
| void | SetStep (float step) |
| ScrollBar & | operator++ () |
| ScrollBar & | operator++ (int) |
| ScrollBar & | operator-- () |
| ScrollBar & | operator-- (int) |
| ScrollBar & | operator+= (float step) |
| ScrollBar & | operator-= (float step) |
| ScrollBar & | operator() (float position) |
Public Attributes | |
| events::EventHandler < events::ScrollEventArgs > | OnScrollEventHandler |
The (base) class for (vertical and horizontal) scroll bars.
| fl7::faces::ScrollBar::ScrollBar | ( | Shell *const | shell | ) |
Explicit constructor.
| fl7::faces::ScrollBar::~ScrollBar | ( | void | ) | [virtual] |
Destructor.
| float fl7::faces::ScrollBar::GetCurrentPosition | ( | ) | const [inline] |
Returns the current position.
| float fl7::faces::ScrollBar::GetMaximum | ( | ) | const [inline] |
Returns the maximum value for the (current) position.
| float fl7::faces::ScrollBar::GetMinimum | ( | ) | const [inline] |
Returns the minimum value for the (current) position.
| Slider::Orientation fl7::faces::ScrollBar::GetOrientation | ( | ) | const [inline] |
Returns the orientation of this scroll bar (horizontal or vertical).
| float fl7::faces::ScrollBar::GetRetension | ( | ) | const [inline] |
Returns the retension from the current position to the imaginary next position.
| float fl7::faces::ScrollBar::GetStep | ( | ) | const [inline] |
| ScrollBar& fl7::faces::ScrollBar::operator() | ( | float | position | ) | [inline] |
Sets the current position to the given one. The new position will not fall below the minimum position and will not exceed the maximum position.
| ScrollBar& fl7::faces::ScrollBar::operator++ | ( | ) | [inline] |
Increases the current position (pre-increment operator). The new position will not exceed the maximum position.
| ScrollBar& fl7::faces::ScrollBar::operator++ | ( | int | ) | [inline] |
Increases the current position (post-increment operator). The new position will not exceed the maximum position. This post-increment operator acts like a pre-increment operator.
| ScrollBar& fl7::faces::ScrollBar::operator+= | ( | float | step | ) | [inline] |
Increases the current position by the given amount. The new position will not exceed the maximum position and will not fall below the minimum position (in case of a negative value).
| ScrollBar& fl7::faces::ScrollBar::operator-- | ( | int | ) | [inline] |
Decreases the current position (post-increment operator). The new position will not fall below the minimum position. This post-increment operator acts like a pre-increment operator.
| ScrollBar& fl7::faces::ScrollBar::operator-- | ( | ) | [inline] |
Decreases the current position (pre-increment operator). The new position will not fall below the minimum position.
| ScrollBar& fl7::faces::ScrollBar::operator-= | ( | float | step | ) | [inline] |
Decreases the current position by the given amount. The new position will not fall below the minimum position and will not exceed the maximum position (in case of a negative value).
| void fl7::faces::ScrollBar::SetCurrentPosition | ( | float | position | ) | [inline] |
Sets the current position. The new position should fall between the minimum and the maximum value. If not, the minimum or maximum value will be updated as well.
| void fl7::faces::ScrollBar::SetMaximum | ( | float | maximum | ) | [inline] |
Sets the maximum value for the (current) position. If the difference of the maximum and the new minimum value then is less than the retension value, the minimum value will be updated as well. If the current position then is greater than the maximum value minus the retension value, the position will be updated as well.
| void fl7::faces::ScrollBar::SetMinimum | ( | float | minimum | ) | [inline] |
Sets the minimum value for the (current) position. If the difference of the maximum and the new minimum value then is less than the retension value, the maximum value will be updated as well. If the current position then is less than the minimum value, the position will be updated as well.
| void fl7::faces::ScrollBar::SetOrientation | ( | const Slider::Orientation | orientation | ) | [inline] |
Sets the orientation of this scroll bar (horizontal or vertical).
| void fl7::faces::ScrollBar::SetRetension | ( | float | retension | ) | [inline] |
Sets the retension from the current position to the imaginary next position. If the retension value coming from the current position then extends the maximum value, the maximum value will be updated as well.
| void fl7::faces::ScrollBar::SetStep | ( | float | step | ) | [inline] |
Will be called after the position of this slider has changed.
1.7.1