Subclass for additional functionality needed by VRF. More...

Inheritance diagram for makVrf::DtSubMenuConfiguration:

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. More...

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. More...

virtual void	removeMenuPath (const makVrv::DtMenuPath &path)
	Removes the path from the menu. More...

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. More...

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. More...

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. More...

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. More...

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. More...

virtual makVrv::DtMenuPath	menuPathForItem (const std::string &menuItem) const
	Finds a menu path that contains the menu item. More...

virtual std::string	mainMenu () const
	Returns the main menu that represents this path. Will be the first items main menu. More...

DtSubMenuConfiguration &	operator= (const makVrv::DtMenuConfiguration &rhs)

virtual bool	fixSortChildren (makVrv::DtMenuConfiguration::MenuPathList &, bool checkOnly=false)
	Returns true if something was fixed. More...

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. More...

Public Member Functions inherited from makVrv::DtMenuConfiguration
	DtMenuConfiguration ()
	CTOR. More...

virtual	~DtMenuConfiguration ()
	DTOR. More...

void	addMenuPath (const DtMenuPath &, int weight=-1)
	Adds the menu path (as well as its entire family). More...

void	addMenuPathAfter (const DtMenuPath &newPath, const DtMenuPath &relativeTo)
	Adds the menu path after a relative (they must share the same parent). More...

void	addMenuPathBefore (const DtMenuPath &newPath, const DtMenuPath &relativeTo)
	Adds the menu path before a relative (they must share the same parent). More...

void	addConfiguration (const DtMenuConfiguration &subConfiguration)
	Merges from an external configurations into this configuration. More...

void	removeMenuPath (const DtMenuPath &)
	Remove the menu path. More...

void	getRootPaths (MenuPathList &children) const
	Get all paths which have no parents (aka top level paths). More...

void	getChildren (const DtMenuPath &path, MenuPathList &children) const
	Get a list of children (first generation only) for a given path. More...

void	sortChildren (MenuPathList &children) const
	Sort the list of children. More...

int	getNewWeight ()
	Get new weight. More...

DtMenuConfiguration &	operator= (const DtMenuConfiguration &rhs)

void	merge (const DtMenuConfiguration &rhs)
	Merges in contents of supplied configuration, adding new paths. More...

bool	hasMenuPath (const DtMenuPath &p) const
	Returns true if has the menu path. More...

Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	CTOR. More...

	DtConfiguration (const DtConfiguration &)
	Copy CTOR. More...

DtConfiguration &	operator= (const DtConfiguration &)
	Assignment OP. More...

virtual	~DtConfiguration ()
	DTOR. More...

virtual const std::string &	name () const
	Get the configuration name. More...

virtual void	setName (const std::string &name)
	Set the configuration name. More...

virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameters. More...

virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter. More...

virtual void	setOptionalParameters (const ParameterMap &)
	Set an optional parameters. More...

virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter. More...

const ParameterMap &	optionalParameters () const
	Get the optional parameters. More...

Protected Member Functions
bool	sortAbsolute (const makVrv::DtMenuPath &a, const makVrv::DtMenuPath &b) const

Protected Member Functions inherited from makVrv::DtMenuConfiguration
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)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);. More...

Protected Attributes
makVrv::DtDe *	myDe

std::vector < makVrv::DtMenuConfiguration * >	myMakeChangesTo

MenuPathSet	myPathsRemoved

std::map< std::string, bool >	myIsProtected

Protected Attributes inherited from makVrv::DtMenuConfiguration
MenuPathSet	myMenuPaths

MenuPathOrderMap	myMenuOrder

int	myCurrentWeight

Protected Attributes inherited from makVrv::DtConfiguration
std::string	myName

ParameterMap	myOptionalParameters

DtProxyWP	myAttachedInterface

Additional Inherited Members
Public Types inherited from makVrv::DtMenuConfiguration
typedef std::list< DtMenuPath >	MenuPathList

typedef std::set< DtMenuPath >	MenuPathSet

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

Detailed Description

Subclass for additional functionality needed by VRF.

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

References makVrf::DtSubMenuPath::strip().

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

References makVrv::DtMenuConfiguration::operator=().

virtual bool makVrf::DtSubMenuConfiguration::fixSortChildren	(	makVrv::DtMenuConfiguration::MenuPathList &	,
		bool	checkOnly = `false`
	)

virtual

Returns true if something was fixed.

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

bool makVrf::DtSubMenuConfiguration::sortAbsolute	(	const makVrv::DtMenuPath &	a,
		const makVrv::DtMenuPath &	b
	)		const

protected

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfGuiCore/subMenuConfiguration.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation