A configuration of the toolbar layout. More...

Inheritance diagram for makVrv::DtToolbarConfiguration:

Classes
struct	OrderParameters
struct	ToolbarGeometry
struct	ToolbarState

Public Types
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
Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string, std::string >	ParameterMap

Public Member Functions
	DtToolbarConfiguration ()
	CTOR.
	~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 Types
typedef std::map < DtToolbarPath, OrderParameters >	ToolbarPathOrderMap

Protected Member Functions
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

Protected Attributes
ToolbarStateMap	myToolbarStates
ToolbarPathSet	myToolbarPaths
ToolbarPathOrderMap	myToolbarOrder
int	myCurrentWeight
DtMenuConfiguration	myMenuConfiguration
	If there are menus that are specifically created for toolbars, they go here.
Protected Attributes inherited from makVrv::DtConfiguration
std::string	myName
ParameterMap	myOptionalParameters
DtProxyWP	myAttachedInterface

Detailed Description

A configuration of the toolbar layout.

Member Typedef Documentation

typedef std::list<DtToolbarPath> makVrv::DtToolbarConfiguration::ToolbarPathList

typedef std::set<DtToolbarPath> makVrv::DtToolbarConfiguration::ToolbarPathSet

typedef std::map<DtToolbarPath,ToolbarState> makVrv::DtToolbarConfiguration::ToolbarStateMap

typedef std::map<DtToolbarPath,OrderParameters> makVrv::DtToolbarConfiguration::ToolbarPathOrderMap

protected

Member Enumeration Documentation

enum makVrv::DtToolbarConfiguration::ToolbarLocation

Enumerator:

DockLeft
DockRight
DockTop
DockBottom
DockNone

Constructor & Destructor Documentation

makVrv::DtToolbarConfiguration::DtToolbarConfiguration ( )

CTOR.

makVrv::DtToolbarConfiguration::~DtToolbarConfiguration ( )

DTOR.

Member Function Documentation

void makVrv::DtToolbarConfiguration::addToolbarPath	(	const DtToolbarPath &	,
		int	weight = `-1`
	)

Adds the toolbar path (as well as its entire family).

void makVrv::DtToolbarConfiguration::addToolbarPathAfter	(	const DtToolbarPath &	newPath,
		const DtToolbarPath &	relativeTo
	)

void makVrv::DtToolbarConfiguration::addToolbarPathBefore	(	const DtToolbarPath &	newPath,
		const DtToolbarPath &	relativeTo
	)

void makVrv::DtToolbarConfiguration::addMenuPath	(	const DtMenuPath &	,
		int	weight = `-1`
	)

Adds the menu path (as well as its entire family).

void makVrv::DtToolbarConfiguration::addMenuPathAfter	(	const DtMenuPath &	newPath,
		const DtMenuPath &	relativeTo
	)

void makVrv::DtToolbarConfiguration::addMenuPathBefore	(	const DtMenuPath &	newPath,
		const DtMenuPath &	relativeTo
	)

void makVrv::DtToolbarConfiguration::removeMenuPath ( const DtMenuPath & newPath )

void makVrv::DtToolbarConfiguration::addConfiguration ( const DtToolbarConfiguration & subConfiguration )

Merges from an external configurations into this configuration.

void makVrv::DtToolbarConfiguration::removeToolbarPath ( const DtToolbarPath & )

Remove the menu path.

void makVrv::DtToolbarConfiguration::getRootPaths ( ToolbarPathList & children ) const

Get all paths which have no parents (aka top level paths).

void makVrv::DtToolbarConfiguration::getChildren	(	const DtToolbarPath &	path,
		ToolbarPathList &	children
	)		const

void makVrv::DtToolbarConfiguration::sortChildren ( ToolbarPathList & children ) const

Sort the list of children.

int makVrv::DtToolbarConfiguration::getNewWeight ( )

Get new weight.

DtToolbarConfiguration& makVrv::DtToolbarConfiguration::operator= ( const DtToolbarConfiguration & rhs )

inline

References myCurrentWeight, myMenuConfiguration, myToolbarOrder, and myToolbarPaths.

const DtMenuConfiguration& makVrv::DtToolbarConfiguration::menuConfiguration ( ) const

inline

Menu configuration that is specific to this toolbar configuration and can only be used with toolbars defined through this configuration.

Assumes that any creators are registered with the system creator factory

void makVrv::DtToolbarConfiguration::merge ( const DtToolbarConfiguration & rhs )

Merges in contents of supplied configuration, adding new paths.

Order will get added at the end

void makVrv::DtToolbarConfiguration::copyValuesFrom ( const DtToolbarConfiguration & source )

Uses the location, geometry, order, etc.

values from the supplied configuration while keeping the existence of toolbars based on the existing configuration

void makVrv::DtToolbarConfiguration::updateState	(	const DtToolbarPath &	tb,
		ToolbarState &	state
	)

Updates the state of the given toolbar path to the new one passed by argument.

const ToolbarState* makVrv::DtToolbarConfiguration::state ( const DtToolbarPath & tb ) const

Returns the UI state for the given toolbar path.

const ToolbarStateMap& makVrv::DtToolbarConfiguration::states ( ) const

Returns the map with the UI state of each toolbar.

void makVrv::DtToolbarConfiguration::setVisible	(	const DtToolbarPath &	tb,
		bool	isVisible
	)

Set the myIsVisible state value for a toolbar path.

template<class Archive >

void makVrv::DtToolbarConfiguration::_serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineprotected

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

Serialize this class.

Reimplemented from makVrv::DtConfiguration.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.

bool makVrv::DtToolbarConfiguration::sortAbsolute	(	const DtToolbarPath &	a,
		const DtToolbarPath &	b
	)		const

protected

Member Data Documentation

ToolbarStateMap makVrv::DtToolbarConfiguration::myToolbarStates

protected

ToolbarPathSet makVrv::DtToolbarConfiguration::myToolbarPaths

protected

Referenced by operator=().

ToolbarPathOrderMap makVrv::DtToolbarConfiguration::myToolbarOrder

protected

Referenced by operator=().

int makVrv::DtToolbarConfiguration::myCurrentWeight

protected

Referenced by operator=().

DtMenuConfiguration makVrv::DtToolbarConfiguration::myMenuConfiguration

protected

If there are menus that are specifically created for toolbars, they go here.

Referenced by operator=().

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

include/vrvCore/DtToolbarConfiguration.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation