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

Inheritance diagram for makVrf::DtVrfMainMenuConfiguration:

Public Member Functions
	DtVrfMainMenuConfiguration (makVrv::DtDe &de)
	Constructor for this class should not be used unless overriding class. More...

virtual	~DtVrfMainMenuConfiguration ()
	Destructor for this class which also should not be directly accessed. More...

virtual void	addMenuPath (const makVrv::DtMenuPath &path, int weight=-1)
	Add a menu path to the menu bar. More...

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

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

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

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

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

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

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfGuiCoreQt/vrfMainMenu.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation