---

CL_Button Class Reference

#include <button.h>

Inheritance diagram for CL_Button:

[legend]Collaboration diagram for CL_Button:

[legend]List of all members.

Public Methods
	CL_Button (const CL_ComponentOptions &options, CL_Component *parent, CL_StyleManager *style=NULL)
	Construction:.
	CL_Button (const CL_Rect &pos, const std::string &text, CL_Component *parent, CL_StyleManager *style=NULL)
	CL_Button (const CL_Point &pos, const std::string &text, CL_Surface *surface_up, CL_Surface *surface_down, CL_Component *parent, CL_StyleManager *style=NULL)
	CL_Button (const CL_Point &pos, const std::string &text, CL_Surface *surface_up, CL_Surface *surface_down, CL_Surface *surface_disabled, CL_Surface *surface_highlighted, CL_Component *parent, CL_StyleManager *style=NULL)
virtual	~CL_Button ()
const std::string&	get_text () const
	Attributes:.
bool	is_toggle_button () const
bool	is_down () const
CL_Surface*	get_surface_up () const
CL_Surface*	get_surface_down () const
CL_Surface*	get_surface_highlighted () const
CL_Surface*	get_surface_disabled () const
void	set_text (const std::string &text)
	Operations:.
void	set_toggle_mode (bool toggle=true)
void	set_down (bool enable=true)
void	toggle ()
void	set_surface_up (CL_Surface *surface)
void	set_surface_down (CL_Surface *surface)
void	set_surface_highlighted (CL_Surface *surface)
void	set_surface_disabled (CL_Surface *surface)
CL_Signal_v1<bool>&	sig_toggled ()
	Signals:.
CL_Signal_v0&	sig_clicked ()
	param: bool on - Is true if the button is on, or false otherwise.
CL_Signal_v0&	sig_pressed ()
CL_Signal_v0&	sig_released ()
Private Methods
	CL_Button (const CL_Button &copy)
	Implementation:.
Private Attributes
class CL_Button_Generic*	impl
	Implementation:.

---

Constructor & Destructor Documentation

CL_Button::CL_Button ( const CL_ComponentOptions & options, CL_Component * parent, CL_StyleManager * style = NULL )

Construction:.

CL_Button::CL_Button ( const CL_Rect & pos, const std::string & text, CL_Component * parent, CL_StyleManager * style = NULL )

CL_Button::CL_Button ( const CL_Point & pos, const std::string & text, CL_Surface * surface_up, CL_Surface * surface_down, CL_Component * parent, CL_StyleManager * style = NULL )

CL_Button::CL_Button ( const CL_Point & pos, const std::string & text, CL_Surface * surface_up, CL_Surface * surface_down, CL_Surface * surface_disabled, CL_Surface * surface_highlighted, CL_Component * parent, CL_StyleManager * style = NULL )

virtual CL_Button::~CL_Button ( ) [virtual]

CL_Button::CL_Button ( const CL_Button & copy ) [inline, private]

Implementation:. Definition at line 123 of file button.h.

---

Member Function Documentation

CL_Surface* CL_Button::get_surface_disabled ( ) const

CL_Surface* CL_Button::get_surface_down ( ) const

CL_Surface* CL_Button::get_surface_highlighted ( ) const

CL_Surface* CL_Button::get_surface_up ( ) const

const std::string & CL_Button::get_text ( ) const

Attributes:.

bool CL_Button::is_down ( ) const

bool CL_Button::is_toggle_button ( ) const

void CL_Button::set_down ( bool enable = true )

void CL_Button::set_surface_disabled ( CL_Surface * surface )

void CL_Button::set_surface_down ( CL_Surface * surface )

void CL_Button::set_surface_highlighted ( CL_Surface * surface )

void CL_Button::set_surface_up ( CL_Surface * surface )

void CL_Button::set_text ( const std::string & text )

Operations:.

void CL_Button::set_toggle_mode ( bool toggle = true )

CL_Signal_v0 & CL_Button::sig_clicked ( )

param: bool on - Is true if the button is on, or false otherwise.

CL_Signal_v0& CL_Button::sig_pressed ( )

CL_Signal_v0& CL_Button::sig_released ( )

CL_Signal_v1< bool > & CL_Button::sig_toggled ( )

Signals:.

void CL_Button::toggle ( )

---

Member Data Documentation

class CL_Button_Generic* CL_Button::impl [private]

Implementation:. Reimplemented from CL_Component. Reimplemented in CL_CheckBox. Definition at line 124 of file button.h.

---

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

• button.h

---