The base assembler is a singleton which assembles the pages defined in a Page Configuration. More...

Inheritance diagram for makVrv::DtPageAssembler:

Public Member Functions
virtual	~DtPageAssembler ()
	DTOR.
virtual void	assemble (const DtPageConfiguration &configuration)
	Assemble a entire configuration.
virtual void	assemble (const DtPagePath &pagePath, const DtPageConfiguration &configuration)
	Assemble a particular page path and all children located in a configuration.
virtual void	assemblePagePaths (DtPageConfiguration::PagePathList &children, const DtPageConfiguration &configuration)
	Assemble all listed page paths using the configuration.
virtual void	placeCollectionPages (const DtPageConfiguration &configuration)
	Update a pages with the information contained in the page configuration.
virtual void	assembleCollection (const DtPagePath &pagePath, const DtUnicode &pageTitle, const DtPageConfiguration::PageCollectionState &pageState)
	Assemble a page item from the path.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtPageAssembler &	instance (DtDe &)
	Get an instance of the assembler.

Protected Types
typedef std::vector< DtPagePath >	PagePathVector
	Vector of page paths.
typedef std::map < DtPageConfiguration::PageCollectionLocation, PagePathVector >	LocationToPathsMap
	Map from page collection location to a vector of page paths at that location.
typedef std::map< int, DtPagePath >	PagePathsMap
typedef std::map< int, std::map< int, DtPagePath > >	SortedTabbedPages

Protected Member Functions
	DtPageAssembler (DtDe &de)
virtual LocationToPathsMap	buildLocationToPathsMap (DtPageConfiguration::PagePathList &children, const DtPageConfiguration &configuration)
	Build a map of page location to page paths at that location.
virtual void	assemblePagePath (const DtPagePath &pagePath, const DtPageConfiguration &configuration)
	Assemble a page path.
virtual void	assemblePage (const DtPagePath &pagePath)
	Assemble a page from the path.
virtual void	updatePage (const DtPagePath &pagePath, const DtPageConfiguration &configuration)
	Update the page with the state information contained inside the provided configuration.
virtual void	updatePage (const DtPagePath &pagePath, const DtPageConfiguration::PageCollectionState &state)
	Update the page with the state information provided by argument.
virtual void	assembleAllPagesInLocation (const LocationToPathsMap &locMap, DtPageConfiguration::PageCollectionLocation loc, const DtPageConfiguration &configuration)
	Assembles all the pages in the specified location.
virtual void	tabifyPagesInLocation (const LocationToPathsMap &locMap, DtPageConfiguration::PageCollectionLocation loc, const DtPageConfiguration &configuration)
	Tabifies all the pages whose configuration is set to be tabbed.
virtual SortedTabbedPages	sortTabbedPagesByLocationAndTabIndex (const PagePathVector &paths, const DtPageConfiguration &configuration, DtPageConfiguration::PageCollectionLocation location)
	Find tabbed pages in the paths list and sort them by location first and tab index second.
virtual int	positionOfPage (DtPageConfiguration::PageCollectionLocation location, const DtPageConfiguration::PageCollectionGeometry &geometry) const
	Get the left or topmost edge of a docked page, depending on whether it's docked horizontally or vertically.
virtual void	populatePagePathsMap (const LocationToPathsMap &locMap, DtPageConfiguration::PageCollectionLocation loc, const DtPageConfiguration &configuration, PagePathsMap &ppMap)
	Populates the ppMap map with the proper order in which pages need to be placed on the UI.
virtual void	tabify (const DtPagePath &pagePath1, const DtPagePath &pagePath2)
	Tabifies the pages represented by the page paths provided in the arguments.
virtual void	setSelectedPage (const DtPagePath &pPath)
	If the page is tabbed, sets it as the currently selected page.

Protected Attributes
DtDe &	myDe

Friends
class	DtPageAssemblerCreator

Detailed Description

The base assembler is a singleton which assembles the pages defined in a Page Configuration.

A GUI specific subclass is written to actually create the pages in the GUI. Example: makVrv::DtQtPageAssembler.

Examples

exampleDialogPage

Member Typedef Documentation

typedef std::vector<DtPagePath> makVrv::DtPageAssembler::PagePathVector

protected

Vector of page paths.

typedef std::map<DtPageConfiguration::PageCollectionLocation, PagePathVector> makVrv::DtPageAssembler::LocationToPathsMap

protected

Map from page collection location to a vector of page paths at that location.

typedef std::map<int, DtPagePath> makVrv::DtPageAssembler::PagePathsMap

protected

typedef std::map<int, std::map<int, DtPagePath> > makVrv::DtPageAssembler::SortedTabbedPages

protected

Constructor & Destructor Documentation

virtual makVrv::DtPageAssembler::~DtPageAssembler ( )

virtual

DTOR.

makVrv::DtPageAssembler::DtPageAssembler ( DtDe & de )

protected

Member Function Documentation

static DtPageAssembler& makVrv::DtPageAssembler::instance ( DtDe & )

static

Get an instance of the assembler.

Reimplemented in makVrv::DtQtPageAssembler.

virtual void makVrv::DtPageAssembler::assemble ( const DtPageConfiguration & configuration )

virtual

Assemble a entire configuration.

virtual void makVrv::DtPageAssembler::assemble	(	const DtPagePath &	pagePath,
		const DtPageConfiguration &	configuration
	)

virtual

Assemble a particular page path and all children located in a configuration.

Reimplemented in makVrf::makVrfGuiObjectInformationQt::DtInformationPageAssembler.

virtual void makVrv::DtPageAssembler::assemblePagePaths	(	DtPageConfiguration::PagePathList &	children,
		const DtPageConfiguration &	configuration
	)

virtual

Assemble all listed page paths using the configuration.

virtual void makVrv::DtPageAssembler::placeCollectionPages ( const DtPageConfiguration & configuration )

virtual

Update a pages with the information contained in the page configuration.

Reimplemented in makVrf::DtVrfPageAssembler.

virtual void makVrv::DtPageAssembler::assembleCollection	(	const DtPagePath &	pagePath,
		const DtUnicode &	pageTitle,
		const DtPageConfiguration::PageCollectionState &	pageState
	)

virtual

Assemble a page item from the path.

Reimplemented in makVrf::DtVrfPageAssembler, makVrf::makVrfGuiObjectInformationQt::DtInformationPageAssembler, and makVrv::DtQtPageAssembler.

virtual LocationToPathsMap makVrv::DtPageAssembler::buildLocationToPathsMap	(	DtPageConfiguration::PagePathList &	children,
		const DtPageConfiguration &	configuration
	)

protectedvirtual

Build a map of page location to page paths at that location.

virtual void makVrv::DtPageAssembler::assemblePagePath	(	const DtPagePath &	pagePath,
		const DtPageConfiguration &	configuration
	)

protectedvirtual

Assemble a page path.

Reimplemented in makVrf::makVrfGuiObjectInformationQt::DtInformationPageAssembler.

virtual void makVrv::DtPageAssembler::assemblePage ( const DtPagePath & pagePath )

protectedvirtual

Assemble a page from the path.

Reimplemented in makVrf::makVrfGuiObjectInformationQt::DtInformationPageAssembler, and makVrv::DtQtPageAssembler.

virtual void makVrv::DtPageAssembler::updatePage	(	const DtPagePath &	pagePath,
		const DtPageConfiguration &	configuration
	)

protectedvirtual

Update the page with the state information contained inside the provided configuration.

virtual void makVrv::DtPageAssembler::updatePage	(	const DtPagePath &	pagePath,
		const DtPageConfiguration::PageCollectionState &	state
	)

protectedvirtual

Update the page with the state information provided by argument.

Reimplemented in makVrv::DtQtPageAssembler.

virtual void makVrv::DtPageAssembler::assembleAllPagesInLocation	(	const LocationToPathsMap &	locMap,
		DtPageConfiguration::PageCollectionLocation	loc,
		const DtPageConfiguration &	configuration
	)

protectedvirtual

Assembles all the pages in the specified location.

locMap contains a map with all the location/page information and the configuration contains all the state information needed to assemble the pages

virtual void makVrv::DtPageAssembler::tabifyPagesInLocation	(	const LocationToPathsMap &	locMap,
		DtPageConfiguration::PageCollectionLocation	loc,
		const DtPageConfiguration &	configuration
	)

protectedvirtual

Tabifies all the pages whose configuration is set to be tabbed.

locMap contains a mal with all the location/page information and the configuration contains all the state information needed to tabify the page.

virtual SortedTabbedPages makVrv::DtPageAssembler::sortTabbedPagesByLocationAndTabIndex	(	const PagePathVector &	paths,
		const DtPageConfiguration &	configuration,
		DtPageConfiguration::PageCollectionLocation	location
	)

protectedvirtual

Find tabbed pages in the paths list and sort them by location first and tab index second.

virtual int makVrv::DtPageAssembler::positionOfPage	(	DtPageConfiguration::PageCollectionLocation	location,
		const DtPageConfiguration::PageCollectionGeometry &	geometry
	)		const

protectedvirtual

Get the left or topmost edge of a docked page, depending on whether it's docked horizontally or vertically.

virtual void makVrv::DtPageAssembler::populatePagePathsMap	(	const LocationToPathsMap &	locMap,
		DtPageConfiguration::PageCollectionLocation	loc,
		const DtPageConfiguration &	configuration,
		PagePathsMap &	ppMap
	)

protectedvirtual

Populates the ppMap map with the proper order in which pages need to be placed on the UI.

virtual void makVrv::DtPageAssembler::tabify	(	const DtPagePath &	pagePath1,
		const DtPagePath &	pagePath2
	)

protectedvirtual

Tabifies the pages represented by the page paths provided in the arguments.

Reimplemented in makVrv::DtQtPageAssembler.

virtual void makVrv::DtPageAssembler::setSelectedPage ( const DtPagePath & pPath )

protectedvirtual

If the page is tabbed, sets it as the currently selected page.

Reimplemented in makVrv::DtQtPageAssembler.

Friends And Related Function Documentation

friend class DtPageAssemblerCreator

friend

Member Data Documentation

DtDe& makVrv::DtPageAssembler::myDe

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtPageAssembler.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation