aedButton Class Reference

The button class. More...

#include <aedButton.h>

Inheritance diagram for aedButton:

[legend]Collaboration diagram for aedButton:

[legend]List of all members.

Public Member Functions
	aedButton (aedButtonType type=ROUND)
	The constructor.
virtual	~aedButton ()
virtual void	render (void)
virtual int	wm_update (Uint32 msdelta)
virtual int	wm_lbuttondown (Uint16 x, Uint16 y)
virtual int	wm_lbuttonup (Uint16 x, Uint16 y)
virtual int	wm_keydown (aedKeyEvent &event)
virtual int	wm_mouseenter ()
virtual int	wm_mouseleave ()
void	setCaption (const std::string &caption)
	Set button's caption.
void	setImage (aedImage image)
	Set button's image.
bool	getButtonState (void)
	Get button state (pressed or not).
void	setButtonState (bool s)
	Change button state (true means button is pressed).
void	setButtonType (aedButtonType type)
	Set button type.
void	setToggleMode (bool mode)
	Set toggle mode.
void	click ()
	Simulate a button down and button up event.
Protected Attributes
bool	m_ButtonDown
bool	m_ToggleMode
aedButtonType	m_ButtonType
aedImage *	m_Image
aedStaticText	m_Label

---

Detailed Description

The button class.

Implements ordinary and toggled buttons.

---

Constructor & Destructor Documentation

aedButton::aedButton

(

aedButtonType

type = ROUND

)

The constructor.

Parameters:

type

type of the button you wish to create

virtual aedButton::~aedButton

(

)

[virtual]

---

Member Function Documentation

void aedButton::click

(

)

Simulate a button down and button up event.

bool aedButton::getButtonState

(

void

)

[inline]

Get button state (pressed or not).

virtual void aedButton::render

(

void

)

[virtual]

Reimplemented from aedWidget.

void aedButton::setButtonState

(

bool

s

)

Change button state (true means button is pressed).

void aedButton::setButtonType

(

aedButtonType

type

)

[inline]

Set button type.

void aedButton::setCaption

(

const std::string &

caption

)

[virtual]

Set button's caption.

Reimplemented from aedWidget.

void aedButton::setImage

(

aedImage

image

)

Set button's image.

void aedButton::setToggleMode

(

bool

mode

)

Set toggle mode.

virtual int aedButton::wm_keydown

(

aedKeyEvent &

event

)

[virtual]

Reimplemented from aedWidget.

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

Reimplemented from aedWidget.

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

Reimplemented from aedWidget.

virtual int aedButton::wm_mouseenter

(

)

[virtual]

Reimplemented from aedWidget.

virtual int aedButton::wm_mouseleave

(

)

[virtual]

Reimplemented from aedWidget.

virtual int aedButton::wm_update

(

Uint32

msdelta

)

[virtual]

Reimplemented from aedWidget.

---

Member Data Documentation

bool aedButton::m_ButtonDown [protected]

aedButtonType aedButton::m_ButtonType [protected]

aedImage* aedButton::m_Image [protected]

aedStaticText aedButton::m_Label [protected]

bool aedButton::m_ToggleMode [protected]

---

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

• aedGUI/include/aedButton.h

---