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

#include <menu.h>

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

Public Member Functions

 CMenu (const std::string &rksTitle, size_t iMaxItems)
 
void AddItem (CMenuItem *pmiItem)
 
void DisplayAsIconbarMenu ()
 
virtual eMenuHandled Clicked (const unsigned int *kuiaEntries)
 
virtual tLocation PopulateMenu ()
 
const tCheckedMenuGetMenu ()
 
- Public Member Functions inherited from rov2::CUnassignable
 CUnassignable (const CUnassignable &)=delete
 
CUnassignableoperator= (const CUnassignable &)=delete
 
 CUnassignable ()
 

Public Attributes

void * m_pContext
 

Detailed Description

Class to handle WIMP menus

Definition at line 27 of file menu.h.

Constructor & Destructor Documentation

◆ CMenu()

rov2::CMenu::CMenu ( const std::string &  rksTitle,
size_t  iMaxItems 
)

Initialises the menu

Parameters
rksTitleThe menu title (string is copied)
iMaxItemsThe maximum number of items which are allowed in this menu

Definition at line 10 of file menu.cpp.

Member Function Documentation

◆ AddItem()

void rov2::CMenu::AddItem ( CMenuItem pmiItem)

Adds a menu item to this menu

Parameters
pmiItemthe item to add

Definition at line 46 of file menu.cpp.

◆ Clicked()

eMenuHandled rov2::CMenu::Clicked ( const unsigned int *  kuiaEntries)
virtual

Called when the menu is clicked on

Parameters
kuiaEntriesThe list of entries for this item onwards (-1 to end)
Returns
How the menu was handled

Reimplemented in tutorial4::MyMenu, and tutorial3::MyMenu.

Definition at line 40 of file menu.cpp.

◆ DisplayAsIconbarMenu()

void rov2::CMenu::DisplayAsIconbarMenu ( )

Displays this menu as an icon bar

Definition at line 88 of file menu.cpp.

◆ GetMenu()

const tCheckedMenu* rov2::CMenu::GetMenu ( )
inline

Gets the underlying menu structure

Returns
The menu structure

Definition at line 61 of file menu.h.

◆ PopulateMenu()

tLocation rov2::CMenu::PopulateMenu ( )
virtual

Populates the menu structure

Returns
The size for this menu

Definition at line 57 of file menu.cpp.

Member Data Documentation

◆ m_pContext

void* rov2::CMenu::m_pContext

The user-defineable context for this menu

Definition at line 51 of file menu.h.


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