WoopsiUI::SliderHorizontal Class Reference
#include <sliderhorizontal.h>
List of all members.
Detailed Description
Gadget providing a sliding "grip" that can be moved left and right in the "gutter". Essentially a scrollbar, but more generic.
Constructor & Destructor Documentation
WoopsiUI::SliderHorizontal::SliderHorizontal |
( |
s16 |
x, |
|
|
s16 |
y, |
|
|
u16 |
width, |
|
|
u16 |
height | |
|
) |
| | |
Constructor.
- Parameters:
-
| x | The x co-ord of the slider, relative to its parent. |
| y | The y co-ord of the slider, relative to its parent. |
| width | The width of the slider. |
| height | The height of the slider. |
virtual WoopsiUI::SliderHorizontal::~SliderHorizontal |
( |
|
) |
[inline, protected, virtual] |
WoopsiUI::SliderHorizontal::SliderHorizontal |
( |
const SliderHorizontal & |
sliderHorizontal |
) |
[inline, protected] |
Copy constructor is protected to prevent usage.
Member Function Documentation
virtual bool WoopsiUI::SliderHorizontal::click |
( |
s16 |
x, |
|
|
s16 |
y | |
|
) |
| | [virtual] |
Click the slider at the specified co-ordinates.
- Parameters:
-
| x | The x co-ordinate of the click. |
| y | The y co-ordinate of the click. |
- Returns:
- True if the click was processed by the slider.
Reimplemented from WoopsiUI::Gadget.
virtual void WoopsiUI::SliderHorizontal::draw |
( |
Rect |
clipRect |
) |
[virtual] |
Draw the region of the slider that falls within the clipping rect. Use draw() instead in most circumstances.
- Parameters:
-
| clipRect | The clipping region. |
Reimplemented from WoopsiUI::Gadget.
const s16 WoopsiUI::SliderHorizontal::getMaximumValue |
( |
|
) |
const [inline] |
Get the largest value that the slider can represent.
- Returns:
- The largest value.
const s16 WoopsiUI::SliderHorizontal::getMinimumValue |
( |
|
) |
const [inline] |
Get the smallest value that the slider can represent.
- Returns:
- The smallest value.
const s16 WoopsiUI::SliderHorizontal::getPageSize |
( |
|
) |
const [inline] |
Get the value represented by the height of the grip. For sliders, this would typically be 1 (so each new grip position is worth 1). For scrollbars, this would be the height of the scrolling gadget.
- Returns:
- The page size.
const s16 WoopsiUI::SliderHorizontal::getValue |
( |
|
) |
const |
Get the current value of the slider. return The current slider value.
virtual void WoopsiUI::SliderHorizontal::handleDragEvent |
( |
const GadgetEventArgs & |
e |
) |
[virtual] |
virtual void WoopsiUI::SliderHorizontal::handleMoveEvent |
( |
const GadgetEventArgs & |
e |
) |
[virtual] |
void WoopsiUI::SliderHorizontal::jumpGrip |
( |
u8 |
direction |
) |
|
Make the grip jump left or right along the gutter.
- Parameters:
-
| direction | 0 to jump left, 1 to jump right. |
virtual bool WoopsiUI::SliderHorizontal::resize |
( |
u16 |
width, |
|
|
u16 |
height | |
|
) |
| | [virtual] |
Resize the slider to the new dimensions.
- Parameters:
-
| width | The new width. |
| height | The new height. |
- Returns:
- True if the resize was successful.
Reimplemented from WoopsiUI::Gadget.
void WoopsiUI::SliderHorizontal::resizeGrip |
( |
|
) |
[protected] |
Resize and redraw the grip.
void WoopsiUI::SliderHorizontal::setMaximumValue |
( |
const s16 |
value |
) |
[inline] |
Set the largest value that the slider can represent.
- Parameters:
-
void WoopsiUI::SliderHorizontal::setMinimumValue |
( |
const s16 |
value |
) |
[inline] |
Set the smallest value that the slider can represent.
- Parameters:
-
| value | The smallest value. |
void WoopsiUI::SliderHorizontal::setPageSize |
( |
const s16 |
pageSize |
) |
[inline] |
Set the page size represented by the grip.
- Parameters:
-
- See also:
- getPageSize().
void WoopsiUI::SliderHorizontal::setValue |
( |
const s16 |
value |
) |
|
Set the value that of the slider. This will reposition and redraw the grip.
- Parameters:
-
Member Data Documentation
Maximum value that the grip can represent
Smallest width that the grip can become
Minimum value that the grip can represent
Value of a page of data, used when clicking the gutter
The documentation for this class was generated from the following file:
- C:/Documents and Settings/Administrator/Desktop/woopsi-src-0.40/Woopsi/libwoopsi/include/sliderhorizontal.h