This class provides an interface to Page collection widgets. More...

Inheritance diagram for makVrv::DtPageCollection:

Public Types
typedef std::vector< std::string >	PageClassList
Public Member Functions
	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::PageColectionGeometry &	floatingGeometry ()
	Get the current geometry of the collection.
void	setFloatingGeometry (DtPageConfiguration::PageColectionGeometry 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::PageColectionGeometry	dockedGeometry ()
	Get the current docked geometry of the collection.
void	setDockedGeometry (DtPageConfiguration::PageColectionGeometry 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.
Public Attributes
boost::signal< void()>	signal_shown
boost::signal< void()>	signal_hidden
boost::signal< void(const std::string &)>	signal_pageSelected
Protected Member Functions
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::PageColectionGeometry 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::PageColectionGeometry geometry)=0
	Implement changing the docked geometry of the collection.
virtual void	selectPage (const std::string &pageClassName)=0
	Implement selecting a page by name.
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
DtDe &	myDe
std::string	myClassName
bool	myVisibility
PageClassList	myPageClasses
DtPageConfiguration::PageCollectionLocation	myLocation
DtPageConfiguration::PageColectionGeometry	myFloatingGeometry
DtPageConfiguration::PageColectionGeometry	myDockedGeometry

Detailed Description

This class provides an interface to Page collection widgets.

These widgets may be implemented as dockable panels, or as dialogs.

Member Typedef Documentation

typedef std::vector<std::string> makVrv::DtPageCollection::PageClassList

Constructor & Destructor Documentation

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

CTOR, this automatically registers the interface with the makVrv::DtPageCollectionManager instance.

virtual makVrv::DtPageCollection::~DtPageCollection ( ) [virtual]

DTOR, this automatically unregisters the interface with the makVrv::DtPageCollectionManager instance.

Member Function Documentation

const std::string& makVrv::DtPageCollection::collectionClassName ( ) const

Get the collection class name.

const PageClassList& makVrv::DtPageCollection::pageClasses ( ) const

Get a list of all the page classes contained in this collection.

void makVrv::DtPageCollection::show ( const std::string & page = std::string("") )

Show the collection of pages.

Optionally specify the page to show. If no page is provided the last shown page should be used. You can switch pages by calling show multiple times with different page names.

void makVrv::DtPageCollection::hide ( )

Hide the collection of pages.

bool makVrv::DtPageCollection::visible ( ) const

Get whether the collection is currently visible.

virtual int makVrv::DtPageCollection::tabIndex ( ) const [virtual]

If this page collection has been tabified, returns the index inside the tab collection where this collection is.

Returns -1 if it is not tabified

Reimplemented in makVrv::DtQtPagePanel.

virtual bool makVrv::DtPageCollection::isTabbed ( ) const [virtual]

Returns true if this collection has been tabified.

DtPageConfiguration::PageCollectionLocation makVrv::DtPageCollection::location ( ) const

Get the current location of the collection.

void makVrv::DtPageCollection::setLocation ( DtPageConfiguration::PageCollectionLocation location )

Set the current location of the collection.

DtPageConfiguration::PageColectionGeometry& makVrv::DtPageCollection::floatingGeometry ( )

Get the current geometry of the collection.

void makVrv::DtPageCollection::setFloatingGeometry ( DtPageConfiguration::PageColectionGeometry geometry )

//! Set the current floating geometry for the collection

void makVrv::DtPageCollection::setFloatingGeometry	(	int	px,
		int	py,
		int	width,
		int	height
	)

Set the current floating geometry for the collection.

virtual DtPageConfiguration::PageColectionGeometry makVrv::DtPageCollection::dockedGeometry ( ) [virtual]

Get the current docked geometry of the collection.

Reimplemented in makVrv::DtQtPagePanel.

void makVrv::DtPageCollection::setDockedGeometry ( DtPageConfiguration::PageColectionGeometry geometry )

Set the current docked geometry for the collection.

void makVrv::DtPageCollection::setDockedGeometry	(	int	px,
		int	py,
		int	width,
		int	height
	)

Set the current docked geometry for the collection.

virtual void makVrv::DtPageCollection::changeVisibility ( bool newVisibility ) [protected, pure virtual]

Implement the visibility change of the widget.

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

virtual void makVrv::DtPageCollection::changeLocation ( DtPageConfiguration::PageCollectionLocation ) [protected, pure virtual]

Implement changing the location of the collection.

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

virtual void makVrv::DtPageCollection::changeFloatingGeometry	(	int	px,
		int	py,
		int	width,
		int	height
	)		`[protected, pure virtual]`

Implement changing the floating geometry of the collection.

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

virtual void makVrv::DtPageCollection::changeFloatingGeometry ( DtPageConfiguration::PageColectionGeometry geometry ) [protected, pure virtual]

Implement changing the floating geometry of the collection.

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

virtual void makVrv::DtPageCollection::changeDockedGeometry	(	int	px,
		int	py,
		int	width,
		int	height
	)		`[protected, pure virtual]`

Implement changing the docked geometry of the collection.

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

virtual void makVrv::DtPageCollection::changeDockedGeometry ( DtPageConfiguration::PageColectionGeometry geometry ) [protected, pure virtual]

Implement changing the docked geometry of the collection.

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

virtual void makVrv::DtPageCollection::selectPage ( const std::string & pageClassName ) [protected, pure virtual]

Implement selecting a page by name.

Implemented in makVrv::DtQtPageCollection.

void makVrv::DtPageCollection::addPageClass ( const std::string & pageClassName ) [protected]

Subclasses must call this when a page is added.

void makVrv::DtPageCollection::removePageClass ( const std::string & pageClassName ) [protected]

Subclasses must call this when a page is removed.

Member Data Documentation

boost::signal<void ()> makVrv::DtPageCollection::signal_shown

boost::signal<void ()> makVrv::DtPageCollection::signal_hidden

boost::signal<void (const std::string&)> makVrv::DtPageCollection::signal_pageSelected

DtDe& makVrv::DtPageCollection::myDe [protected]

std::string makVrv::DtPageCollection::myClassName [protected]

bool makVrv::DtPageCollection::myVisibility [protected]

PageClassList makVrv::DtPageCollection::myPageClasses [protected]

DtPageConfiguration::PageCollectionLocation makVrv::DtPageCollection::myLocation [protected]

DtPageConfiguration::PageColectionGeometry makVrv::DtPageCollection::myFloatingGeometry [protected]

DtPageConfiguration::PageColectionGeometry makVrv::DtPageCollection::myDockedGeometry [protected]

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

include/vrvCore/DtPageCollection.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation