VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Attributes
makVrf::DtVrfMainMenuConfiguration Class Reference

DtVrfMainMenuConfig used in DtVrfMainMenu to add/remove menu paths from menu bar. More...

Inheritance diagram for makVrf::DtVrfMainMenuConfiguration:
Inheritance graph
[legend]

Public Member Functions

 DtVrfMainMenuConfiguration (makVrv::DtDe &de)
 Constructor for this class should not be used unless overriding class.
virtual ~DtVrfMainMenuConfiguration ()
 Destructor for this class which also should not be directly accessed.
virtual void addMenuPath (const makVrv::DtMenuPath &path, int weight=-1)
 Add a menu path to the menu bar.
virtual void removeMenuPath (const makVrv::DtMenuPath &path)
 Remove a menu path from the menu bar.
virtual void addMenuPathAfter (const makVrv::DtMenuPath &newPath, const makVrv::DtMenuPath &relativeTo)
 Add a menu path to the menu bar after a specific item in the same menu path.
virtual void addMenuPathBefore (const makVrv::DtMenuPath &newPath, const makVrv::DtMenuPath &relativeTo)
 Add a menu path to the menu bar after a specific item in the same menu path.
- Public Member Functions inherited from makVrf::DtSubMenuConfiguration
 DtSubMenuConfiguration ()
 DtSubMenuConfiguration (const makVrv::DtMenuConfiguration &c)
 DtSubMenuConfiguration (makVrv::DtDe *de)
virtual ~DtSubMenuConfiguration ()
virtual bool isUnique (const std::string &) const
 Returns true if there is only one occurance of this path.
int size () const
void convert (const std::string &str1, const std::string &str2)
virtual void addMenuItemAfter (const std::string &menuItem, const std::string &after)
 Finds the first occurance of a menu item that matches the "after" in the configuration and adds the menu item to add after that item.
virtual void removeMenuItem (const std::string &menuItem)
 Finds the first occurance of a menu item that matches the "menuItem" in the configuration and removes it.
virtual void addMenuItemBefore (const std::string &menuItem, const std::string &before)
 Finds the first occurance of a menu item that matches the "after" in the configuration and adds the menu item to add before that item.
virtual makVrv::DtMenuPath menuPathForItem (const std::string &menuItem) const
 Finds a menu path that contains the menu item.
virtual std::string mainMenu () const
 Returns the main menu that represents this path. Will be the first items main menu.
DtSubMenuConfigurationoperator= (const makVrv::DtMenuConfiguration &rhs)
void makeChangesTo (makVrv::DtMenuConfiguration *c)
void clearMakeChangesTo ()
const MenuPathSet & pathsRemoved () const
const MenuPathSet & menuPaths () const
void setProtected (const std::string &p, bool b)
bool isProtected (const std::string &p) const
bool isGoingToBeRemoved (const makVrv::DtMenuPath &p) const
virtual void reworkRelativeOrder ()
 Reworks the relativeTo items to do a closest match and then use that based on the menu paths.

Protected Attributes

makVrv::DtDe & myDe
makVrv::DtVrvApplication * myApp
- Protected Attributes inherited from makVrf::DtSubMenuConfiguration
makVrv::DtDe * myDe
std::vector
< makVrv::DtMenuConfiguration * > 
myMakeChangesTo
MenuPathSet myPathsRemoved
std::map< std::string, boolmyIsProtected

Detailed Description

DtVrfMainMenuConfig used in DtVrfMainMenu to add/remove menu paths from menu bar.

the menu configuration is what determines where menu items go in all of the menus. Paths are specified to existing menu items that have already been registered to the menu assembler, which in this case is the DtVrfMainMenuAssembler class, but alternatively accessed through DtVrfMainMenu::registerMenu() (inherited from DtConfigurableMenu::registerMenu() ) and similar functions.

Constructor & Destructor Documentation

makVrf::DtVrfMainMenuConfiguration::DtVrfMainMenuConfiguration ( makVrv::DtDe &  de)

Constructor for this class should not be used unless overriding class.

Use the the DtVrfMainMenu class instead to access this object

virtual makVrf::DtVrfMainMenuConfiguration::~DtVrfMainMenuConfiguration ( )
virtual

Destructor for this class which also should not be directly accessed.

Destroy the main DtVrfMainMenu instead to destroy this object.

Member Function Documentation

virtual void makVrf::DtVrfMainMenuConfiguration::addMenuPath ( const makVrv::DtMenuPath &  path,
int  weight = -1 
)
virtual

Add a menu path to the menu bar.

The weight argument determines how it will order the menu items in the menu or the order of the menus in a list of menus. This function assumes the menu/item at the end of the path is already registered to this class.

Reimplemented from makVrf::DtSubMenuConfiguration.

virtual void makVrf::DtVrfMainMenuConfiguration::removeMenuPath ( const makVrv::DtMenuPath &  path)
virtual

Remove a menu path from the menu bar.

This function assumes the menu/item at the end of the path is already registered to this class.

Reimplemented from makVrf::DtSubMenuConfiguration.

virtual void makVrf::DtVrfMainMenuConfiguration::addMenuPathAfter ( const makVrv::DtMenuPath &  newPath,
const makVrv::DtMenuPath &  relativeTo 
)
virtual

Add a menu path to the menu bar after a specific item in the same menu path.

This function assumes the menu/item at the end of the path is already registered to this class.

Reimplemented from makVrf::DtSubMenuConfiguration.

virtual void makVrf::DtVrfMainMenuConfiguration::addMenuPathBefore ( const makVrv::DtMenuPath &  newPath,
const makVrv::DtMenuPath &  relativeTo 
)
virtual

Add a menu path to the menu bar after a specific item in the same menu path.

This function assumes the menu/item at the end of the path is already registered to this class.

Reimplemented from makVrf::DtSubMenuConfiguration.

Member Data Documentation

makVrv::DtDe& makVrf::DtVrfMainMenuConfiguration::myDe
protected
makVrv::DtVrvApplication* makVrf::DtVrfMainMenuConfiguration::myApp
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)