VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions
makVrf::DtVrfMenuConfigurationReader Class Reference

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

Inheritance diagram for makVrf::DtVrfMenuConfigurationReader:
Inheritance graph
[legend]

Public Member Functions

 DtVrfMenuConfigurationReader ()
 CTOR. More...
 
virtual ~DtVrfMenuConfigurationReader ()
 DTOR. More...
 
virtual void readFrom (DtEnvironment *env, DtEnvValueSP root, const std::string &menuType="mainmenu")
 
- 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...
 
DtMenuConfigurationoperator= (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...
 
DtConfigurationoperator= (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 ParameterMapoptionalParameters () const
 Get the optional parameters. More...
 

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

Additional Inherited Members

- Public Types inherited from makVrv::DtMenuConfiguration
typedef std::list< DtMenuPathMenuPathList
 
typedef std::set< DtMenuPathMenuPathSet
 
- 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 Attributes inherited from makVrv::DtMenuConfiguration
MenuPathSet myMenuPaths
 
MenuPathOrderMap myMenuOrder
 
int myCurrentWeight
 
- Protected Attributes inherited from makVrv::DtConfiguration
std::string myName
 
ParameterMap myOptionalParameters
 
DtProxyWP myAttachedInterface
 

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:

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)