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	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.
Static Public Member Functions
static DtPageAssembler &	instance (DtDe &)
	Get an instance of the assembler.
Protected Types
typedef std::multimap < DtPageConfiguration::PageCollectionLocation, DtPagePath >	LocationPathMap
typedef std::map< int, DtPagePath >	PagePathsMap
Protected Member Functions
	DtPageAssembler (DtDe &de)
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 LocationPathMap &locMap, DtPageConfiguration::PageCollectionLocation loc, const DtPageConfiguration &configuration)
	Assembles all the pages in the specified location.
virtual void	tabifyPagesInLocation (const LocationPathMap &locMap, DtPageConfiguration::PageCollectionLocation loc, const DtPageConfiguration &configuration)
	Tabifies all the pages whose configuration is set to be tabbed.
virtual void	populatePagePathsMap (const LocationPathMap &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::multimap<DtPageConfiguration::PageCollectionLocation, DtPagePath> makVrv::DtPageAssembler::LocationPathMap [protected]

typedef std::map<int, DtPagePath> makVrv::DtPageAssembler::PagePathsMap [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.

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

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

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 makVrv::DtQtPageAssembler, and makVrf::makVrfGuiObjectInformationQt::DtInformationPageAssembler.

virtual void makVrv::DtPageAssembler::assemblePagePath	(	const DtPagePath &	pagePath,
		const DtPageConfiguration &	configuration
	)		`[protected, virtual]`

Assemble a page path.

Reimplemented in makVrf::makVrfGuiObjectInformationQt::DtInformationPageAssembler.

virtual void makVrv::DtPageAssembler::assemblePage ( const DtPagePath & pagePath ) [protected, virtual]

Assemble a page from the path.

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

virtual void makVrv::DtPageAssembler::updatePage	(	const DtPagePath &	pagePath,
		const DtPageConfiguration &	configuration
	)		`[protected, virtual]`

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

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

Update the page with the state information provided by argument.

Reimplemented in makVrv::DtQtPageAssembler.

virtual void makVrv::DtPageAssembler::assembleAllPagesInLocation	(	const LocationPathMap &	locMap,
		DtPageConfiguration::PageCollectionLocation	loc,
		const DtPageConfiguration &	configuration
	)		`[protected, virtual]`

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 LocationPathMap &	locMap,
		DtPageConfiguration::PageCollectionLocation	loc,
		const DtPageConfiguration &	configuration
	)		`[protected, virtual]`

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 void makVrv::DtPageAssembler::populatePagePathsMap	(	const LocationPathMap &	locMap,
		DtPageConfiguration::PageCollectionLocation	loc,
		const DtPageConfiguration &	configuration,
		PagePathsMap &	ppMap
	)		`[protected, virtual]`