A configuration of the pages in the gui. More...

Inheritance diagram for makVrf::DtInformationPageConfiguration:

Public Member Functions
	DtInformationPageConfiguration ()
	CTOR. More...

	DtInformationPageConfiguration (const makVrv::DtPageConfiguration &)

	DtInformationPageConfiguration (const DtInformationPageConfiguration &)

	~DtInformationPageConfiguration ()
	DTOR. More...

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
	Given an information dialog item, find a page that has that item. More...

virtual void	getChildren (const DtInformationPagePath &path, PagePathList &children) const

Public Member Functions inherited from makVrv::DtPageConfiguration
	DtPageConfiguration ()
	CTOR. More...

virtual	~DtPageConfiguration ()
	DTOR. More...

DtPageConfiguration &	operator= (const DtPageConfiguration &rhs)
	Assignment operator. More...

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)
	Add a new page collection to the configuration. More...

void	removePageCollection (const std::string &collectionClassName)
	Remove a page collection. More...

const PageCollectionState *	findPageCollectionState (const std::string &collectionClassName) const
	Find a page collection state. More...

PageCollectionState *	findPageCollectionState (const std::string &collectionClassName)

const bool	isPageVisible (const std::string &pageName) const
	Check whether a page (specified by name) is visible in this configuration. More...

const DtUnicode *	findPageCollectionTitle (const std::string &collectionClassName) const
	Find a page collection title. More...

DtUnicode *	findPageCollectionTitle (const std::string &collectionClassName)

void	addPagePath (const DtPagePath &, int weight=-1)
	Adds the menu path (as well as its entire family). More...

void	addPagePathAfter (const DtPagePath &newPath, const DtPagePath &relativeTo)
	Adds the menu path after a relative (they must share the same parent). More...

void	addPagePathBefore (const DtPagePath &newPath, const DtPagePath &relativeTo)
	Adds the menu path before a relative (they must share the same parent). More...

void	addConfiguration (const DtPageConfiguration &subConfiguration)
	Merges from an external configurations into this configuration. More...

void	removePagePath (const DtPagePath &)
	Remove the page path. More...

void	getRootPaths (PagePathList &children) const
	Get all paths which have no parents (aka top level paths). More...

void	getChildren (const DtPagePath &path, PagePathList &children) const
	Get a list of children (first generation only) for a given path. More...

void	sortChildren (PagePathList &children) const
	Sort the list of children. More...

virtual PagePathList	filterForAbsoluteChildren (const PagePathList &children) const
	Filter a list of only the page paths with absolute positions. More...

virtual PagePathList	filterForRelativeChildren (const PagePathList &children) const
	Filter a list of only the page paths with relative positions. More...

int	getNewWeight ()
	Get new weight. More...

void	merge (const DtPageConfiguration &rhs)
	Merges in contents of supplied configuration, adding new paths. More...

void	copyValuesFrom (const DtPageConfiguration &source)
	Uses the location, geometry, order, etc. More...

bool	hasPagePath (const DtPagePath &p) const
	Returns true if has the menu path. More...

const PageCollectionStatesMap &	states () const
	Returns the map of page collection states. More...

const PageCollectionTitlesMap &	titles () const
	Returns the map of page collection titles. More...

Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	CTOR. More...

	DtConfiguration (const DtConfiguration &)
	Copy CTOR. More...

DtConfiguration &	operator= (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 ParameterMap &	optionalParameters () const
	Get the optional parameters. More...

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< DtPagePath >	PagePathList

typedef std::set< DtPagePath >	PagePathSet

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 Member Functions inherited from makVrv::DtPageConfiguration
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. More...

bool	comparePagesByPageOrder (const DtPagePath &a, const DtPagePath &b) const
	Compare by page order, then compare pages with equal order alphabetically. More...

virtual const OrderParameters &	pageOrderFor (const DtPagePath &pagePath) const
	Get the page order parameters for a given page path. More...

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

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

Detailed Description

A configuration of the pages in the gui.

Constructor & Destructor Documentation

makVrf::DtInformationPageConfiguration::DtInformationPageConfiguration ( )

CTOR.

makVrf::DtInformationPageConfiguration::DtInformationPageConfiguration ( const makVrv::DtPageConfiguration & )

makVrf::DtInformationPageConfiguration::DtInformationPageConfiguration ( const DtInformationPageConfiguration & )

makVrf::DtInformationPageConfiguration::~DtInformationPageConfiguration ( )

DTOR.

Member Function Documentation

void makVrf::DtInformationPageConfiguration::addPagePath	(	const DtInformationPagePath &	path,
		int	weight = `-1`
	)

void makVrf::DtInformationPageConfiguration::addPagePathBefore	(	const DtInformationPagePath &	path,
		const DtInformationPagePath &	relativeTo
	)

void makVrf::DtInformationPageConfiguration::addPagePathAfter	(	const DtInformationPagePath &	path,
		const DtInformationPagePath &	relativeTo
	)

virtual void makVrf::DtInformationPageConfiguration::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

virtual void makVrf::DtInformationPageConfiguration::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

virtual void makVrf::DtInformationPageConfiguration::removePageItemFromSection	(	const std::string &	collectionName,
		const std::string &	section,
		const std::string &	pageItemName
	)

virtual

virtual void makVrf::DtInformationPageConfiguration::removeInformationItemFromSection	(	const std::string &	collectionName,
		const std::string &	section,
		const std::string &	informationItemName
	)

virtual

virtual std::string makVrf::DtInformationPageConfiguration::pageForInformationItem ( const std::string & item ) const

virtual

Given an information dialog item, find a page that has that item.

virtual void makVrf::DtInformationPageConfiguration::getChildren	(	const DtInformationPagePath &	path,
		PagePathList &	children
	)		const

virtual

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfGuiCore/informationPageConfiguration.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation