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:

[legend]

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)
	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.
DtPage *	findPage (const std::string &pageClassName)
	Find a page. Returns 0 if the page wasn't added.
const DtPage *	findPage (const std::string &pageClassName) const
	Find a page. Returns 0 if the page wasn't added.
const PageMap &	pages () 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)
Public Member Functions inherited from makVrv::DtPageCollection
	DtPageCollection (DtDe &de, const std::string &collectionClassName)
	CTOR, this automatically registers the interface with the makVrv::DtPageCollectionManager instance.
virtual	~DtPageCollection ()
	DTOR, this automatically unregisters the interface with the makVrv::DtPageCollectionManager instance.
const std::string &	collectionClassName () const
	Get the collection class name.
const PageClassList &	pageClasses () const
	Get a list of all the page classes contained in this collection.
void	show (const std::string &page=std::string(""))
	Show the collection of pages.
void	hide ()
	Hide the collection of pages.
bool	visible () const
	Get whether the collection is currently visible.
virtual int	tabIndex () const
	If this page collection has been tabified, returns the index inside the tab collection where this collection is.
virtual bool	isTabbed () const
	Returns true if this collection has been tabified.
DtPageConfiguration::PageCollectionLocation	location () const
	Get the current location of the collection.
void	setLocation (DtPageConfiguration::PageCollectionLocation location)
	Set the current location of the collection.
DtPageConfiguration::PageCollectionGeometry &	floatingGeometry ()
	Get the current geometry of the collection.
void	setFloatingGeometry (DtPageConfiguration::PageCollectionGeometry geometry)
	//! Set the current floating geometry for the collection
void	setFloatingGeometry (int px, int py, int width, int height)
	Set the current floating geometry for the collection.
virtual DtPageConfiguration::PageCollectionGeometry	dockedGeometry ()
	Get the current docked geometry of the collection.
void	setDockedGeometry (DtPageConfiguration::PageCollectionGeometry geometry)
	Set the current docked geometry for the collection.
void	setDockedGeometry (int px, int py, int width, int height)
	Set the current docked geometry for the collection.

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 Member Functions inherited from makVrv::DtPageCollection
virtual void	changeVisibility (bool newVisibility)=0
	Implement the visibility change of the widget.
virtual void	changeLocation (DtPageConfiguration::PageCollectionLocation)=0
	Implement changing the location of the collection.
virtual void	changeFloatingGeometry (int px, int py, int width, int height)=0
	Implement changing the floating geometry of the collection.
virtual void	changeFloatingGeometry (DtPageConfiguration::PageCollectionGeometry geometry)=0
	Implement changing the floating geometry of the collection.
virtual void	changeDockedGeometry (int px, int py, int width, int height)=0
	Implement changing the docked geometry of the collection.
virtual void	changeDockedGeometry (DtPageConfiguration::PageCollectionGeometry geometry)=0
	Implement changing the docked geometry of the collection.
void	addPageClass (const std::string &pageClassName)
	Subclasses must call this when a page is added.
void	removePageClass (const std::string &pageClassName)
	Subclasses must call this when a page is removed.

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::signal< void()>	signal_shown
boost::signal< void()>	signal_hidden
boost::signal< void(const std::string &)>	signal_pageSelected

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.

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 )

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.

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, makVrf::DtOverlayBar, and makVrf::makVrfGuiObjectInformationQt::DtInformationDialog.

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

protectedpure virtual

Implement adding the page to the GUI.

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

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

protectedpure virtual

Implement removing a page from the GUI.

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

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

protectedpure virtual

Implement selecting a page in the GUI.

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

Member Data Documentation

PageMap makVrv::DtQtPageCollection::myPages

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCoreQt/DtQtPageCollection.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation