makVrv::DtDockable Class Reference

The dockable class provides the docking interface for any class to be a dockable widget in the DtDeMainWindow.

Inheritance diagram for makVrv::DtDockable:

Public Member Functions
	DtDockable (DtDe &de, const std::string &className)
virtual	~DtDockable ()
const std::string &	className () const
void	dock (Qt::DockWidgetArea area)
virtual bool	isDocked () const
virtual void	setContainerVisible (bool visible)
virtual void	setContainerMovable (bool moveable)
virtual void	setContainerFloatable (bool floatable)
virtual void	setContainerClosable (bool closeable)
virtual bool	isContainerHidden () const
virtual bool	isContainerMovable () const
virtual bool	isContainerFloatable () const
virtual bool	isContainerClosable () const
virtual void	showContainer ()
virtual void	hideContainer ()
virtual void	floatContainer ()
virtual void	unfloatContainer ()
virtual void	removeContainer ()
virtual bool	initiallyVisible () const
virtual Qt::DockWidgetArea	initialDockWidgetLocation () const
virtual bool	containerTabbed () const
virtual int	containerTabIndex () const
virtual void	getContainerTabbedGeometry (int &x, int &y, int &width, int &height) const
virtual QWidget *	container ()
virtual void	setContainer (QWidget *cont)
virtual void	bringToTop ()
virtual void	setDockWidgetItem (DtDockWidgetItem *item)
virtual DtDockWidgetItem *	dockWidgetItem () const
virtual void	connectContainerToDockItem ()

Protected Member Functions
QTabBar *	tabBar () const

Protected Attributes
QWidget *	myContainer
std::string	myClassName
DtDe &	myDe
bool	myIsFloatable
bool	myIsClosable
bool	myIsMovable
DtDockWidgetItem *	myDockWidgetItem

Friends
class	DtDockWidgetItem

Constructor & Destructor Documentation

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 makVrv::DtDockable::~DtDockable ( )

virtual

DTOR.

Member Function Documentation

const std::string& makVrv::DtDockable::className

(

)

const

The class name.

void makVrv::DtDockable::dock

(

Qt::DockWidgetArea

area

)

Dock this dockable in the main window, this function should only be called once. Dock depends on a a subclass which extends both dock and QWidget.

virtual bool makVrv::DtDockable::isDocked ( ) const

virtual

Check to see if we are in a container.

virtual void makVrv::DtDockable::setContainerVisible ( bool  visible )

virtual

call either shows or hides container base upon the input.

virtual void makVrv::DtDockable::setContainerMovable ( bool  moveable )

virtual

Set whether the container is moveable.

virtual void makVrv::DtDockable::setContainerFloatable ( bool  floatable )

virtual

Set whether the container is floatable.

virtual void makVrv::DtDockable::setContainerClosable ( bool  closeable )

virtual

Set whether the container is closeable.

virtual bool makVrv::DtDockable::isContainerHidden ( ) const

virtual

Returns true if container is hidden.

virtual bool makVrv::DtDockable::isContainerMovable ( ) const

virtual

Returns true if container is moveable.

virtual bool makVrv::DtDockable::isContainerFloatable ( ) const

virtual

Returns true if container is floatable.

virtual bool makVrv::DtDockable::isContainerClosable ( ) const

virtual

Returns true if container is closeable.

virtual void makVrv::DtDockable::showContainer ( )

virtual

Show the container.

virtual void makVrv::DtDockable::hideContainer ( )

virtual

Hide the container.

virtual void makVrv::DtDockable::floatContainer ( )

virtual

Float the container.

virtual void makVrv::DtDockable::unfloatContainer ( )

virtual

Un float the container.

virtual void makVrv::DtDockable::removeContainer ( )

virtual

Untabs the container.

Reimplemented in makVrv::DtQtPagePanel.

virtual bool makVrv::DtDockable::initiallyVisible ( ) const

virtual

Virtual function needed for controlling if the widget is docked visible.

Reimplemented in makVrv::DtConsoleLogWidget.

virtual Qt::DockWidgetArea makVrv::DtDockable::initialDockWidgetLocation ( ) const

virtual

Virtual function needed for controlling if the widget is docked visible.

virtual bool makVrv::DtDockable::containerTabbed ( ) const

virtual

Tells whether the container is tabbed or not.

virtual int makVrv::DtDockable::containerTabIndex ( ) const

virtual

If the container is tabbed, returns the position of the container inside the tab structure. Returns -1 otherwise.

virtual void makVrv::DtDockable::getContainerTabbedGeometry ( int &  x, int &  y, int &  width, int &  height  ) const

virtual

Gets the geometry of the container if it is tabbed. Returns -1 in every one of the arguments otherwise.

virtual QWidget* makVrv::DtDockable::container ( )

virtual

Returns the QDockWidget or other container that holds this widget.

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

virtual

Set with the QDockWidget or other container that holds this widget.

Reimplemented in makVrv::DtQtPagePanel.

virtual void makVrv::DtDockable::bringToTop ( )

virtual

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

Reimplemented in makVrv::DtQtPagePanel.

virtual void makVrv::DtDockable::setDockWidgetItem ( DtDockWidgetItem *  item )

virtual

If this dockable is the target of a menu item, a pointer to to the associated menu item. Used during GUI restoration.

virtual DtDockWidgetItem* makVrv::DtDockable::dockWidgetItem ( ) const

virtual

Get the associated menu item, if any.

virtual void makVrv::DtDockable::connectContainerToDockItem ( )

virtual

The menu item create does this the first time, but we need to do it explicitly on GUI restores.

QTabBar* makVrv::DtDockable::tabBar ( ) const

protected

Returns the container tab bar object if myContainer is tabbed.

Friends And Related Function Documentation

friend class DtDockWidgetItem

friend

Member Data Documentation

QWidget* makVrv::DtDockable::myContainer

protected

my Container widget

std::string makVrv::DtDockable::myClassName

protected

DtDe& makVrv::DtDockable::myDe

protected

bool makVrv::DtDockable::myIsFloatable

protected

bool makVrv::DtDockable::myIsClosable

protected

bool makVrv::DtDockable::myIsMovable

protected

DtDockWidgetItem* makVrv::DtDockable::myDockWidgetItem

protected

---

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

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