ROVLib2
RISCOSC++applicationdevelopmentlibrary
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
rov2::CMenuItem Class Reference

#include <menuitem.h>

Inheritance diagram for rov2::CMenuItem:
Inheritance graph
[legend]
Collaboration diagram for rov2::CMenuItem:
Collaboration graph
[legend]

Public Member Functions

virtual eMenuHandled Clicked (const bool bAdjust, void *pContext)
 
void AttachSubmenu (CMenu *pmMenu)
 
void AttachSubmenu (CWindow *pwWindow)
 
- Public Member Functions inherited from rov2::CUnassignable
 CUnassignable (const CUnassignable &)=delete
 
CUnassignableoperator= (const CUnassignable &)=delete
 
 CUnassignable ()
 

Public Attributes

bool m_bTicked
 
bool m_bDotted
 

Protected Member Functions

 CMenuItem ()
 
 ~CMenuItem ()
 
virtual tCoordinate PopulateMenu (tMenuItem *pmiItem)
 

Protected Attributes

CMenum_pmSubmenu
 
CWindowm_pwWindow
 

Friends

class CMenu
 

Detailed Description

Defines a class that holds a generic menu item

Definition at line 23 of file menuitem.h.

Constructor & Destructor Documentation

rov2::CMenuItem::CMenuItem ( )
protected

Creates a new menu item

Definition at line 9 of file menuitem.cpp.

rov2::CMenuItem::~CMenuItem ( )
protected

Destroys a new menu item - note that it must be removed from any menus

Definition at line 17 of file menuitem.cpp.

Member Function Documentation

void rov2::CMenuItem::AttachSubmenu ( CMenu pmMenu)

Attach a submenu to this item

Parameters
pmMenuThe menu to attach

Definition at line 52 of file menuitem.cpp.

void rov2::CMenuItem::AttachSubmenu ( CWindow pwWindow)

Attach a window as a submenu to this item

Parameters
pwWindowThe window to attach

Definition at line 46 of file menuitem.cpp.

eMenuHandled rov2::CMenuItem::Clicked ( const bool  bAdjust,
void *  pContext 
)
virtual

Called when this item is clicked on

Parameters
bAdjustTrue if ADJUST was used to select the item
pContextThe context from the menu which was clicked on
Returns
True if this selection was handled by this code (otherwise parent items are called)

Definition at line 34 of file menuitem.cpp.

tCoordinate rov2::CMenuItem::PopulateMenu ( tMenuItem pmiItem)
protectedvirtual

Called to populate the menu.

Parameters
pmiItemPointer to the WIMP menu item to fill in.
Returns
The width (in OS units) of the item

Reimplemented in rov2::CTextMenuItem.

Definition at line 22 of file menuitem.cpp.

Friends And Related Function Documentation

friend class CMenu
friend

CMenu needs access to call PopulateMenu

Definition at line 26 of file menuitem.h.

Member Data Documentation

bool rov2::CMenuItem::m_bDotted

True if a dotted line appears after this item

Definition at line 33 of file menuitem.h.

bool rov2::CMenuItem::m_bTicked

True if the item is ticked

Definition at line 30 of file menuitem.h.

CMenu* rov2::CMenuItem::m_pmSubmenu
protected

The submenu (if it's a menu)

Definition at line 66 of file menuitem.h.

CWindow* rov2::CMenuItem::m_pwWindow
protected

The submenu (if it's a window)

Definition at line 69 of file menuitem.h.


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