Button Class Reference
[Graphics]

Inheritance diagram for Button:

List of all members.

Public Types
enum	State {   State_Normal, State_Highlighted, State_Pressed, State_Disabled,   States_Count }
Public Member Functions
	Button ()
	Button (SpriteManager *spriteManager)
virtual	~Button ()
virtual const Resource_BitmapStrip &	GetBitmap () const
virtual const Resource_BitmapStrip &	GetBitmap (State state) const
virtual void	SetBitmap (State state, const Resource_BitmapStrip &bitmapStrip)
virtual State	GetState () const
virtual void	SetState (State state)
virtual bool	IsEnabled () const
virtual void	SetEnabled (bool enabled)
virtual StringId	GetEventId () const
virtual void	SetEventId (StringId eventId)
virtual void *	GetEventUserData () const
virtual void	SetEventUserData (void *userData)
virtual float	GetCrossFadeTime () const
virtual void	SetCrossFadeTime (float time=0.0f)
Protected Member Functions
virtual void	SetStateCrossFadeAlpha (unsigned char fromAlpha, unsigned char toAlpha)
virtual void	Render (Bitmap &bitmap)
virtual bool	OnMouseOver (int x, int y, bool button, StringId &eventId, void *&userData)
Friends
class	SpriteAction_ButtonStateCrossFade

---

Detailed Description

Author:

Mattias Gustavsson

Definition at line 24 of file Button.h.

---

Member Enumeration Documentation

enum Button::State

Enumerator:

State_Normal
State_Highlighted
State_Pressed
State_Disabled
States_Count

Definition at line 31 of file Button.h.

---

Constructor & Destructor Documentation

Button::Button

(

)

Definition at line 13 of file Button.cpp.

Button::Button

(

SpriteManager *

spriteManager

)

Definition at line 28 of file Button.cpp.

Button::~Button

(

)

[virtual]

Definition at line 44 of file Button.cpp.

---

Member Function Documentation

const Resource_BitmapStrip & Button::GetBitmap

(

)

const [virtual]

Reimplemented from Sprite.

Definition at line 51 of file Button.cpp.

const Resource_BitmapStrip & Button::GetBitmap

(

Button::State

state

)

const [virtual]

Definition at line 69 of file Button.cpp.

void Button::SetBitmap	(	Button::State	state,
		const Resource_BitmapStrip &	bitmapStrip
	)			[virtual]

Definition at line 77 of file Button.cpp.

Button::State Button::GetState

(

)

const [virtual]

Definition at line 85 of file Button.cpp.

void Button::SetState

(

Button::State

state

)

[virtual]

Definition at line 93 of file Button.cpp.

bool Button::IsEnabled

(

)

const [virtual]

Definition at line 119 of file Button.cpp.

void Button::SetEnabled

(

bool

enabled

)

[virtual]

Definition at line 127 of file Button.cpp.

StringId Button::GetEventId

(

)

const [virtual]

Definition at line 149 of file Button.cpp.

void Button::SetEventId

(

StringId

eventId

)

[virtual]

Definition at line 157 of file Button.cpp.

void * Button::GetEventUserData

(

)

const [virtual]

Definition at line 165 of file Button.cpp.

void Button::SetEventUserData

(

void *

userData

)

[virtual]

Definition at line 173 of file Button.cpp.

float Button::GetCrossFadeTime

(

)

const [virtual]

Definition at line 181 of file Button.cpp.

void Button::SetCrossFadeTime

(

float

time = 0.0f

)

[virtual]

Definition at line 189 of file Button.cpp.

void Button::SetStateCrossFadeAlpha	(	unsigned char	fromAlpha,
		unsigned char	toAlpha
	)			[protected, virtual]

Definition at line 197 of file Button.cpp.

void Button::Render

(

Bitmap &

bitmap

)

[protected, virtual]

Reimplemented from Sprite.

Definition at line 206 of file Button.cpp.

bool Button::OnMouseOver	(	int	x,
		int	y,
		bool	button,
		StringId &	eventId,
		void *&	userData
	)			[protected, virtual]

Reimplemented from Sprite.

Reimplemented in DragAndDropSprite.

Definition at line 238 of file Button.cpp.

---

Friends And Related Function Documentation

friend class SpriteAction_ButtonStateCrossFade [friend]

Definition at line 61 of file Button.h.