VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
makVrf::DtSubMenuConfiguration Class Reference
Inheritance diagram for makVrf::DtSubMenuConfiguration:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSubMenuConfiguration ()
 DtSubMenuConfiguration (const makVrv::DtMenuConfiguration &c)
 DtSubMenuConfiguration (makVrv::DtDe *de)
virtual ~DtSubMenuConfiguration ()
int size () const
void convert (const std::string &str1, const std::string &str2)
virtual void addMenuPath (const makVrv::DtMenuPath &path, int weight=-1)
 Adds the menu path to the menu.
virtual void removeMenuPath (const makVrv::DtMenuPath &path)
 Removes the path from the menu.
virtual void addMenuPathAfter (const makVrv::DtMenuPath &newPath, const makVrv::DtMenuPath &relativeTo)
 Same as addMenuPath() except you can specify where you want to put the menu/item relative to something else in that menu.
virtual void addMenuPathBefore (const makVrv::DtMenuPath &newPath, const makVrv::DtMenuPath &relativeTo)
 Same as addMenuPath() except you can specify where you want to put the menu/item relative to something else in that menu.
DtSubMenuConfigurationoperator= (const makVrv::DtMenuConfiguration &rhs)
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 ()
 Reworks the relativeTo items to do a closest match and then use that based on the menu paths.

Protected Attributes

makVrv::DtDemyDe
std::vector
< makVrv::DtMenuConfiguration * > 
myMakeChangesTo
MenuPathSet myPathsRemoved
std::map< std::string, boolmyIsProtected

Constructor & Destructor Documentation


Member Function Documentation

int makVrf::DtSubMenuConfiguration::size ( ) const [inline]
void makVrf::DtSubMenuConfiguration::convert ( const std::string &  str1,
const std::string &  str2 
) [inline]
virtual void makVrf::DtSubMenuConfiguration::addMenuPath ( const makVrv::DtMenuPath path,
int  weight = -1 
) [virtual]

Adds the menu path to the menu.

The weight determines how it will be placed compared to other menus/items in the menu. It is important to note that the menu/item in the path must already be registered to the main menu. Most menus and items will already be registered if they are being used by VRF already. If you are making your own custom menu (and not the simple menus), then you will need to register it first (which does not take place in this class.

Reimplemented from makVrv::DtMenuConfiguration.

Reimplemented in makVrf::DtVrfRightClickContextHandler, and makVrf::DtVrfMainMenuConfiguration.

virtual void makVrf::DtSubMenuConfiguration::removeMenuPath ( const makVrv::DtMenuPath path) [virtual]

Removes the path from the menu.

Specifically only removes the item at the end of the path, which could be an entire menu or just a sub-menu or an item in a menu.

Reimplemented from makVrv::DtMenuConfiguration.

Reimplemented in makVrf::DtVrfRightClickContextHandler, and makVrf::DtVrfMainMenuConfiguration.

virtual void makVrf::DtSubMenuConfiguration::addMenuPathAfter ( const makVrv::DtMenuPath newPath,
const makVrv::DtMenuPath relativeTo 
) [virtual]

Same as addMenuPath() except you can specify where you want to put the menu/item relative to something else in that menu.

The paths must be entirely the same other than the final element

Reimplemented from makVrv::DtMenuConfiguration.

Reimplemented in makVrf::DtVrfRightClickContextHandler, and makVrf::DtVrfMainMenuConfiguration.

virtual void makVrf::DtSubMenuConfiguration::addMenuPathBefore ( const makVrv::DtMenuPath newPath,
const makVrv::DtMenuPath relativeTo 
) [virtual]

Same as addMenuPath() except you can specify where you want to put the menu/item relative to something else in that menu.

The paths must be entirely the same other than the final element

Reimplemented from makVrv::DtMenuConfiguration.

Reimplemented in makVrf::DtVrfRightClickContextHandler, and makVrf::DtVrfMainMenuConfiguration.

DtSubMenuConfiguration& makVrf::DtSubMenuConfiguration::operator= ( const makVrv::DtMenuConfiguration rhs) [inline]
void makVrf::DtSubMenuConfiguration::setProtected ( const std::string &  p,
bool  b 
) [inline]
bool makVrf::DtSubMenuConfiguration::isProtected ( const std::string &  p) const [inline]

Reworks the relativeTo items to do a closest match and then use that based on the menu paths.

If called, call as the last step before menu assembly


Member Data Documentation

std::map<std::string, bool> makVrf::DtSubMenuConfiguration::myIsProtected [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)