makVrf::DtVrfMenuConfigurationReader Class Reference

This class will reader a menu configuration from the given XML node. More...

Inheritance diagram for makVrf::DtVrfMenuConfigurationReader:

Public Member Functions
	DtVrfMenuConfigurationReader ()
	CTOR.
virtual	~DtVrfMenuConfigurationReader ()
	DTOR.
virtual void	readFrom (DtEnvironment *env, DtEnvValueSP root, const std::string &menuType="mainmenu")
Public Member Functions inherited from makVrv::DtMenuConfiguration
	DtMenuConfiguration ()
	CTOR.
	~DtMenuConfiguration ()
	DTOR.
void	addMenuPath (const DtMenuPath &, int weight=-1)
	Adds the menu path (as well as its entire family).
void	addMenuPathAfter (const DtMenuPath &newPath, const DtMenuPath &relativeTo)
	Adds the menu path before a relative (they must share the same parent).
void	addMenuPathBefore (const DtMenuPath &newPath, const DtMenuPath &relativeTo)
	Adds the menu path before a relative (they must share the same parent).
void	addConfiguration (const DtMenuConfiguration &subConfiguration)
	Merges from an external configurations into this configuration.
void	removeMenuPath (const DtMenuPath &)
	Remove the menu path.
void	getRootPaths (MenuPathList &children) const
	Get all paths which have no parents (aka top level paths).
void	getChildren (const DtMenuPath &path, MenuPathList &children) const
	Get a list of children (first generation only) for a given path.
void	sortChildren (MenuPathList &children) const
	Sort the list of children.
int	getNewWeight ()
	Get new weight.
DtMenuConfiguration &	operator= (const DtMenuConfiguration &rhs)
void	merge (const DtMenuConfiguration &rhs)
	Merges in contents of supplied configuration, adding new paths.
bool	hasMenuPath (const DtMenuPath &p) const
	Returns true if has the menu path.
Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	CTOR.
	DtConfiguration (const DtConfiguration &)
	Copy CTOR.
DtConfiguration &	operator= (const DtConfiguration &)
	Assignment OP.
virtual	~DtConfiguration ()
	DTOR.
virtual const std::string &	name () const
	Get the configuration name.
virtual void	setName (const std::string &name)
	Set the configuration name.
virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameters.
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter.
virtual void	setOptionalParameters (const ParameterMap &)
	Set an optional parameters.
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter.
const ParameterMap &	optionalParameters () const
	Get the optional parameters.

Protected Member Functions
virtual void	createMenuFromNode (DtEnvironment *env, DtEnvValueSP menu)
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);.

Additional Inherited Members
Public Types inherited from makVrv::DtMenuConfiguration
typedef std::list< DtMenuPath >	MenuPathList
typedef std::set< DtMenuPath >	MenuPathSet
Protected Types inherited from makVrv::DtMenuConfiguration
typedef std::map< DtMenuPath, OrderParameters >	MenuPathOrderMap
Protected Attributes inherited from makVrv::DtMenuConfiguration
MenuPathSet	myMenuPaths
MenuPathOrderMap	myMenuOrder
int	myCurrentWeight

Detailed Description

This class will reader a menu configuration from the given XML node.

Constructor & Destructor Documentation

makVrf::DtVrfMenuConfigurationReader::DtVrfMenuConfigurationReader

(

)

CTOR.

virtual makVrf::DtVrfMenuConfigurationReader::~DtVrfMenuConfigurationReader ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtVrfMenuConfigurationReader::readFrom ( DtEnvironment *  env, DtEnvValueSP  root, const std::string &  menuType = "mainmenu"  )

virtual

virtual void makVrf::DtVrfMenuConfigurationReader::createMenuFromNode ( DtEnvironment *  env, DtEnvValueSP  menu  )

protectedvirtual

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/defaultGuiConfigurationCreator.h