VR-Forces 4.8 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::DtVrfToolbarConfigurationWriter Class Reference

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

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

Public Member Functions

 DtVrfToolbarConfigurationWriter (const makVrv::DtToolbarConfiguration &)
 CTOR. More...
 
virtual ~DtVrfToolbarConfigurationWriter ()
 DTOR. More...
 
virtual void writeTo (DtEnvironment *env, DtEnvValueSP root) const
 
- Public Member Functions inherited from makVrv::DtToolbarConfiguration
 DtToolbarConfiguration ()
 CTOR. More...
 
virtual ~DtToolbarConfiguration ()
 DTOR. More...
 
void addToolbarPath (const DtToolbarPath &, int weight=-1)
 Adds the toolbar path (as well as its entire family). More...
 
void addToolbarPathAfter (const DtToolbarPath &newPath, const DtToolbarPath &relativeTo)
 
void addToolbarPathBefore (const DtToolbarPath &newPath, const DtToolbarPath &relativeTo)
 
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)
 
void addMenuPathBefore (const DtMenuPath &newPath, const DtMenuPath &relativeTo)
 
void removeMenuPath (const DtMenuPath &newPath)
 
void addConfiguration (const DtToolbarConfiguration &subConfiguration)
 Merges from an external configurations into this configuration. More...
 
void removeToolbarPath (const DtToolbarPath &)
 Remove the menu path. More...
 
void getRootPaths (ToolbarPathList &children) const
 Get all paths which have no parents (aka top level paths). More...
 
void getChildren (const DtToolbarPath &path, ToolbarPathList &children) const
 
void sortChildren (ToolbarPathList &children) const
 Sort the list of children. More...
 
int getNewWeight ()
 Get new weight. More...
 
DtToolbarConfigurationoperator= (const DtToolbarConfiguration &rhs)
 
const DtMenuConfigurationmenuConfiguration () const
 Menu configuration that is specific to this toolbar configuration and can only be used with toolbars defined through this configuration. More...
 
void merge (const DtToolbarConfiguration &rhs)
 Merges in contents of supplied configuration, adding new paths. More...
 
void copyValuesFrom (const DtToolbarConfiguration &source)
 Uses the location, geometry, order, etc. More...
 
void updateState (const DtToolbarPath &tb, ToolbarState &state)
 Updates the state of the given toolbar path to the new one passed by argument. More...
 
const ToolbarStatestate (const DtToolbarPath &tb) const
 Returns the UI state for the given toolbar path. More...
 
const ToolbarStateMapstates () const
 Returns the map with the UI state of each toolbar. More...
 
void setVisible (const DtToolbarPath &tb, bool isVisible)
 Set the myIsVisible state value for a toolbar 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 writeToolbarPath (DtEnvironment *env, DtEnvValueSP root, const makVrv::DtToolbarPath &menuPath) const
 
- Protected Member Functions inherited from makVrv::DtToolbarConfiguration
template<class Archive >
void _serialize (Archive &ar, const unsigned int version)
 
bool sortAbsolute (const DtToolbarPath &a, const DtToolbarPath &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::DtToolbarConfiguration
enum  ToolbarLocation {
  DockLeft = 0, DockRight = 1, DockTop = 2, DockBottom = 3,
  DockNone = 4
}
 
typedef std::list< DtToolbarPathToolbarPathList
 
typedef std::set< DtToolbarPathToolbarPathSet
 
typedef std::map
< DtToolbarPath, ToolbarState
ToolbarStateMap
 
- Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string,
std::string > 
ParameterMap
 
- Protected Types inherited from makVrv::DtToolbarConfiguration
typedef std::map
< DtToolbarPath,
OrderParameters
ToolbarPathOrderMap
 
- Protected Attributes inherited from makVrv::DtToolbarConfiguration
ToolbarStateMap myToolbarStates
 
ToolbarPathSet myToolbarPaths
 
ToolbarPathOrderMap myToolbarOrder
 
int myCurrentWeight
 
DtMenuConfiguration myMenuConfiguration
 If there are menus that are specifically created for toolbars, they go here. More...
 
- Protected Attributes inherited from makVrv::DtConfiguration
std::string myName
 
ParameterMap myOptionalParameters
 
DtProxyWP myAttachedInterface
 

Detailed Description

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

Constructor & Destructor Documentation

makVrf::DtVrfToolbarConfigurationWriter::DtVrfToolbarConfigurationWriter ( const makVrv::DtToolbarConfiguration )

CTOR.

virtual makVrf::DtVrfToolbarConfigurationWriter::~DtVrfToolbarConfigurationWriter ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtVrfToolbarConfigurationWriter::writeTo ( DtEnvironment *  env,
DtEnvValueSP  root 
) const
virtual
virtual void makVrf::DtVrfToolbarConfigurationWriter::writeToolbarPath ( DtEnvironment *  env,
DtEnvValueSP  root,
const makVrv::DtToolbarPath menuPath 
) const
protectedvirtual

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)