makVrf::DtVrfToolbarConfigurationReader Class Reference

This class will read a toolbar configuration from the given XML node. More...

Inheritance diagram for makVrf::DtVrfToolbarConfigurationReader:

Public Member Functions
	DtVrfToolbarConfigurationReader ()
	CTOR.
virtual	~DtVrfToolbarConfigurationReader ()
	DTOR.
virtual void	readFrom (DtEnvironment *env, DtEnvValueSP root)
const ToolbarStateMap &	toolbarStates () const
Public Member Functions inherited from makVrv::DtToolbarConfiguration
	DtToolbarConfiguration ()
	CTOR.
virtual	~DtToolbarConfiguration ()
	DTOR.
void	addToolbarPath (const DtToolbarPath &, int weight=-1)
	Adds the toolbar path (as well as its entire family).
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).
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.
void	removeToolbarPath (const DtToolbarPath &)
	Remove the menu path.
void	getRootPaths (ToolbarPathList &children) const
	Get all paths which have no parents (aka top level paths).
void	getChildren (const DtToolbarPath &path, ToolbarPathList &children) const
void	sortChildren (ToolbarPathList &children) const
	Sort the list of children.
int	getNewWeight ()
	Get new weight.
DtToolbarConfiguration &	operator= (const DtToolbarConfiguration &rhs)
const DtMenuConfiguration &	menuConfiguration () const
	Menu configuration that is specific to this toolbar configuration and can only be used with toolbars defined through this configuration.
void	merge (const DtToolbarConfiguration &rhs)
	Merges in contents of supplied configuration, adding new paths.
void	copyValuesFrom (const DtToolbarConfiguration &source)
	Uses the location, geometry, order, etc.
void	updateState (const DtToolbarPath &tb, ToolbarState &state)
	Updates the state of the given toolbar path to the new one passed by argument.
const ToolbarState *	state (const DtToolbarPath &tb) const
	Returns the UI state for the given toolbar path.
const ToolbarStateMap &	states () const
	Returns the map with the UI state of each toolbar.
void	setVisible (const DtToolbarPath &tb, bool isVisible)
	Set the myIsVisible state value for a toolbar 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	createToolbarFromRow (DtEnvironment *env, DtEnvValueSP row)
virtual void	createToolbar (DtEnvironment *env, DtEnvValueSP toolbar)
Protected Member Functions inherited from makVrv::DtToolbarConfiguration
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);.
bool	sortAbsolute (const DtToolbarPath &a, const DtToolbarPath &b) const

Additional Inherited Members
Public Types inherited from makVrv::DtToolbarConfiguration
enum	ToolbarLocation {   DockLeft = 0, DockRight = 1, DockTop = 2, DockBottom = 3,   DockNone = 4 }
typedef std::list< DtToolbarPath >	ToolbarPathList
typedef std::set< DtToolbarPath >	ToolbarPathSet
typedef std::map < DtToolbarPath, ToolbarState >	ToolbarStateMap
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.

Detailed Description

This class will read a toolbar configuration from the given XML node.

Constructor & Destructor Documentation

makVrf::DtVrfToolbarConfigurationReader::DtVrfToolbarConfigurationReader

(

)

CTOR.

virtual makVrf::DtVrfToolbarConfigurationReader::~DtVrfToolbarConfigurationReader ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtVrfToolbarConfigurationReader::readFrom ( DtEnvironment *  env, DtEnvValueSP  root  )

virtual

const ToolbarStateMap& makVrf::DtVrfToolbarConfigurationReader::toolbarStates ( ) const

inline

virtual void makVrf::DtVrfToolbarConfigurationReader::createToolbarFromRow ( DtEnvironment *  env, DtEnvValueSP  row  )

protectedvirtual

virtual void makVrf::DtVrfToolbarConfigurationReader::createToolbar ( DtEnvironment *  env, DtEnvValueSP  toolbar  )

protectedvirtual

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfGuiCore/defaultGuiConfigurationCreator.h