Gui::MultiStateImageButton Class Reference

#include <GuiMultiStateImageButton.h>

Inheritance diagram for Gui::MultiStateImageButton:

Collaboration diagram for Gui::MultiStateImageButton:

Public Member Functions
	MultiStateImageButton ()
virtual void	Draw ()
virtual	~MultiStateImageButton ()
virtual void	GetSizeRequested (float size[2])
void	AddState (int state, const char *icon)
void	AddState (int state, const char *icon, std::string tooltip)
void	AddState (int state, const char *inactiveIcon, const char *activeIcon, std::string tooltip)
int	GetState ()
void	StateNext ()
void	StatePrev ()
virtual void	OnActivate ()
virtual void	SetSelected (bool state)
void	SetActiveState (int state)
void	SetRenderDimensions (const float wide, const float high)
Public Member Functions inherited from Gui::Button
	Button ()
virtual	~Button ()
virtual bool	OnMouseDown (MouseButtonEvent *e)
virtual bool	OnMouseUp (MouseButtonEvent *e)
bool	IsPressed ()
Public Member Functions inherited from Gui::Widget
	Widget ()
virtual	~Widget ()
virtual void	GetMinimumSize (float size[2])
void	GetAbsolutePosition (float pos[2]) const
void	GetSize (float size[2])
void	SetSize (float w, float h)
void	ResizeRequest ()
void	SetShortcut (SDL_Keycode key, SDL_Keymod mod)
void	SetScissor (bool enabled)
bool	GetEnabled ()
void	SetEnabled (bool v)
virtual void	GrabFocus ()
bool	IsFocused ()
virtual void	ShowAll ()
virtual void	Show ()
virtual void	Hide ()
void	HideTooltip ()
bool	IsVisible () const
Container *	GetParent () const
void	SetParent (Container *p)
void	SetToolTip (std::string s)
const std::string &	GetToolTip () const
virtual bool	OnMouseMotion (MouseMotionEvent *e)
virtual void	OnMouseEnter ()
virtual void	OnMouseLeave ()
virtual bool	OnKeyDown (const SDL_Keysym *sym)
virtual void	OnTextInput (Uint32 unicode)
bool	IsMouseOver ()
void	OnPreShortcut (const SDL_Keysym *sym)
unsigned int	GetEventMask ()

Public Attributes
sigc::signal< void, MultiStateImageButton * >	onClick
Public Attributes inherited from Gui::Button
sigc::signal< void >	onPress
sigc::signal< void >	onRelease
sigc::signal< void >	onClick
Public Attributes inherited from Gui::Widget
sigc::signal< void >	onMouseEnter
sigc::signal< void >	onMouseLeave
sigc::signal< void >	onSetSize
sigc::signal< void >	onDelete
float	w
float	h
Public Attributes inherited from Gui::ISelectable
sigc::signal< void >	onSelect

Protected Member Functions
virtual std::string	GetOverrideTooltip ()
Protected Member Functions inherited from Gui::Widget
void	UpdateOverriddenTooltip ()

Additional Inherited Members
Public Types inherited from Gui::Widget
enum	EventMask {   EVENT_NONE = 0 , EVENT_KEYDOWN = 1 << 0 , EVENT_KEYUP = 1 << 1 , EVENT_MOUSEDOWN = 1 << 2 ,   EVENT_MOUSEUP = 1 << 3 , EVENT_MOUSEMOTION = 1 << 4 }
Static Public Attributes inherited from Gui::Widget
static const unsigned int	EVENT_ALL = 0xffffffff
Protected Attributes inherited from Gui::Widget
unsigned int	m_eventMask
struct {
SDL_Keycode   sym
SDL_Keymod   mod
}	m_shortcut

Constructor & Destructor Documentation

MultiStateImageButton()

Gui::MultiStateImageButton::MultiStateImageButton

(

)

Here is the call graph for this function:

~MultiStateImageButton()

Gui::MultiStateImageButton::~MultiStateImageButton ( )

virtual

Member Function Documentation

AddState() [1/3]

void Gui::MultiStateImageButton::AddState	(	int	state,
		const char *	icon
	)

AddState() [2/3]

void Gui::MultiStateImageButton::AddState	(	int	state,
		const char *	icon,
		std::string	tooltip
	)

Here is the call graph for this function:

AddState() [3/3]

void Gui::MultiStateImageButton::AddState	(	int	state,
		const char *	inactiveIcon,
		const char *	activeIcon,
		std::string	tooltip
	)

Here is the call graph for this function:

Draw()

void Gui::MultiStateImageButton::Draw ( )

virtual

Implements Gui::Widget.

Here is the call graph for this function:

GetOverrideTooltip()

std::string Gui::MultiStateImageButton::GetOverrideTooltip ( )

protectedvirtual

Reimplemented from Gui::Widget.

GetSizeRequested()

void Gui::MultiStateImageButton::GetSizeRequested ( float  size[2] )

virtual

containers call this on children. input: size[] will contain max permissible size output: size[] will contain what space the widget desires

Implements Gui::Widget.

GetState()

int Gui::MultiStateImageButton::GetState ( )

inline

OnActivate()

void Gui::MultiStateImageButton::OnActivate ( )

virtual

Reimplemented from Gui::Button.

Here is the call graph for this function:

SetActiveState()

void Gui::MultiStateImageButton::SetActiveState

(

int

state

)

SetRenderDimensions()

void Gui::MultiStateImageButton::SetRenderDimensions	(	const float	wide,
		const float	high
	)

SetSelected()

void Gui::MultiStateImageButton::SetSelected ( bool  state )

virtual

Implements Gui::ISelectable.

StateNext()

void Gui::MultiStateImageButton::StateNext

(

)

Here is the call graph for this function:

StatePrev()

void Gui::MultiStateImageButton::StatePrev

(

)

Here is the call graph for this function:

Member Data Documentation

onClick

sigc::signal<void, MultiStateImageButton *> Gui::MultiStateImageButton::onClick

---

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

• src/gui/GuiMultiStateImageButton.h
• src/gui/GuiMultiStateImageButton.cpp