ClanSoft logo
ClanSoft logo
Entire Class Index Main Class Index Cross Index Global Index

Class CL_MenuItem

MenuItem component
Contained in: global
Derived from: CL_Component
Derived by: none
Group: GUI (Controls)

#include <ClanLib/gui.h>


public function member index:

Construction:

CL_MenuItem(const CL_ComponentOptions& options, CL_Component* parent, CL_StyleManager* style = NULL);
CL_MenuItem(CL_Component* parent, CL_StyleManager* style = NULL);
CL_MenuItem(const std::string& text, CL_Component* parent, CL_StyleManager* style = NULL);
CL_MenuItem(const std::string& text, bool checked, CL_Component* parent, CL_StyleManager* style = NULL);
virtual ~CL_MenuItem();

Attributes:

bool is_checkable() const;
bool is_separator() const;
bool is_checked() const;
bool is_highlighted() const;
bool has_submenu() const;
const std::string& get_text() const;

Operations:

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

Signals:

CL_Signal_v0& sig_clicked();
 

private function member index:

Implementation:

void init(const CL_ComponentOptions& options);
CL_MenuItem(const CL_MenuItem& copy);
 

Description:


Function Member Descriptions:

CL_MenuItem::CL_MenuItem - Menu Item Constructor
CL_MenuItem(const CL_ComponentOptions& options, CL_Component* parent, CL_StyleManager* style = NULL);


CL_MenuItem::CL_MenuItem - Menu Item Constructor
CL_MenuItem(CL_Component* parent, CL_StyleManager* style = NULL);


CL_MenuItem::CL_MenuItem - Menu Item Constructor
CL_MenuItem(const std::string& text, CL_Component* parent, CL_StyleManager* style = NULL);


CL_MenuItem::CL_MenuItem - Menu Item Constructor
CL_MenuItem(const std::string& text, bool checked, CL_Component* parent, CL_StyleManager* style = NULL);


CL_MenuItem::get_text - Returns the item label.
const std::string& get_text() const;
Returns - The item label.



CL_MenuItem::has_submenu - Has submenu
bool has_submenu() const;


CL_MenuItem::is_checkable - Is checkable
bool is_checkable() const;


CL_MenuItem::is_checked - Is checked
bool is_checked() const;


CL_MenuItem::is_highlighted - Is highlighted
bool is_highlighted() const;


CL_MenuItem::is_separator - Is separator
bool is_separator() const;


CL_MenuItem::set_text - Sets the item label.
void set_text(const std::string& text);
text - The item label.



CL_MenuItem::sig_clicked - This signal is emitted when the item is clicked on.
CL_Signal_v0& sig_clicked();


CL_MenuItem::~CL_MenuItem - Menu Item Destructor
virtual ~CL_MenuItem();



Variable Member Descriptions: