CL_ToolBarItem Class Reference
[clanGUI Components]

Toolbar menu item. More...

#include <toolbar_item.h>

List of all members.

Implementation
class	CL_ToolBar
class	CL_ToolBar_Impl
Public Member Functions
Construction
	CL_ToolBarItem ()
	CL_ToolBarItem (int id)
	Constructs a ToolBarItem.
	CL_ToolBarItem (const CL_SharedPtr< CL_ToolBarItem_Impl > &impl)
	Constructs a ToolBarItem.
virtual	~CL_ToolBarItem ()
Attributes
CL_StringRef	get_text () const
	Get Text.
int	get_id () const
	Get Id.
bool	is_null () const
	Is Null.
bool	is_disabled () const
	Is Disabled.
bool	is_toggling () const
	Is Toggling.
bool	is_pressed () const
	Is Pressed.
Operations
void	set_id (int id)
	Set id.
void	set_text (const CL_StringRef &text)
	Set text.
void	set_icon (const CL_Sprite &image, int frame=0)
	Set icon.
void	set_toggling (bool toggling)
	Controls if buttons stay down when pressed.
void	set_pressed (bool value)
	Set pressed.

---

Detailed Description

Toolbar menu item.

---

Constructor & Destructor Documentation

CL_ToolBarItem::CL_ToolBarItem (   )

CL_ToolBarItem::CL_ToolBarItem (  int  id  )

Constructs a ToolBarItem. Parameters: id  = value

CL_ToolBarItem::CL_ToolBarItem (  const CL_SharedPtr< CL_ToolBarItem_Impl > &  impl  )

Constructs a ToolBarItem. Parameters: CL_ToolBarItem_Impl  = Shared Ptr

virtual CL_ToolBarItem::~CL_ToolBarItem (   )  [virtual]

---

Member Function Documentation

int CL_ToolBarItem::get_id (   )  const

Get Id. Returns: id

CL_StringRef CL_ToolBarItem::get_text (   )  const

Get Text. Returns: text

bool CL_ToolBarItem::is_disabled (   )  const

Is Disabled. Returns: true = disabled

bool CL_ToolBarItem::is_null (   )  const

Is Null. Returns: true = null

bool CL_ToolBarItem::is_pressed (   )  const

Is Pressed. Returns: true = pressed

bool CL_ToolBarItem::is_toggling (   )  const

Is Toggling. Returns: true = toggling

void CL_ToolBarItem::set_icon (  const CL_Sprite &  image, int  frame = 0 )

Set icon. Parameters: image  = Sprite frame  = value

void CL_ToolBarItem::set_id (  int  id  )

Set id. Parameters: id  = value

void CL_ToolBarItem::set_pressed (  bool  value  )

Set pressed. Parameters: value  = bool

void CL_ToolBarItem::set_text (  const CL_StringRef &  text  )

Set text. Parameters: text  = String Ref

void CL_ToolBarItem::set_toggling (  bool  toggling  )

Controls if buttons stay down when pressed.

---

Friends And Related Function Documentation

friend class CL_ToolBar [friend]

friend class CL_ToolBar_Impl [friend]

---

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

• toolbar_item.h

---