The Qt Page Panel, is a generic docked widget that contains a number of DtPages that it displays individually using a Tabbed Widget. More...

Inheritance diagram for makVrv::DtQtPagePanel:

[legend]

Public Member Functions
	DtQtPagePanel (DtDe &de, const std::string &panelClassName, QWidget *parent=0)
	CTOR.
virtual	~DtQtPagePanel ()
	DTOR.
virtual int	tabIndex () const
	If this page collection has been tabified, returns the index inside the tab collection where this collection is.
virtual DtPageConfiguration::PageCollectionGeometry	dockedGeometry ()
	Get the current docked geometry of the collection.
virtual void	removeContainer ()
	Removes the panel from the UI.
virtual void	bringToTop ()
	Brings the panel to the front (when it is tabbed)
Public Member Functions inherited from makVrv::DtQtPageCollection
	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.
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 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.
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.
Public Member Functions inherited from makVrv::DtDockable
	DtDockable (DtDe &de, const std::string &className)
	CTOR By default a dockable widget is not docked, call dock to attempt to dock this widget.
virtual	~DtDockable ()
	DTOR.
const std::string &	className () const
	The class name.
void	dock (Qt::DockWidgetArea area)
	Dock this dockable in the main window, this function should only be called once.
virtual bool	isDocked () const
	Check to see if we are in a container.
virtual void	setContainerVisible (bool visible)
	call either shows or hides container base upon the input.
virtual void	setContainerMovable (bool moveable)
	Set whether the container is moveable.
virtual void	setContainerFloatable (bool floatable)
	Set whether the container is floatable.
virtual void	setContainerClosable (bool closeable)
	Set whether the container is closeable.
virtual bool	isContainerHidden () const
	Returns true if container is hidden.
virtual bool	isContainerMovable () const
	Returns true if container is moveable.
virtual bool	isContainerFloatable () const
	Returns true if container is floatable.
virtual bool	isContainerClosable () const
	Returns true if container is closeable.
virtual void	showContainer ()
	Show the container.
virtual void	hideContainer ()
	Hide the container.
virtual void	floatContainer ()
	Float the container.
virtual void	unfloatContainer ()
	Un float the container.
virtual bool	initiallyVisible () const
	Virtual function needed for controlling if the widget is docked visible.
virtual Qt::DockWidgetArea	initialDockWidgetLocation () const
	Virtual function needed for controlling if the widget is docked visible.
virtual bool	containerTabbed () const
	Tells whether the container is tabbed or not.
virtual int	containerTabIndex () const
	If the container is tabbed, returns the position of the container inside the tab structure.
virtual void	getContainerTabbedGeometry (int &x, int &y, int &width, int &height) const
	Gets the geometry of the container if it is tabbed.
virtual QWidget *	container ()
	Returns the QDockWidget or other container that holds this widget.
virtual void	setDockWidgetItem (DtDockWidgetItem *item)
	If this dockable is the target of a menu item, a pointer to to the associated menu item.
virtual DtDockWidgetItem *	dockWidgetItem () const
	Get the associated menu item, if any.
virtual void	connectContainerToDockItem ()
	The menu item create does this the first time, but we need to do it explicitly on GUI restores.

Protected Slots
virtual void	onVisibilityChanged (bool visible)
virtual void	onCurrentChanged (int index)
virtual void	onDockLocationChanged (Qt::DockWidgetArea)
virtual void	onTopLevelChanged (bool)

Protected Member Functions
virtual bool	eventFilter (QObject obj, QEvent ev)
	Event filter to check for various actions that happen on the panel (move and resize)
virtual void	setContainer (QWidget *cont)
	Override default container set, to allow for hooking up to the visibility signal.
virtual void	changeVisibility (bool newVisibility)
	Implementation of the visibility change of the widget.
virtual void	changeLocation (DtPageConfiguration::PageCollectionLocation location)
	Implementation of changing the location of the collection.
virtual void	changeFloatingGeometry (int px, int py, int width, int height)
	Implement changing the floating geometry of the collection.
virtual void	changeFloatingGeometry (DtPageConfiguration::PageCollectionGeometry geometry)
	Implement changing the floating geometry of the collection.
virtual void	changeDockedGeometry (int px, int py, int width, int height)
	Implement changing the docked geometry of the collection.
virtual void	changeDockedGeometry (DtPageConfiguration::PageCollectionGeometry geometry)
	Implement changing the docked geometry of the collection.
virtual void	addPageToGui (DtPage *page)
	Implementation of adding the page to the GUI.
virtual void	removePageFromGui (DtPage *page)
	Implementation of removing a page from the GUI.
virtual void	selectPageInGui (DtPage *page)
	Implementation of selecting a page in the GUI.
