WXP::Menu Class Reference

This class creates a menu system. More...

#include "../include/Menu.h"

List of all members.

Public Member Functions
	Menu ()
	Menu (const char *title, MenuItem *menu, int flag)
int	init ()
int	set (const char *title, MenuItem *menu, int flag)
int	display ()
int	prompt (const char *prompt, String &str)
int	search (const char *item)
const char *	getAbbr (int index)
int	check (int index)
Static Public Attributes
static const int	EXIT = 1
static const int	MAIN = 2
static const int	HELP = 4

---

Detailed Description

This class creates a menu system.

Author:

Dan Vietor

---

Constructor & Destructor Documentation

Menu::Menu

(

)

Constructor. Initializes class values

References init().

Menu::Menu	(	const char *	rtitle,
		MenuItem *	ritems,
		int	flag
	)

Constructor. Sets up menu

Parameters:

	rtitle	Title string to display at top of menu list
	ritems	Actual list of menu items
	flag	Flag Menu::MAIN = add menu link to main menu Manu::EXIT = add menu item to exit program

References init().

---

Member Function Documentation

int Menu::check

(

int

rindex

)

Checks against menu list to see if item exists

Parameters:

rindex

Index to check

Returns:

1=exists, 0=not exist

int Menu::display

(

)

Displays the menu to standard output

Referenced by prompt().

const char * Menu::getAbbr

(

int

rindex

)

Gets the menu item abbreviation

Parameters:

rindex

Index in menu structure

Returns:

Abbreviation string

References WXP::MenuItem::abbr.

int Menu::init

(

)

Initializes the class values

Referenced by Menu().

int Menu::prompt	(	const char *	prompt,
		String &	str
	)

Prompts the user for input after menu has been displayed

Parameters:

prompt

Prompt to send to user

Return values:

str

Output String that user typed in

References display(), WXP::String::equal(), WXP::String::iequal(), WXP::Const::MISS, WXP::String::scanf(), and WXP::String::set().

int Menu::search

(

const char *

item

)

Searches the menu for matching items

Parameters:

item

Item to search for

References WXP::StrLib::iequal(), WXP::Const::MISS, and WXP::MenuItem::name.

int Menu::set	(	const char *	rtitle,
		MenuItem *	ritems,
		int	flag
	)

Sets up the menu list

Parameters:

	rtitle	Title string to display at top of menu list
	ritems	Actual list of menu items
	flag	Flag

References WXP::StrLib::copy(), and WXP::MenuItem::name.

---

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

• Menu.h
• Menu.cc