VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
makVrv::DtQtPageAssembler Class Reference

This is the Qt specific implementation of the page assembler. More...

Inheritance diagram for makVrv::DtQtPageAssembler:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtQtPageAssembler ()
 DTOR. More...
 
void registerPageCreator (DtPageCreator *creator)
 Register a page creator, the page creator will create pages when assembling. More...
 
void unregisterPageCreator (DtPageCreator *creator, bool deleteCreator=true)
 Register a page creator. More...
 
DtPageCreatorfindPageCreator (const std::string &pageClassName) const
 Find a page creator, based upon it's page class name. More...
 
- Public Member Functions inherited from makVrv::DtPageAssembler
virtual ~DtPageAssembler ()
 DTOR. More...
 
virtual void assemble (const DtPageConfiguration &configuration)
 Assemble a entire configuration. More...
 
virtual void assemble (const DtPagePath &pagePath, const DtPageConfiguration &configuration)
 Assemble a particular page path and all children located in a configuration. More...
 
virtual void assemblePagePaths (DtPageConfiguration::PagePathList &children, const DtPageConfiguration &configuration)
 Assemble all listed page paths using the configuration. More...
 
virtual void placeCollectionPages (const DtPageConfiguration &configuration)
 Update a pages with the information contained in the page configuration. More...
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor. More...
 
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor. More...
 

Static Public Member Functions

static DtQtPageAssemblerinstance (DtDe &de)
 Get an instance of the Qt page Assembler. More...
 
- Static Public Member Functions inherited from makVrv::DtPageAssembler
static DtPageAssemblerinstance (DtDe &)
 Get an instance of the assembler. More...
 

Protected Types

typedef boost::unordered_map
< std::string, DtPageCreator * > 
PageCreatorMap
 
- Protected Types inherited from makVrv::DtPageAssembler
typedef std::vector< DtPagePathPagePathVector
 Vector of page paths. More...
 
typedef std::map
< DtPageConfiguration::PageCollectionLocation,
PagePathVector
LocationToPathsMap
 Map from page collection location to a vector of page paths at that location. More...
 
typedef std::map< int, DtPagePathPagePathsMap
 
typedef std::map< int,
std::map< int, DtPagePath > > 
SortedTabbedPages
 

Protected Member Functions

 DtQtPageAssembler (DtDe &de)
 Ctor is protected to ensure the class is created using the Creator. More...
 
virtual void assembleCollection (const DtPagePath &pagePath, const DtUnicode &pageTitle, const DtPageConfiguration::PageCollectionState &pageState)
 Assemble a page item from the path. More...
 
virtual void assemblePage (const DtPagePath &pagePath)
 Assemble a page from the path. More...
 
virtual void updatePage (const DtPagePath &pagePath, const DtPageConfiguration::PageCollectionState &state)
 Update the page with the state information provided by argument. More...
 
virtual void tabify (const DtPagePath &pagePath1, const DtPagePath &pagePath2)
 Tabifies the pages represented by the page paths provided in the arguments. More...
 
virtual void setSelectedPage (const DtPagePath &pPath)
 If the page is tabbed, sets it as the currently selected page. More...
 
QWidget * mainWindow ()
 
- Protected Member Functions inherited from makVrv::DtPageAssembler
 DtPageAssembler (DtDe &de)
 
virtual LocationToPathsMap buildLocationToPathsMap (DtPageConfiguration::PagePathList &children, const DtPageConfiguration &configuration)
 Build a map of page location to page paths at that location. More...
 
virtual void assemblePagePath (const DtPagePath &pagePath, const DtPageConfiguration &configuration)
 Assemble a page path. More...
 
virtual void updatePage (const DtPagePath &pagePath, const DtPageConfiguration &configuration)
 Update the page with the state information contained inside the provided configuration. More...
 
virtual void assembleAllPagesInLocation (const LocationToPathsMap &locMap, DtPageConfiguration::PageCollectionLocation loc, const DtPageConfiguration &configuration)
 Assembles all the pages in the specified location. More...
 
virtual void tabifyPagesInLocation (const LocationToPathsMap &locMap, DtPageConfiguration::PageCollectionLocation loc, const DtPageConfiguration &configuration)
 Tabifies all the pages whose configuration is set to be tabbed. More...
 
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. More...
 
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. More...
 
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. More...
 

Protected Attributes

PageCreatorMap myPageCreatorMap
 
QWidget * myMainWindowCache
 
- Protected Attributes inherited from makVrv::DtPageAssembler
DtDemyDe
 

Friends

class DtQtPageAssemblerCreator
 

Detailed Description

This is the Qt specific implementation of the page assembler.

Actual page creators must be registered with the page assembler.

Examples

Member Typedef Documentation

typedef boost::unordered_map<std::string,DtPageCreator*> makVrv::DtQtPageAssembler::PageCreatorMap
protected

Constructor & Destructor Documentation

virtual makVrv::DtQtPageAssembler::~DtQtPageAssembler ( )
virtual

DTOR.

makVrv::DtQtPageAssembler::DtQtPageAssembler ( DtDe de)
protected

Ctor is protected to ensure the class is created using the Creator.

Member Function Documentation

static DtQtPageAssembler& makVrv::DtQtPageAssembler::instance ( DtDe de)
static

Get an instance of the Qt page Assembler.

void makVrv::DtQtPageAssembler::registerPageCreator ( DtPageCreator creator)

Register a page creator, the page creator will create pages when assembling.

void makVrv::DtQtPageAssembler::unregisterPageCreator ( DtPageCreator creator,
bool  deleteCreator = true 
)

Register a page creator.

DtPageCreator* makVrv::DtQtPageAssembler::findPageCreator ( const std::string &  pageClassName) const

Find a page creator, based upon it's page class name.

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

Assemble a page item from the path.

Reimplemented from makVrv::DtPageAssembler.

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

virtual void makVrv::DtQtPageAssembler::assemblePage ( const DtPagePath pagePath)
protectedvirtual

Assemble a page from the path.

Reimplemented from makVrv::DtPageAssembler.

Reimplemented in makVrf::makVrfGuiObjectInformationQt::DtInformationPageAssembler.

virtual void makVrv::DtQtPageAssembler::updatePage ( const DtPagePath pagePath,
const DtPageConfiguration::PageCollectionState state 
)
protectedvirtual

Update the page with the state information provided by argument.

Reimplemented from makVrv::DtPageAssembler.

virtual void makVrv::DtQtPageAssembler::tabify ( const DtPagePath pagePath1,
const DtPagePath pagePath2 
)
protectedvirtual

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

Reimplemented from makVrv::DtPageAssembler.

virtual void makVrv::DtQtPageAssembler::setSelectedPage ( const DtPagePath pPath)
protectedvirtual

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

Reimplemented from makVrv::DtPageAssembler.

QWidget* makVrv::DtQtPageAssembler::mainWindow ( )
protected

Friends And Related Function Documentation

friend class DtQtPageAssemblerCreator
friend

Member Data Documentation

PageCreatorMap makVrv::DtQtPageAssembler::myPageCreatorMap
protected
QWidget* makVrv::DtQtPageAssembler::myMainWindowCache
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)