VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtQtPageCollection Class Reference

The DtQtPageCollection is an abstract class which implements the page collection interface, and can be used extended by specific Qt implementations such as a tabbed panel or dialog. More...

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

List of all members.

Public Types

typedef boost::unordered_map
< std::string, DtPage * > 
PageMap

Public Member Functions

 DtQtPageCollection (DtDe &de, const std::string &collectionClassName)
 CTOR.
virtual ~DtQtPageCollection ()
 DTOR, this will delete all currently added pages.
void addPage (DtPage *page)
 Add a page to the collection, the collection will assume ownership of the pointer.
void removePage (DtPage *page, bool deletePage=true)
 Remove a page that was previously added.
DtPagefindPage (const std::string &pageClassName)
 Find a page. Returns 0 if the page wasn't added.
const DtPagefindPage (const std::string &pageClassName) const
 Find a page. Returns 0 if the page wasn't added.
const PageMappages () const
 Get the currently available pages.
virtual void removeContainer ()
 Removes the collection from the GUI (does not delete it)
virtual void bringToTop ()
 Brings the panel to the front (when it is tabbed)

Protected Member Functions

virtual void activatePage (DtPage *)
virtual void deactivatePage (DtPage *)
virtual void selectPage (const std::string &pageClassName)
 Implements selecting a page by name.
virtual void addPageToGui (DtPage *)=0
 Implement adding the page to the GUI.
virtual void removePageFromGui (DtPage *)=0
 Implement removing a page from the GUI.
virtual void selectPageInGui (DtPage *page)=0
 Implement selecting a page in the GUI.

Protected Attributes

PageMap myPages

Detailed Description

The DtQtPageCollection is an abstract class which implements the page collection interface, and can be used extended by specific Qt implementations such as a tabbed panel or dialog.


Member Typedef Documentation

typedef boost::unordered_map<std::string,DtPage*> makVrv::DtQtPageCollection::PageMap

Constructor & Destructor Documentation

makVrv::DtQtPageCollection::DtQtPageCollection ( DtDe de,
const std::string &  collectionClassName 
)

CTOR.

DTOR, this will delete all currently added pages.

This will not call removePageFromGUI for each page.


Member Function Documentation

Add a page to the collection, the collection will assume ownership of the pointer.

void makVrv::DtQtPageCollection::removePage ( DtPage page,
bool  deletePage = true 
)

Remove a page that was previously added.

By default the page will be deleted.

DtPage* makVrv::DtQtPageCollection::findPage ( const std::string &  pageClassName)

Find a page. Returns 0 if the page wasn't added.

const DtPage* makVrv::DtQtPageCollection::findPage ( const std::string &  pageClassName) const

Find a page. Returns 0 if the page wasn't added.

Get the currently available pages.

virtual void makVrv::DtQtPageCollection::removeContainer ( ) [virtual]

Removes the collection from the GUI (does not delete it)

Reimplemented in makVrv::DtQtPagePanel.

virtual void makVrv::DtQtPageCollection::bringToTop ( ) [virtual]

Brings the panel to the front (when it is tabbed)

Reimplemented in makVrv::DtQtPagePanel.

virtual void makVrv::DtQtPageCollection::activatePage ( DtPage ) [protected, virtual]
virtual void makVrv::DtQtPageCollection::deactivatePage ( DtPage ) [protected, virtual]
virtual void makVrv::DtQtPageCollection::selectPage ( const std::string &  pageClassName) [protected, virtual]

Implements selecting a page by name.

Implements makVrv::DtPageCollection.

virtual void makVrv::DtQtPageCollection::addPageToGui ( DtPage ) [protected, pure virtual]

Implement adding the page to the GUI.

Implemented in makVrv::DtQtPagePanel, and makVrv::DtQtPageDialog.

virtual void makVrv::DtQtPageCollection::removePageFromGui ( DtPage ) [protected, pure virtual]

Implement removing a page from the GUI.

Implemented in makVrv::DtQtPagePanel, and makVrv::DtQtPageDialog.

virtual void makVrv::DtQtPageCollection::selectPageInGui ( DtPage page) [protected, pure virtual]

Implement selecting a page in the GUI.

Implemented in makVrv::DtQtPagePanel, and makVrv::DtQtPageDialog.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)