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.

Inheritance diagram for makVrv::DtQtPageCollection:

Public Types
typedef boost::unordered_map < std::string, DtPage * >	PageMap
Public Types inherited from makVrv::DtPageCollection
typedef std::vector< std::string >	PageClassList

Public Member Functions
	DtQtPageCollection (DtDe &de, const std::string &collectionClassName)
virtual	~DtQtPageCollection ()
void	addPage (DtPage *page)
void	removePage (DtPage *page, bool deletePage=true)
DtPage *	findPage (const std::string &pageClassName)
const DtPage *	findPage (const std::string &pageClassName) const
const PageMap &	pages () const
virtual void	removeContainer ()
virtual void	bringToTop ()
Public Member Functions inherited from makVrv::DtPageCollection
	DtPageCollection (DtDe &de, const std::string &collectionClassName)
virtual	~DtPageCollection ()
const std::string &	collectionClassName () const
const PageClassList &	pageClasses () const
void	show (const std::string &page=std::string(""))
void	hide ()
bool	visible () const
virtual int	tabIndex () const
virtual bool	isTabbed () const
DtPageConfiguration::PageCollectionLocation	location () const
void	setLocation (DtPageConfiguration::PageCollectionLocation location)
DtPageConfiguration::PageCollectionGeometry &	floatingGeometry ()
void	setFloatingGeometry (const DtPageConfiguration::PageCollectionGeometry &geometry)
void	setFloatingGeometry (int px, int py, int width, int height)
virtual DtPageConfiguration::PageCollectionGeometry	dockedGeometry ()
void	setDockedGeometry (const DtPageConfiguration::PageCollectionGeometry &geometry)
void	setDockedGeometry (int px, int py, int width, int height)

Protected Member Functions
virtual void	activatePage (DtPage *)
virtual void	deactivatePage (DtPage *)
virtual void	selectPage (const std::string &pageClassName)
virtual void	addPageToGui (DtPage *)=0
virtual void	removePageFromGui (DtPage *)=0
virtual void	selectPageInGui (DtPage *page)=0
Protected Member Functions inherited from makVrv::DtPageCollection
virtual void	changeVisibility (bool newVisibility)=0
virtual void	changeLocation (DtPageConfiguration::PageCollectionLocation)=0
virtual void	changeFloatingGeometry (int px, int py, int width, int height)=0
virtual void	changeFloatingGeometry (const DtPageConfiguration::PageCollectionGeometry &geometry)=0
virtual void	changeDockedGeometry (int px, int py, int width, int height)=0
virtual void	changeDockedGeometry (const DtPageConfiguration::PageCollectionGeometry &geometry)=0
void	addPageClass (const std::string &pageClassName)
void	removePageClass (const std::string &pageClassName)

Protected Attributes
PageMap	myPages
Protected Attributes inherited from makVrv::DtPageCollection
DtDe &	myDe
std::string	myClassName
bool	myVisibility
PageClassList	myPageClasses
DtPageConfiguration::PageCollectionLocation	myLocation
DtPageConfiguration::PageCollectionGeometry	myFloatingGeometry
DtPageConfiguration::PageCollectionGeometry	myDockedGeometry

Additional Inherited Members
Public Attributes inherited from makVrv::DtPageCollection
boost::signalslib::signal< void()>	signal_shown
boost::signalslib::signal< void()>	signal_hidden
boost::signalslib::signal < void(const std::string &)>	signal_pageSelected

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.

virtual makVrv::DtQtPageCollection::~DtQtPageCollection ( )

virtual

DTOR, this will delete all currently added pages. This will not call removePageFromGUI for each page.

Member Function Documentation

void makVrv::DtQtPageCollection::addPage

(

DtPage *

page

)

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 )

virtual

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

Implements makVrv::DtPageCollection.

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

virtual

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

Implements makVrv::DtPageCollection.

const PageMap& makVrv::DtQtPageCollection::pages

(

)

const

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 *  )

protectedvirtual

Reimplemented in makVrf::makVrfGuiObjectInformationQt::DtInformationDialog.

virtual void makVrv::DtQtPageCollection::deactivatePage ( DtPage *  )

protectedvirtual

virtual void makVrv::DtQtPageCollection::selectPage ( const std::string &  pageClassName )

protectedvirtual

Implements selecting a page by name.

Implements makVrv::DtPageCollection.

Reimplemented in makVrf::DtAutoHidePanel, and makVrf::DtQtPageWidget.

virtual void makVrv::DtQtPageCollection::addPageToGui ( DtPage *  )

protectedpure virtual

Implement adding the page to the GUI.

Implemented in makVrf::DtAutoHidePanel, makVrf::makVrfGuiObjectInformationQt::DtInformationDialog, makVrv::DtQtPageDialog, makVrv::DtQtPagePanel, and makVrf::DtQtPageWidget.

virtual void makVrv::DtQtPageCollection::removePageFromGui ( DtPage *  )

protectedpure virtual

Implement removing a page from the GUI.

Implemented in makVrf::DtAutoHidePanel, makVrv::DtQtPageDialog, makVrv::DtQtPagePanel, and makVrf::DtQtPageWidget.

virtual void makVrv::DtQtPageCollection::selectPageInGui ( DtPage *  page )

protectedpure virtual

Implement selecting a page in the GUI.

Implemented in makVrf::DtAutoHidePanel, makVrv::DtQtPageDialog, makVrv::DtQtPagePanel, and makVrf::DtQtPageWidget.

Member Data Documentation

PageMap makVrv::DtQtPageCollection::myPages

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCoreQt/DtQtPageCollection.h