MAK Data Logger API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
MAKLogger::DtPreferencesPageCollection Class Referenceabstract

The DtPreferencesPageCollection 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 MAKLogger::DtPreferencesPageCollection:
+ Collaboration diagram for MAKLogger::DtPreferencesPageCollection:

Public Types

typedef std::map< std::string,
DtPage * > 
PageMap
 

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

PageMap myPages
 

Detailed Description

The DtPreferencesPageCollection 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

Constructor & Destructor Documentation

MAKLogger::DtPreferencesPageCollection::DtPreferencesPageCollection ( )

CTOR.

virtual MAKLogger::DtPreferencesPageCollection::~DtPreferencesPageCollection ( )
virtual

DTOR, this will delete all currently added pages.

This will not call removePageFromGUI for each page.

Member Function Documentation

virtual void MAKLogger::DtPreferencesPageCollection::acceptPages ( )
protectedvirtual
virtual void MAKLogger::DtPreferencesPageCollection::activatePage ( DtPage )
protectedvirtual
void MAKLogger::DtPreferencesPageCollection::addPage ( DtPage page)

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

virtual void MAKLogger::DtPreferencesPageCollection::addPageToGui ( DtPage )
protectedpure virtual

Implement adding the page to the GUI.

Implemented in MAKLogger::DtPreferencesPageDialog.

virtual void MAKLogger::DtPreferencesPageCollection::bringToTop ( )
virtual

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

virtual void MAKLogger::DtPreferencesPageCollection::deactivatePage ( DtPage )
protectedvirtual
DtPage* MAKLogger::DtPreferencesPageCollection::findPage ( const std::string &  pageClassName)

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

const DtPage* MAKLogger::DtPreferencesPageCollection::findPage ( const std::string &  pageClassName) const

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

virtual void MAKLogger::DtPreferencesPageCollection::loadPages ( )
protectedvirtual
const PageMap& MAKLogger::DtPreferencesPageCollection::pages ( ) const

Get the currently available pages.

virtual void MAKLogger::DtPreferencesPageCollection::rejectPages ( )
protectedvirtual
virtual void MAKLogger::DtPreferencesPageCollection::removeContainer ( )
virtual

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

void MAKLogger::DtPreferencesPageCollection::removePage ( DtPage page,
bool  deletePage = true 
)

Remove a page that was previously added.

By default the page will be deleted.

virtual void MAKLogger::DtPreferencesPageCollection::removePageFromGui ( DtPage )
protectedpure virtual

Implement removing a page from the GUI.

Implemented in MAKLogger::DtPreferencesPageDialog.

virtual void MAKLogger::DtPreferencesPageCollection::selectPage ( const std::string &  pageClassName)
protectedvirtual

Implements selecting a page by name.

virtual void MAKLogger::DtPreferencesPageCollection::selectPageInGui ( DtPage page)
protectedpure virtual

Implement selecting a page in the GUI.

Implemented in MAKLogger::DtPreferencesPageDialog.

Member Data Documentation

PageMap MAKLogger::DtPreferencesPageCollection::myPages
protected

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

Document ID: Generated on Thu Sep 2 15:35:22 EDT 2021 from SVN revision 233992
Copyright © 2021 MAK Technologies. All Rights Reserved (www.mak.com)