VR-Forces 5.0.1 Developer's Guide
 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::DtVrfPageConfigurationReader Class Reference

This class will write a page configuration to the given XML node.

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

Public Member Functions

 DtVrfPageConfigurationReader ()
 
virtual ~DtVrfPageConfigurationReader ()
 
virtual void readFrom (DtEnvironment *env, DtEnvValueSP root)
 
- Public Member Functions inherited from makVrf::DtInformationPageConfiguration
 DtInformationPageConfiguration ()
 
 DtInformationPageConfiguration (const makVrv::DtPageConfiguration &)
 
 DtInformationPageConfiguration (const DtInformationPageConfiguration &)
 
 ~DtInformationPageConfiguration ()
 
void addPagePath (const DtInformationPagePath &path, int weight=-1)
 
void addPagePathBefore (const DtInformationPagePath &path, const DtInformationPagePath &relativeTo)
 
void addPagePathAfter (const DtInformationPagePath &path, const DtInformationPagePath &relativeTo)
 
virtual void addPageItemToSection (const std::string &collectionName, const std::string &section, const std::string &pageItemName, int row, int col, int rowSpan=1, int colSpan=1, int width=-1, int height=-1)
 
virtual void addInformationItemToSection (const std::string &collectionName, const std::string &section, const std::string &informationItemName, int row, int col, int rowSpan=1, int colSpan=1, int width=-1, int height=-1)
 
virtual void removePageItemFromSection (const std::string &collectionName, const std::string &section, const std::string &pageItemName)
 
virtual void removeInformationItemFromSection (const std::string &collectionName, const std::string &section, const std::string &informationItemName)
 
virtual std::string pageForInformationItem (const std::string &item) const
 
virtual void getChildren (const DtInformationPagePath &path, PagePathList &children) const
 
- Public Member Functions inherited from makVrv::DtPageConfiguration
 DtPageConfiguration ()
 
virtual ~DtPageConfiguration ()
 
DtPageConfigurationoperator= (const DtPageConfiguration &rhs)
 
void addPageCollection (const std::string &collectionClassName, const DtUnicode &pageTitle, PageCollectionLocation location, bool visible, const std::string &pageClassToShow, bool closable=true, bool floatable=true, bool movable=true)
 
void removePageCollection (const std::string &collectionClassName)
 
const PageCollectionStatefindPageCollectionState (const std::string &collectionClassName) const
 
PageCollectionStatefindPageCollectionState (const std::string &collectionClassName)
 
const bool isPageVisible (const std::string &pageName) const
 
const DtUnicodefindPageCollectionTitle (const std::string &collectionClassName) const
 
DtUnicodefindPageCollectionTitle (const std::string &collectionClassName)
 
void addPagePath (const DtPagePath &, int weight=-1)
 
void addPagePathAfter (const DtPagePath &newPath, const DtPagePath &relativeTo)
 
void addPagePathBefore (const DtPagePath &newPath, const DtPagePath &relativeTo)
 
void addConfiguration (const DtPageConfiguration &subConfiguration)
 
void removePagePath (const DtPagePath &)
 
void getRootPaths (PagePathList &children) const
 
void getChildren (const DtPagePath &path, PagePathList &children) const
 
void sortChildren (PagePathList &children) const
 
virtual PagePathList filterForAbsoluteChildren (const PagePathList &children) const
 
virtual PagePathList filterForRelativeChildren (const PagePathList &children) const
 
int getNewWeight ()
 
void merge (const DtPageConfiguration &rhs)
 
void copyValuesFrom (const DtPageConfiguration &source)
 
bool hasPagePath (const DtPagePath &p) const
 
const PageCollectionStatesMapstates () const
 
const PageCollectionTitlesMaptitles () const
 
- Public Member Functions inherited from makVrv::DtConfiguration
 DtConfiguration (const std::string &name="")
 
 DtConfiguration (const DtConfiguration &)
 
DtConfigurationoperator= (const DtConfiguration &)
 
virtual ~DtConfiguration ()
 
virtual const std::string & name () const
 
virtual void setName (const std::string &name)
 
virtual const std::string * findOptionalParameter (const std::string &name) const
 
virtual void setOptionalParameter (const std::string &name, const std::string &value)
 
virtual void setOptionalParameters (const ParameterMap &)
 
virtual void removeOptionalParameter (const std::string &name)
 
const ParameterMapoptionalParameters () const
 

Protected Member Functions

virtual void createPageFromNode (DtEnvironment *env, DtEnvValueSP menu)
 
virtual void parsePageItems (DtEnvironment *env, DtEnvList *items, const DtInformationPagePath::InformationPagePathBuilder &)
 
- Protected Member Functions inherited from makVrv::DtPageConfiguration
template<class Archive >
void _serialize (Archive &ar, const unsigned int version)
 
bool comparePagesByPageOrder (const DtPagePath &a, const DtPagePath &b) const
 
virtual const OrderParameterspageOrderFor (const DtPagePath &pagePath) const
 
- Protected Member Functions inherited from makVrv::DtConfiguration
template<class Archive >
void _serialize (Archive &ar, const unsigned int version)
 

Additional Inherited Members

- Public Types inherited from makVrv::DtPageConfiguration
enum  PageCollectionLocation {
  DockLeft = 0, DockRight = 1, DockTop = 2, DockBottom = 3,
  FloatLeft = DockLeft | 4, FloatRight = DockRight | 4, FloatTop = DockTop | 4, FloatBottom = DockBottom | 4,
  Dialog, Location_End
}
 
typedef std::list< DtPagePathPagePathList
 
typedef std::set< DtPagePathPagePathSet
 
typedef std::map< std::string,
PageCollectionState
PageCollectionStatesMap
 
typedef std::map< std::string,
DtUnicode
PageCollectionTitlesMap
 
- Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string,
std::string > 
ParameterMap
 
- Protected Types inherited from makVrv::DtPageConfiguration
typedef std::map< DtPagePath,
OrderParameters
PagePathOrderMap
 
- Protected Attributes inherited from makVrv::DtPageConfiguration
PagePathSet myPagePaths
 
PagePathOrderMap myPageOrder
 
PageCollectionStatesMap myCollections
 
PageCollectionTitlesMap myPageCollectionTitles
 
int myCurrentWeight
 
- Protected Attributes inherited from makVrv::DtConfiguration
std::string myName
 
ParameterMap myOptionalParameters
 
DtProxyWP myAttachedInterface
 

Constructor & Destructor Documentation

makVrf::DtVrfPageConfigurationReader::DtVrfPageConfigurationReader ( )

CTOR.

virtual makVrf::DtVrfPageConfigurationReader::~DtVrfPageConfigurationReader ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtVrfPageConfigurationReader::readFrom ( DtEnvironment *  env,
DtEnvValueSP  root 
)
virtual
virtual void makVrf::DtVrfPageConfigurationReader::createPageFromNode ( DtEnvironment *  env,
DtEnvValueSP  menu 
)
protectedvirtual
virtual void makVrf::DtVrfPageConfigurationReader::parsePageItems ( DtEnvironment *  env,
DtEnvList *  items,
const DtInformationPagePath::InformationPagePathBuilder  
)
protectedvirtual

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)