CppSamples::Common::MenuItem Class Reference

MenuItem is a Plugin. It represents a menu. More...

#include <MenuItem.h>

Public Member Functions
	MenuItem (const std::string description)
	~MenuItem ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Print all the sub menu under this menu and accept a user input to select submenu to continue. More...
void	AddBackMenu ()
	A default Back menu will be added as submenu of this. More...
void	AddChild (Plugin *plugin)
	The given plugin item will be added as submenu of this. More...
void	AddExitMenu ()
	A default Exit menu will be added as submenu of this. More...
Public Member Functions inherited from CppSamples::Common::Plugin
	Plugin (const std::string description)
virtual	~Plugin ()
std::string	GetDescription () const
	Gets the description of this plugin. More...
Plugin *	GetParent () const
	Gets the reference to the parent of this plugin. More...
void	SetParent (Plugin *parent)
	Sets the reference to the parent of this plugin. More...

Private Attributes
std::vector< Plugin * >	_children

Detailed Description

MenuItem is a Plugin. It represents a menu.

Definition at line 12 of file MenuItem.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Common::MenuItem::MenuItem ( const std::string  description )

inline

Definition at line 14 of file MenuItem.h.

: CppSamples::Common::Plugin(description) { }

CppSamples::Common::MenuItem::~MenuItem ( )

inline

Definition at line 15 of file MenuItem.h.

{ }

Member Function Documentation

void MenuItem::AddBackMenu

(

)

A default Back menu will be added as submenu of this.

Definition at line 36 of file MenuItem.cpp.

                           {
    // Add a default back menu
    AddChild(new BackMenu());
}

void MenuItem::AddChild

(

Plugin *

plugin

)

The given plugin item will be added as submenu of this.

Parameters

plugin

Instance of Plugin to be added.

Definition at line 41 of file MenuItem.cpp.

                                      {
    // While adding a child plugin, set the parent-child relationship.
    plugin->SetParent(this);
    // Add child plugin to the collection.
    _children.push_back(plugin);
}

void MenuItem::AddExitMenu

(

)

A default Exit menu will be added as submenu of this.

Definition at line 48 of file MenuItem.cpp.

                           {
    // Add a default exit menu
    AddChild(new ExitMenu());
}

Plugin * MenuItem::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Print all the sub menu under this menu and accept a user input to select submenu to continue.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file MenuItem.cpp.

                                          {

    // Define an instance of OptionSelector class.
    OptionSelector<Plugin*> optionSelector;
    // Heading of menu
    optionSelector.Heading = GetDescription();
    // Clear the screen before start printing
    optionSelector.ClearScreenAlways = true;
    // Print header and footer for menu
    optionSelector.ShowHeaderFooter = true;
    // Ensure to print the menu after user input
    optionSelector.RepeatInput = true;

    // Add all children to the option selector
    for (int i = 0; i < (int)_children.size(); i++)
        optionSelector.AddItem(_children[i]->GetDescription(), _children[i]);

    // Print the menu and accept user input using OptionSelector.
    Plugin* result = nullptr;
    optionSelector.SelectOption(&result);
    return result;
}

Member Data Documentation

std::vector<Plugin*> CppSamples::Common::MenuItem::_children

private

Definition at line 40 of file MenuItem.h.

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/Common/MenuItem.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Common/MenuItem.cpp