aedSlider Class Reference

A very simple base class containing common code for sliders and scrollbars. More...

#include <aedSlider.h>

Inheritance diagram for aedSlider:

[legend]Collaboration diagram for aedSlider:

[legend]List of all members.

Public Member Functions
	aedSlider (aedOrientation orient=AED_VERTICAL)
	The constructor, creates a new slider.
virtual	~aedSlider ()
virtual int	wm_update (Uint32 msdelta)
virtual int	wm_lbuttonup (Uint16 x, Uint16 y)
virtual int	wm_lbuttondown (Uint16 x, Uint16 y)
virtual void	render (void)
void	setValue (Uint32 val)
	Set slider's value.
Uint32	getValue () const
	Get slider's value.
void	setRange (Uint32 minval, Uint32 maxval)
	Set slider's range.
void	getRange (Uint32 *minval, Uint32 *maxval) const
	Get slider's range.
Uint32	getBigChange () const
void	setBigChange (Uint32 bigchange)
	Set the amount of a "big change".
aedOrientation	getOrientation () const
	Return slider's orientation.
void	setOrientation (aedOrientation orient)
	Change slider's orientation.
void	incrementValue (bool bigChange=false)
	Increment slider's value.
void	decrementValue (bool bigChange=false)
	Decrement slider's value.
aedRect	getElevatorRect ()
Protected Attributes
bool	m_Dragging
Private Attributes
Uint32	m_Min
Uint32	m_Max
Uint32	m_Value
Uint32	m_BigChange
aedOrientation	m_Orientation

---

Detailed Description

A very simple base class containing common code for sliders and scrollbars.

---

Constructor & Destructor Documentation

aedSlider::aedSlider

(

aedOrientation

orient = AED_VERTICAL

)

The constructor, creates a new slider.

Parameters:

orient

the slider's orientation

virtual aedSlider::~aedSlider

(

)

[virtual]

---

Member Function Documentation

void aedSlider::decrementValue

(

bool

bigChange = false

)

Decrement slider's value.

Parameters:

bigChange

if true, make a big change

Uint32 aedSlider::getBigChange

(

)

const [inline]

aedRect aedSlider::getElevatorRect

(

)

Reimplemented in aedScrollBar.

aedOrientation aedSlider::getOrientation

(

)

const [inline]

Return slider's orientation.

void aedSlider::getRange	(	Uint32 *	minval,
		Uint32 *	maxval
	)			const [inline]

Get slider's range.

Store minimum and maximum values into variables pointed to by minval and maxval, respectively. Any of the two pointers can be NULL to indicate that the caller is not interested in that value.

Uint32 aedSlider::getValue

(

void

)

const [inline]

Get slider's value.

void aedSlider::incrementValue

(

bool

bigChange = false

)

Increment slider's value.

Parameters:

bigChange

if true, make a big change

virtual void aedSlider::render

(

void

)

[virtual]

Reimplemented from aedWidget.

Reimplemented in aedScrollBar.

void aedSlider::setBigChange

(

Uint32

bigchange

)

Set the amount of a "big change".

void aedSlider::setOrientation

(

aedOrientation

orient

)

[inline]

Change slider's orientation.

Parameters:

orient

new orientation, either AED_HORIZONTAL or AED_VERTICAL

void aedSlider::setRange	(	Uint32	minval,
		Uint32	maxval
	)

Set slider's range.

Parameters:

	minval	the minimum value of the new range
	maxval	the maximum value of the new range

void aedSlider::setValue

(

Uint32

val

)

Set slider's value.

virtual int aedSlider::wm_lbuttondown	(	Uint16	x,
		Uint16	y
	)			[virtual]

Reimplemented from aedWidget.

Reimplemented in aedScrollBar.

virtual int aedSlider::wm_lbuttonup	(	Uint16	x,
		Uint16	y
	)			[virtual]

Reimplemented from aedWidget.

Reimplemented in aedScrollBar.

virtual int aedSlider::wm_update

(

Uint32

msdelta

)

[virtual]

Reimplemented from aedWidget.

Reimplemented in aedScrollBar.

---

Member Data Documentation

Uint32 aedSlider::m_BigChange [private]

bool aedSlider::m_Dragging [protected]

Uint32 aedSlider::m_Max [private]

Uint32 aedSlider::m_Min [private]

aedOrientation aedSlider::m_Orientation [private]

Uint32 aedSlider::m_Value [private]

---

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

• aedGUI/include/aedSlider.h

---