makVrv::DtPageCollection Class Reference

This class provides an interface to Page collection widgets. These widgets may be implemented as dockable panels, or as dialogs.

Inheritance diagram for makVrv::DtPageCollection:

Public Types
typedef std::vector< std::string >	PageClassList

Public Member Functions
	DtPageCollection (DtDe &de, const std::string &collectionClassName)
virtual	~DtPageCollection ()
virtual DtPage *	findPage (const std::string &pageClassName)=0
virtual const DtPage *	findPage (const std::string &pageClassName) const =0
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)

Public Attributes
boost::signalslib::signal< void()>	signal_shown
boost::signalslib::signal< void()>	signal_hidden
boost::signalslib::signal < void(const std::string &)>	signal_pageSelected

Protected Member Functions
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
virtual void	selectPage (const std::string &pageClassName)=0
void	addPageClass (const std::string &pageClassName)
void	removePageClass (const std::string &pageClassName)

Protected Attributes
DtDe &	myDe
std::string	myClassName
bool	myVisibility
PageClassList	myPageClasses
DtPageConfiguration::PageCollectionLocation	myLocation
DtPageConfiguration::PageCollectionGeometry	myFloatingGeometry
DtPageConfiguration::PageCollectionGeometry	myDockedGeometry

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

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

pure virtual

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

Implemented in makVrv::DtQtPageCollection.

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

pure virtual

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

Implemented in makVrv::DtQtPageCollection.

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.

Referenced by makVrf::makVrfGuiObjectInformationQt::DtInformationDialog::show().

void makVrv::DtPageCollection::hide

(

)

Hide the collection of pages.

Referenced by makVrf::makVrfGuiObjectInformationQt::DtInformationDialog::hide().

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::PageCollectionGeometry& makVrv::DtPageCollection::floatingGeometry

(

)

Get the current geometry of the collection.

void makVrv::DtPageCollection::setFloatingGeometry

(

const DtPageConfiguration::PageCollectionGeometry &

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::PageCollectionGeometry makVrv::DtPageCollection::dockedGeometry ( )

virtual

Get the current docked geometry of the collection.

Reimplemented in makVrv::DtQtPagePanel.

void makVrv::DtPageCollection::setDockedGeometry

(

const DtPageConfiguration::PageCollectionGeometry &

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 )

protectedpure virtual

Implement the visibility change of the widget.

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

virtual void makVrv::DtPageCollection::changeLocation ( DtPageConfiguration::PageCollectionLocation  )

protectedpure virtual

Implement changing the location of the collection.

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

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

protectedpure virtual

Implement changing the floating geometry of the collection.

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

virtual void makVrv::DtPageCollection::changeFloatingGeometry ( const DtPageConfiguration::PageCollectionGeometry &  geometry )

protectedpure virtual

Implement changing the floating geometry of the collection.

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

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

protectedpure virtual

Implement changing the docked geometry of the collection.

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

virtual void makVrv::DtPageCollection::changeDockedGeometry ( const DtPageConfiguration::PageCollectionGeometry &  geometry )

protectedpure virtual

Implement changing the docked geometry of the collection.

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

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

protectedpure virtual

Implement selecting a page by name.

Implemented in makVrf::DtAutoHidePanel, makVrv::DtQtPageCollection, and makVrf::DtQtPageWidget.

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::signalslib::signal<void ()> makVrv::DtPageCollection::signal_shown

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

boost::signalslib::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::PageCollectionGeometry makVrv::DtPageCollection::myFloatingGeometry

protected

DtPageConfiguration::PageCollectionGeometry makVrv::DtPageCollection::myDockedGeometry

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtPageCollection.h