makVrf::DtInformationPageConfiguration Class Reference

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

Inheritance diagram for makVrf::DtInformationPageConfiguration:

Public Member Functions
	DtInformationPageConfiguration ()
	CTOR.
	DtInformationPageConfiguration (const makVrv::DtPageConfiguration &)
	DtInformationPageConfiguration (const DtInformationPageConfiguration &)
	~DtInformationPageConfiguration ()
	DTOR.
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.
virtual void	getChildren (const DtInformationPagePath &path, PagePathList &children) const
Public Member Functions inherited from makVrv::DtPageConfiguration
	DtPageConfiguration ()
	CTOR.
virtual	~DtPageConfiguration ()
	DTOR.
DtPageConfiguration &	operator= (const DtPageConfiguration &rhs)
	Assignment operator.
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.
void	removePageCollection (const std::string &collectionClassName)
	Remove a page collection.
const PageCollectionState *	findPageCollectionState (const std::string &collectionClassName) const
	Find a page collection state.
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.
const DtUnicode *	findPageCollectionTitle (const std::string &collectionClassName) const
	Find a page collection title.
DtUnicode *	findPageCollectionTitle (const std::string &collectionClassName)
void	addPagePath (const DtPagePath &, int weight=-1)
	Adds the menu path (as well as its entire family).
void	addPagePathAfter (const DtPagePath &newPath, const DtPagePath &relativeTo)
	Adds the menu path after a relative (they must share the same parent).
void	addPagePathBefore (const DtPagePath &newPath, const DtPagePath &relativeTo)
	Adds the menu path before a relative (they must share the same parent).
void	addConfiguration (const DtPageConfiguration &subConfiguration)
	Merges from an external configurations into this configuration.
void	removePagePath (const DtPagePath &)
	Remove the page path.
void	getRootPaths (PagePathList &children) const
	Get all paths which have no parents (aka top level paths).
void	getChildren (const DtPagePath &path, PagePathList &children) const
	Get a list of children (first generation only) for a given path.
void	sortChildren (PagePathList &children) const
	Sort the list of children.
virtual PagePathList	filterForAbsoluteChildren (const PagePathList &children) const
	Filter a list of only the page paths with absolute positions.
virtual PagePathList	filterForRelativeChildren (const PagePathList &children) const
	Filter a list of only the page paths with relative positions.
int	getNewWeight ()
	Get new weight.
void	merge (const DtPageConfiguration &rhs)
	Merges in contents of supplied configuration, adding new paths.
void	copyValuesFrom (const DtPageConfiguration &source)
	Uses the location, geometry, order, etc.
bool	hasPagePath (const DtPagePath &p) const
	Returns true if has the menu path.
const PageCollectionStatesMap &	states () const
	Returns the map of page collection states.
const PageCollectionTitlesMap &	titles () const
	Returns the map of page collection titles.
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.

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
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.
bool	comparePagesByPageOrder (const DtPagePath &a, const DtPagePath &b) const
	Compare by page order, then compare pages with equal order alphabetically.
virtual const OrderParameters &	pageOrderFor (const DtPagePath &pagePath) const
	Get the page order parameters for a given page path.
Protected Attributes inherited from makVrv::DtPageConfiguration
PagePathSet	myPagePaths
PagePathOrderMap	myPageOrder
PageCollectionStatesMap	myCollections
PageCollectionTitlesMap	myPageCollectionTitles
int	myCurrentWeight

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:

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