VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Attributes
makVrf::DtSubMenuConfiguration Class Reference
Inheritance diagram for makVrf::DtSubMenuConfiguration:
Inheritance graph
[legend]

Public Member Functions

 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 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.
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
std::vector
< makVrv::DtMenuConfiguration * > 
myMakeChangesTo
MenuPathSet myPathsRemoved
std::map< std::string, boolmyIsProtected

Constructor & Destructor Documentation

makVrf::DtSubMenuConfiguration::DtSubMenuConfiguration ( )
inline
makVrf::DtSubMenuConfiguration::DtSubMenuConfiguration ( const makVrv::DtMenuConfiguration &  c)
inline
makVrf::DtSubMenuConfiguration::DtSubMenuConfiguration ( makVrv::DtDe *  de)
virtual makVrf::DtSubMenuConfiguration::~DtSubMenuConfiguration ( )
virtual

Member Function Documentation

virtual bool makVrf::DtSubMenuConfiguration::isUnique ( const std::string &  ) const
virtual

Returns true if there is only one occurance of this path.

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 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 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 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 in makVrf::DtVrfRightClickContextHandler, and makVrf::DtVrfMainMenuConfiguration.

virtual void makVrf::DtSubMenuConfiguration::addMenuItemAfter ( const std::string &  menuItem,
const std::string &  after 
)
virtual

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.

If "after" does not exist will be added to the menu configuration in question as a top level menu item

virtual void makVrf::DtSubMenuConfiguration::removeMenuItem ( const std::string &  menuItem)
virtual

Finds the first occurance of a menu item that matches the "menuItem" in the configuration and removes it.

virtual void makVrf::DtSubMenuConfiguration::addMenuItemBefore ( const std::string &  menuItem,
const std::string &  before 
)
virtual

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.

If "before" does not exist will be added to the menu configuration in question as a top level menu item

virtual makVrv::DtMenuPath makVrf::DtSubMenuConfiguration::menuPathForItem ( const std::string &  menuItem) const
virtual

Finds a menu path that contains the menu item.

virtual std::string makVrf::DtSubMenuConfiguration::mainMenu ( ) const
virtual

Returns the main menu that represents this path. Will be the first items main menu.

DtSubMenuConfiguration& makVrf::DtSubMenuConfiguration::operator= ( const makVrv::DtMenuConfiguration &  rhs)
inline
void makVrf::DtSubMenuConfiguration::makeChangesTo ( makVrv::DtMenuConfiguration *  c)
inline
void makVrf::DtSubMenuConfiguration::clearMakeChangesTo ( )
inline
const MenuPathSet& makVrf::DtSubMenuConfiguration::pathsRemoved ( ) const
inline
const MenuPathSet& makVrf::DtSubMenuConfiguration::menuPaths ( ) const
inline
void makVrf::DtSubMenuConfiguration::setProtected ( const std::string &  p,
bool  b 
)
inline
bool makVrf::DtSubMenuConfiguration::isProtected ( const std::string &  p) const
inline
bool makVrf::DtSubMenuConfiguration::isGoingToBeRemoved ( const makVrv::DtMenuPath &  p) const
inline
virtual void makVrf::DtSubMenuConfiguration::reworkRelativeOrder ( )
virtual

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

makVrv::DtDe* makVrf::DtSubMenuConfiguration::myDe
protected
std::vector<makVrv::DtMenuConfiguration*> makVrf::DtSubMenuConfiguration::myMakeChangesTo
protected
MenuPathSet makVrf::DtSubMenuConfiguration::myPathsRemoved
protected
std::map<std::string, bool> makVrf::DtSubMenuConfiguration::myIsProtected
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)