VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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. 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.

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

Public Member Functions

 DtVrfMainMenuConfiguration (makVrv::DtDe &de)
 
virtual ~DtVrfMainMenuConfiguration ()
 
virtual void addMenuPath (const makVrv::DtMenuPath &path, const MenuSortFlags &sortFlagsIfMenu=(MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators)) override
 
virtual void removeMenuPath (const makVrv::DtMenuPath &path) override
 
virtual void addMenuPathAfter (const makVrv::DtMenuPath &newPath, const makVrv::DtMenuPath &relativeTo, const MenuSortFlags &sortFlagsIfMenu=(MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators)) override
 
virtual void addMenuPathBefore (const makVrv::DtMenuPath &newPath, const makVrv::DtMenuPath &relativeTo, const MenuSortFlags &sortFlagsIfMenu=(MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators)) override
 
- 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
 
int size () const
 
void convert (const std::string &str1, const std::string &str2)
 
virtual void addMenuItemAfter (const std::string &menuItem, const std::string &after)
 
virtual void removeMenuItem (const std::string &menuItem)
 
virtual void addMenuItemBefore (const std::string &menuItem, const std::string &before)
 
virtual makVrv::DtMenuPath menuPathForItem (const std::string &menuItem) const
 
virtual std::string mainMenu () const
 
DtSubMenuConfigurationoperator= (const makVrv::DtMenuConfiguration &rhs)
 
virtual bool fixSortChildren (makVrv::DtMenuConfiguration::MenuPathList &, bool checkOnly=false)
 
void makeChangesTo (makVrv::DtMenuConfiguration *c)
 
void clearMakeChangesTo ()
 
const MenuPathSetpathsRemoved () const
 
const MenuPathSetmenuPaths () 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 ()
 
- Public Member Functions inherited from makVrv::DtMenuConfiguration
 DtMenuConfiguration ()
 
virtual ~DtMenuConfiguration ()
 
void addMenuPath (const DtMenuPath &, const MenuSortFlags &sortFlagsIfMenu=(MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators))
 
void addMenuPathAfter (const DtMenuPath &newPath, const DtMenuPath &relativeTo, const MenuSortFlags &sortFlagsIfMenu=(MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators))
 
void addMenuPathBefore (const DtMenuPath &newPath, const DtMenuPath &relativeTo, const MenuSortFlags &sortFlagsIfMenu=(MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators))
 
void addConfiguration (const DtMenuConfiguration &subConfiguration)
 
void removeMenuPath (const DtMenuPath &)
 
void getRootPaths (MenuPathList &children) const
 
void getChildren (const DtMenuPath &path, MenuPathList &children) const
 
void sortChildren (MenuPathList &children) const
 
DtMenuConfigurationoperator= (const DtMenuConfiguration &rhs)
 
void merge (const DtMenuConfiguration &rhs)
 
bool hasMenuPath (const DtMenuPath &p) const
 
bool menuSortFlags (const DtMenuPath &p, MenuSortFlags &flags) const
 
- Public Member Functions inherited from makVrv::DtConfiguration
 DtConfiguration (const std::string &name="")
 
 DtConfiguration (const DtConfiguration &)
 
DtConfigurationoperator= (const DtConfiguration &)
 
virtual ~DtConfiguration ()
 
virtual const std::string & name () const
 
virtual void setName (const std::string &name)
 
virtual const std::string * findOptionalParameter (const std::string &name) const
 
virtual void setOptionalParameter (const std::string &name, const std::string &value)
 
virtual void setOptionalParameters (const ParameterMap &)
 
virtual void removeOptionalParameter (const std::string &name)
 
const ParameterMapoptionalParameters () const
 

Protected Attributes

makVrv::DtDemyDe
 
makVrv::DtVrvApplicationmyApp
 
- Protected Attributes inherited from makVrf::DtSubMenuConfiguration
makVrv::DtDemyDe
 
std::vector
< makVrv::DtMenuConfiguration * > 
myMakeChangesTo
 
MenuPathSet myPathsRemoved
 
std::map< std::string, boolmyIsProtected
 
- Protected Attributes inherited from makVrv::DtMenuConfiguration
MenuPathSet myMenuPaths
 
MenuPathOrderMap myMenuOrder
 
MenuPathSortFlagsMap myMenuSortFlags
 
int myCurrentWeight
 
- Protected Attributes inherited from makVrv::DtConfiguration
std::string myName
 
ParameterMap myOptionalParameters
 
DtProxyWP myAttachedInterface
 

Additional Inherited Members

- Public Types inherited from makVrv::DtMenuConfiguration
enum  MenuSortFlags {
  NoSort = 0x00000000, SortAllAlphabetically = 0x00000001, SortWithinSubmenus = 0x00000002, SortBetweenSeparators = 0x00000004,
  SortBetweenSubMenus = 0x00000010
}
 
typedef std::list< DtMenuPathMenuPathList
 
typedef std::set< DtMenuPathMenuPathSet
 
- Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string,
std::string > 
ParameterMap
 
- Protected Types inherited from makVrv::DtMenuConfiguration
typedef std::map< DtMenuPath,
OrderParameters
MenuPathOrderMap
 
typedef std::map< DtMenuPath,
MenuSortFlags
MenuPathSortFlagsMap
 
- Protected Member Functions inherited from makVrf::DtSubMenuConfiguration
bool sortAbsolute (const makVrv::DtMenuPath &a, const makVrv::DtMenuPath &b) const
 
- Protected Member Functions inherited from makVrv::DtMenuConfiguration
int getNewWeight ()
 
void addMenuPath (const DtMenuPath &, int weight)
 
bool sortAbsolute (const DtMenuPath &a, const DtMenuPath &b) const
 
- Protected Member Functions inherited from makVrv::DtConfiguration
template<class Archive >
void _serialize (Archive &ar, const unsigned int version)
 

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,
const MenuSortFlags sortFlagsIfMenu = (MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators) 
)
overridevirtual

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)
overridevirtual

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,
const MenuSortFlags sortFlagsIfMenu = (MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators) 
)
overridevirtual

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,
const MenuSortFlags sortFlagsIfMenu = (MenuSortFlags)(SortAllAlphabetically|SortWithinSubmenus|SortBetweenSeparators) 
)
overridevirtual

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 Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)