Protected Member Functions inherited from makVrv::DtQtPageCollection
virtual void	activatePage (DtPage *)
virtual void	deactivatePage (DtPage *)
virtual void	selectPage (const std::string &pageClassName)
	Implements selecting a page by name.
Protected Member Functions inherited from makVrv::DtPageCollection
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 Member Functions inherited from makVrv::DtDockable
QTabBar *	tabBar () const
	Returns the container tab bar object if myContainer is tabbed.

Protected Attributes
DtPage *	myActivePage
QTabBar *	myQTabBar
Protected Attributes inherited from makVrv::DtQtPageCollection
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
Protected Attributes inherited from makVrv::DtDockable
QWidget *	myContainer
	my Container widget
std::string	myClassName
DtDe &	myDe
bool	myIsFloatable
bool	myIsClosable
bool	myIsMovable
DtDockWidgetItem *	myDockWidgetItem

Additional Inherited Members
Public Types inherited from makVrv::DtQtPageCollection
typedef boost::unordered_map < std::string, DtPage * >	PageMap
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 Qt Page Panel, is a generic docked widget that contains a number of DtPages that it displays individually using a Tabbed Widget.

Constructor & Destructor Documentation

makVrv::DtQtPagePanel::DtQtPagePanel	(	DtDe &	de,
		const std::string &	panelClassName,
		QWidget *	parent = `0`
	)

CTOR.

virtual makVrv::DtQtPagePanel::~DtQtPagePanel ( )

virtual

DTOR.

Member Function Documentation

virtual int makVrv::DtQtPagePanel::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 from makVrv::DtPageCollection.

virtual DtPageConfiguration::PageCollectionGeometry makVrv::DtQtPagePanel::dockedGeometry ( )

virtual

Get the current docked geometry of the collection.

Reimplemented from makVrv::DtPageCollection.

virtual void makVrv::DtQtPagePanel::removeContainer ( )

virtual

Removes the panel from the UI.

Reimplemented from makVrv::DtDockable.

virtual void makVrv::DtQtPagePanel::bringToTop ( )

virtual

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

Reimplemented from makVrv::DtDockable.

virtual void makVrv::DtQtPagePanel::onVisibilityChanged ( bool visible )

protectedvirtualslot

virtual void makVrv::DtQtPagePanel::onCurrentChanged ( int index )

protectedvirtualslot

virtual void makVrv::DtQtPagePanel::onDockLocationChanged ( Qt::DockWidgetArea )

protectedvirtualslot

virtual void makVrv::DtQtPagePanel::onTopLevelChanged ( bool )

protectedvirtualslot

virtual bool makVrv::DtQtPagePanel::eventFilter	(	QObject *	obj,
		QEvent *	ev
	)

protectedvirtual

Event filter to check for various actions that happen on the panel (move and resize)

virtual void makVrv::DtQtPagePanel::setContainer ( QWidget * cont )

protectedvirtual

Override default container set, to allow for hooking up to the visibility signal.

Reimplemented from makVrv::DtDockable.

virtual void makVrv::DtQtPagePanel::changeVisibility ( bool newVisibility )

protectedvirtual

Implementation of the visibility change of the widget.

Implements makVrv::DtPageCollection.

virtual void makVrv::DtQtPagePanel::changeLocation ( DtPageConfiguration::PageCollectionLocation location )

protectedvirtual

Implementation of changing the location of the collection.

Implements makVrv::DtPageCollection.

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

protectedvirtual

Implement changing the floating geometry of the collection.

Implements makVrv::DtPageCollection.

virtual void makVrv::DtQtPagePanel::changeFloatingGeometry ( DtPageConfiguration::PageCollectionGeometry geometry )

protectedvirtual

Implement changing the floating geometry of the collection.

Implements makVrv::DtPageCollection.

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

protectedvirtual

Implement changing the docked geometry of the collection.

Implements makVrv::DtPageCollection.

virtual void makVrv::DtQtPagePanel::changeDockedGeometry ( DtPageConfiguration::PageCollectionGeometry geometry )

protectedvirtual

Implement changing the docked geometry of the collection.

Implements makVrv::DtPageCollection.

virtual void makVrv::DtQtPagePanel::addPageToGui ( DtPage * page )

protectedvirtual

Implementation of adding the page to the GUI.

Implements makVrv::DtQtPageCollection.

virtual void makVrv::DtQtPagePanel::removePageFromGui ( DtPage * page )

protectedvirtual

Implementation of removing a page from the GUI.

Implements makVrv::DtQtPageCollection.

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

protectedvirtual

Implementation of selecting a page in the GUI.

Implements makVrv::DtQtPageCollection.

Member Data Documentation

DtPage* makVrv::DtQtPagePanel::myActivePage

protected

QTabBar* makVrv::DtQtPagePanel::myQTabBar

protected

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

include/vrvCoreQt/DtQtPagePanel.h

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation