CrystalSpace

Public API Reference
Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csMenuItem Class Reference
[Menu]

This class encapsulates a menu item. More...

#include <csmenu.h>

Inheritance diagram for csMenuItem:

csComponent List of all members.

Public Methods

 csMenuItem (csComponent *iParent, const char *iText, int iCommandCode=0, int iStyle=CSMIS_DEFAULTVALUE)
 Menu item constructor: text item with optional style.

 csMenuItem (csComponent *iParent, int iStyle=CSMIS_DEFAULTVALUE)
 Menu item constructor: construct a separator item.

 csMenuItem (csComponent *iParent, const char *iText, csMenu *iSubMenu, int iStyle=CSMIS_DEFAULTVALUE)
 Menu item constructor: construct a submenu.

virtual ~csMenuItem ()
 Destroy menu item object.

virtual void SuggestSize (int &w, int &h)
 Report the minimal size of menu item.

virtual void SetText (const char *iText)
 Set menu item text.

virtual bool HandleEvent (iEvent &Event)
 Handle input events.

virtual void Draw ()
 Draw the menu item.

virtual bool SetRect (int xmin, int ymin, int xmax, int ymax)
 Move child menus when moved.

virtual int GetStyle ()
 Get the Style bitmask for this menu item.


Protected Methods

void Init ()
 Common part of constructors.

virtual void Press ()
 Activate this menu item.


Static Protected Attributes

csPixmap * sprchecked
 Menu item 'checked' image.

csPixmap * sprsubmenu
 "Open submenu" arrow image

Detailed Description

This class encapsulates a menu item.

Definition at line 54 of file csmenu.h.

Constructor & Destructor Documentation

csMenuItem::csMenuItem (  csComponent *    iParent,
const char *    iText,
int    iCommandCode = 0,
int    iStyle = CSMIS_DEFAULTVALUE
) 
 

Menu item constructor: text item with optional style.

csMenuItem::csMenuItem (  csComponent *    iParent,
int    iStyle = CSMIS_DEFAULTVALUE
) 
 

Menu item constructor: construct a separator item.

csMenuItem::csMenuItem (  csComponent *    iParent,
const char *    iText,
csMenu *    iSubMenu,
int    iStyle = CSMIS_DEFAULTVALUE
) 
 

Menu item constructor: construct a submenu.

virtual csMenuItem::~csMenuItem (    )  [virtual]
 

Destroy menu item object.

Member Function Documentation

virtual void csMenuItem::Draw (    )  [virtual]
 

Draw the menu item.

Reimplemented from csComponent.

virtual int csMenuItem::GetStyle (    )  [inline, virtual]
 

Get the Style bitmask for this menu item.

Definition at line 98 of file csmenu.h.

virtual bool csMenuItem::HandleEvent (  iEvent &    Event )  [virtual]
 

Handle input events.

Reimplemented from csComponent.

void csMenuItem::Init (    )  [protected]
 

Common part of constructors.

virtual void csMenuItem::Press (    )  [protected, virtual]
 

Activate this menu item.

virtual bool csMenuItem::SetRect (  int    xmin,
int    ymin,
int    xmax,
int    ymax
)  [virtual]
 

Move child menus when moved.

Reimplemented from csComponent.

virtual void csMenuItem::SetText (  const char *    iText )  [virtual]
 

Set menu item text.

Reimplemented from csComponent.

virtual void csMenuItem::SuggestSize (  int &    w,
int &    h
)  [virtual]
 

Report the minimal size of menu item.

Reimplemented from csComponent.

Member Data Documentation

csPixmap* csMenuItem::sprchecked [static, protected]
 

Menu item 'checked' image.

Definition at line 102 of file csmenu.h.

csPixmap* csMenuItem::sprsubmenu [static, protected]
 

"Open submenu" arrow image

Definition at line 104 of file csmenu.h.

The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18