MenuBaseItem Class Reference

#include <menu.h>

Inheritance diagram for MenuBaseItem:

Public Member Functions
const std::string &	getName ()
const std::string &	getType ()
int	getWidth ()
Constructor and Virtual Destructor
	MenuBaseItem (const StringMap &tags)
virtual	~MenuBaseItem ()
Pure Virtual Public Member Functions
virtual void	select ()=0
virtual const std::string &	getTitle ()=0
virtual bool	getActive ()=0
virtual void	draw (bool fHighlight, const int y0, const int x0, const int w)=0

Protected Member Functions
void	draw_menu (bool fHighlight, const int y0, const int x0, const int w, const std::string &key=std::string())

Private Member Functions
virtual int	calc_width ()=0

Private Attributes
const std::string	m_name
	menu name
const std::string	m_type
	menu type
int	m_width
	menu width

Detailed Description

Abstract base menu class that all menu classes inherit from.

Member Function Documentation

virtual int MenuBaseItem::calc_width ( )

privatepure virtual

Private pure virtual member function to calc width of menu

Implemented in MenuLine, MenuItem, and Menu.

virtual void MenuBaseItem::draw ( bool  fHighlight, const int  y0, const int  x0, const int  w  )

pure virtual

Draw menu title in drop down box at given coordinates

Parameters

fHighlight	Highlight this item if true
y0	y origin of item
x0	x origin of item
w	width of item

Implemented in MenuLine, MenuItem, and Menu.

void MenuBaseItem::draw_menu ( bool  fHighlight, const int  y0, const int  x0, const int  w, const std::string &  key = std::string()  )

protected

Draw menu title in drop down box at given coordinates

Parameters

fHighlight	Highlight this item if true
y0	y origin of item
x0	x origin of item
w	width of item
key	Key modifier (default none)

virtual bool MenuBaseItem::getActive ( )

pure virtual

Get active state of menu

Returns

Return active state

Implemented in MenuLine, MenuItem, and Menu.

const std::string& MenuBaseItem::getName ( )

inline

Get name of the menu item

Returns

Menu item name

virtual const std::string& MenuBaseItem::getTitle ( )

pure virtual

Get title of menu

Returns

Return title

Implemented in MenuLine, MenuItem, and Menu.

const std::string& MenuBaseItem::getType ( )

inline

Get type of the menu item

Returns

Menu item type

int MenuBaseItem::getWidth ( )

inline

Get width of menu item

Returns

Menu item width

virtual void MenuBaseItem::select ( )

pure virtual

Select this menu item

Implemented in MenuLine, MenuItem, and Menu.

---

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

• menu.h
• menu.cpp