Woopsi 1.0 GUI Framework for Nintendo DS Homebrew

- Main Page
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

Public Member Functions

# WoopsiUI::SliderBase Class Reference

`#include <sliderbase.h>`

Inheritance diagram for WoopsiUI::SliderBase:

List of all members.

## Public Member Functions
virtual | ~SliderBase ()
virtual const s16 | getMinimumValue () const =0
virtual const s16 | getMaximumValue () const =0
virtual const s32 | getValue () const =0
virtual const s16 | getPageSize () const =0
virtual void | setMinimumValue (const s16 value)=0
virtual void | setMaximumValue (const s16 value)=0
virtual void | setValue (const s32 value)=0
virtual void | setPageSize (const s16 pageSize)=0

## Detailed Description

Defines the interface for slider gadgets.

## Constructor & Destructor Documentation

virtual WoopsiUI::SliderBase::~SliderBase | ( |  | ) | `[inline, virtual]`

Destructor.

## Member Function Documentation

virtual const s16 WoopsiUI::SliderBase::getMaximumValue | ( |  | ) | const`[pure virtual]`

Get the largest value that the slider can represent.

Returns:
  The largest value.

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

virtual const s16 WoopsiUI::SliderBase::getMinimumValue | ( |  | ) | const`[pure virtual]`

Get the smallest value that the slider can represent.

Returns:
  The smallest value.

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

virtual const s16 WoopsiUI::SliderBase::getPageSize | ( |  | ) | const`[pure virtual]`

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.

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

virtual const s32 WoopsiUI::SliderBase::getValue | ( |  | ) | const`[pure virtual]`

Get the current value of the slider. return The current slider value.

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

virtual void WoopsiUI::SliderBase::setMaximumValue | ( | const s16 | value | ) | `[pure virtual]`

Set the largest value that the slider can represent.

Parameters:

  value | The largest value.

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

virtual void WoopsiUI::SliderBase::setMinimumValue | ( | const s16 | value | ) | `[pure virtual]`

Set the smallest value that the slider can represent.

Parameters:

  value | The smallest value.

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

virtual void WoopsiUI::SliderBase::setPageSize | ( | const s16 | pageSize | ) | `[pure virtual]`

Set the page size represented by the grip.

Parameters:

  pageSize | The page size.

See also:
  getPageSize().

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

virtual void WoopsiUI::SliderBase::setValue | ( | const s32 | value | ) | `[pure virtual]`

Set the value that of the slider. This will reposition and mark the grip for redraw.

Parameters:

  value | The new value.

Implemented in WoopsiUI::ScrollbarHorizontal, WoopsiUI::ScrollbarVertical, WoopsiUI::SliderHorizontal, and WoopsiUI::SliderVertical.

The documentation for this class was generated from the following file:

- sliderbase.h