CL_PopupMenuItem Class Reference
[clanGUI Components]

Popup menu item. More...

#include <popupmenu_item.h>

List of all members.

Public Member Functions

Construction
 CL_PopupMenuItem ()
 CL_PopupMenuItem (int id)
 Constructs a PopupMenuItem.
 CL_PopupMenuItem (const CL_SharedPtr< CL_PopupMenuItem_Impl > &impl)
 Constructs a PopupMenuItem.
virtual ~CL_PopupMenuItem ()
Attributes
CL_StringRef get_text () const
 Get Text.
CL_StringRef get_accelerator_text () const
 Get Accelerator text.
int get_id () const
 Get Id.
bool is_null () const
 Is Null.
bool has_submenu () const
 Has submenu.
bool is_disabled () const
 Is Disabled.
bool is_separator () const
 Is Separator.
CL_PopupMenu get_submenu ()
 Get Submenu.
bool is_checkable () const
 Is Checkable.
bool is_checked () const
 Is Checked.
CL_PixelBuffer get_icon () const
 Get Icon.
Events
CL_Callback_v0func_clicked ()
 Func clicked.
Operations
void set_id (int id)
 Set id.
void set_text (const CL_StringRef &text)
 Set text.
void set_icon (const CL_PixelBuffer &image)
 Set icon.
void set_submenu (CL_PopupMenu &submenu)
 Set submenu.
void set_enabled (bool enabled)
 Set enabled.
void set_separator (bool separator)
 Set separator.
void set_accelerator_text (const CL_StringRef &str)
 Set accelerator text.
void set_checkable (bool checkable)
 Set checkable.
void set_checked (bool checked)
 Set checked.


Detailed Description

Popup menu item.


Constructor & Destructor Documentation

CL_PopupMenuItem::CL_PopupMenuItem  ) 
 

CL_PopupMenuItem::CL_PopupMenuItem int  id  ) 
 

Constructs a PopupMenuItem.

Parameters:
id = value

CL_PopupMenuItem::CL_PopupMenuItem const CL_SharedPtr< CL_PopupMenuItem_Impl > &  impl  ) 
 

Constructs a PopupMenuItem.

Parameters:
CL_PopupMenuItem_Impl = Shared Ptr

virtual CL_PopupMenuItem::~CL_PopupMenuItem  )  [virtual]
 


Member Function Documentation

CL_Callback_v0& CL_PopupMenuItem::func_clicked  ) 
 

Func clicked.

Returns:
Callback_v0

CL_StringRef CL_PopupMenuItem::get_accelerator_text  )  const
 

Get Accelerator text.

Returns:
accelerator_text

CL_PixelBuffer CL_PopupMenuItem::get_icon  )  const
 

Get Icon.

Returns:
icon

int CL_PopupMenuItem::get_id  )  const
 

Get Id.

Returns:
id

CL_PopupMenu CL_PopupMenuItem::get_submenu  ) 
 

Get Submenu.

Returns:
submenu

CL_StringRef CL_PopupMenuItem::get_text  )  const
 

Get Text.

Returns:
text

bool CL_PopupMenuItem::has_submenu  )  const
 

Has submenu.

Returns:
bool

bool CL_PopupMenuItem::is_checkable  )  const
 

Is Checkable.

Returns:
true = checkable

bool CL_PopupMenuItem::is_checked  )  const
 

Is Checked.

Returns:
true = checked

bool CL_PopupMenuItem::is_disabled  )  const
 

Is Disabled.

Returns:
true = disabled

bool CL_PopupMenuItem::is_null  )  const
 

Is Null.

Returns:
true = null

bool CL_PopupMenuItem::is_separator  )  const
 

Is Separator.

Returns:
true = separator

void CL_PopupMenuItem::set_accelerator_text const CL_StringRef str  ) 
 

Set accelerator text.

Parameters:
str = String Ref

void CL_PopupMenuItem::set_checkable bool  checkable  ) 
 

Set checkable.

Parameters:
checkable = bool

void CL_PopupMenuItem::set_checked bool  checked  ) 
 

Set checked.

Parameters:
checked = bool

void CL_PopupMenuItem::set_enabled bool  enabled  ) 
 

Set enabled.

Parameters:
enabled = bool

void CL_PopupMenuItem::set_icon const CL_PixelBuffer image  ) 
 

Set icon.

Parameters:
image = Pixel Buffer

void CL_PopupMenuItem::set_id int  id  ) 
 

Set id.

Parameters:
id = value

void CL_PopupMenuItem::set_separator bool  separator  ) 
 

Set separator.

Parameters:
separator = bool

void CL_PopupMenuItem::set_submenu CL_PopupMenu submenu  ) 
 

Set submenu.

Parameters:
submenu = Popup Menu

void CL_PopupMenuItem::set_text const CL_StringRef text  ) 
 

Set text.

Parameters:
text = String Ref


The documentation for this class was generated from the following file:
Generated on Thu Dec 3 02:39:39 2009 for ClanLib by  doxygen 1.4.6