ads::CFloatingDockContainer Class Reference

#include <FloatingDockContainer.h>

Inheritance diagram for ads::CFloatingDockContainer:

Public Types
using	Super = tFloatingWidgetBase

Public Member Functions
	CFloatingDockContainer (CDockAreaWidget *DockArea)
	CFloatingDockContainer (CDockManager *DockManager)
	CFloatingDockContainer (CDockWidget *DockWidget)
CDockContainerWidget *	dockContainer () const
QList< CDockWidget * >	dockWidgets () const
bool	hasTopLevelDockWidget () const
bool	isClosable () const
CDockWidget *	topLevelDockWidget () const
virtual	~CFloatingDockContainer ()
Public Member Functions inherited from ads::IFloatingWidget
virtual	~IFloatingWidget ()=default

Protected Member Functions
virtual void	changeEvent (QEvent *event) override
virtual void	closeEvent (QCloseEvent *event) override
virtual void	finishDragging () override
virtual void	hideEvent (QHideEvent *event) override
void	initFloatingGeometry (const QPoint &DragStartMousePos, const QSize &Size)
void	moveFloating () override
bool	restoreState (CDockingStateReader &Stream, bool Testing)
virtual void	showEvent (QShowEvent *event) override
void	startDragging (const QPoint &DragStartMousePos, const QSize &Size, QWidget *MouseEventHandler)
virtual void	startFloating (const QPoint &DragStartMousePos, const QSize &Size, eDragState DragState, QWidget *MouseEventHandler) override
void	updateWindowTitle ()

Private Slots
void	onDockAreaCurrentChanged (int Index)
void	onDockAreasAddedOrRemoved ()

Private Attributes
FloatingDockContainerPrivate *	d
	private data (pimpl) More...

Friends
class	CDockAreaTabBar
class	CDockAreaTitleBar
class	CDockAreaWidget
class	CDockManager
class	CDockWidget
class	CDockWidgetTab
class	CFloatingWidgetTitleBar
struct	DockAreaTitleBarPrivate
struct	DockManagerPrivate
struct	DockWidgetTabPrivate
struct	FloatingDockContainerPrivate

Detailed Description

This implements a floating widget that is a dock container that accepts docking of dock widgets like the main window and that can be docked into another dock container. Every floating window of the docking system is a FloatingDockContainer.

Definition at line 104 of file FloatingDockContainer.h.

Member Typedef Documentation

Super

using ads::CFloatingDockContainer::Super = tFloatingWidgetBase

Definition at line 202 of file FloatingDockContainer.h.

Constructor & Destructor Documentation

CFloatingDockContainer() [1/3]

ads::CFloatingDockContainer::CFloatingDockContainer

(

CDockManager *

DockManager

)

Create empty floating widget - required for restore state

Definition at line 598 of file FloatingDockContainer.cpp.

CFloatingDockContainer() [2/3]

ads::CFloatingDockContainer::CFloatingDockContainer

(

CDockAreaWidget *

DockArea

)

Create floating widget with the given dock area

Definition at line 670 of file FloatingDockContainer.cpp.

CFloatingDockContainer() [3/3]

ads::CFloatingDockContainer::CFloatingDockContainer

(

CDockWidget *

DockWidget

)

Create floating widget with the given dock widget

Definition at line 685 of file FloatingDockContainer.cpp.

~CFloatingDockContainer()

ads::CFloatingDockContainer::~CFloatingDockContainer ( )

virtual

Virtual Destructor

Definition at line 699 of file FloatingDockContainer.cpp.

Member Function Documentation

changeEvent()

void ads::CFloatingDockContainer::changeEvent ( QEvent *  event )

overrideprotectedvirtual

Definition at line 716 of file FloatingDockContainer.cpp.

closeEvent()

void ads::CFloatingDockContainer::closeEvent ( QCloseEvent *  event )

overrideprotectedvirtual

Definition at line 795 of file FloatingDockContainer.cpp.

dockContainer()

CDockContainerWidget * ads::CFloatingDockContainer::dockContainer

(

)

const

Access function for the internal dock container

Definition at line 710 of file FloatingDockContainer.cpp.

dockWidgets()

QList< CDockWidget * > ads::CFloatingDockContainer::dockWidgets

(

)

const

This function returns a list of all dock widget in this floating widget. This is a simple convenience function that simply calls the dockWidgets() function of the internal container widget.

Definition at line 1029 of file FloatingDockContainer.cpp.

finishDragging()

void ads::CFloatingDockContainer::finishDragging ( )

overrideprotectedvirtual

Call this function if you explicitly want to signal that dragging has finished

Implements ads::IFloatingWidget.

Definition at line 1035 of file FloatingDockContainer.cpp.

hasTopLevelDockWidget()

bool ads::CFloatingDockContainer::hasTopLevelDockWidget

(

)

const

This function returns true, if this floating widget has only one single visible dock widget in a single visible dock area. The single dock widget is a real top level floating widget because no other widgets are docked.

Definition at line 1017 of file FloatingDockContainer.cpp.

hideEvent()

void ads::CFloatingDockContainer::hideEvent ( QHideEvent *  event )

overrideprotectedvirtual

Definition at line 826 of file FloatingDockContainer.cpp.

initFloatingGeometry()

void ads::CFloatingDockContainer::initFloatingGeometry ( const QPoint &  DragStartMousePos, const QSize &  Size  )

inlineprotected

Call this function if you just want to initialize the position and size of the floating widget

Definition at line 153 of file FloatingDockContainer.h.

isClosable()

bool ads::CFloatingDockContainer::isClosable

(

)

const

This function returns true, if it can be closed. It can be closed, if all dock widgets in all dock areas can be closed

Definition at line 930 of file FloatingDockContainer.cpp.

moveFloating()

void ads::CFloatingDockContainer::moveFloating ( )

overrideprotectedvirtual

Moves the widget to a new position relative to the position given when startFloating() was called

Implements ads::IFloatingWidget.

Definition at line 901 of file FloatingDockContainer.cpp.

onDockAreaCurrentChanged

void ads::CFloatingDockContainer::onDockAreaCurrentChanged ( int  Index )

privateslot

Definition at line 990 of file FloatingDockContainer.cpp.

onDockAreasAddedOrRemoved

void ads::CFloatingDockContainer::onDockAreasAddedOrRemoved ( )

privateslot

Definition at line 937 of file FloatingDockContainer.cpp.

restoreState()

bool ads::CFloatingDockContainer::restoreState ( CDockingStateReader &  Stream, bool  Testing  )

protected

Restores the state from given stream. If Testing is true, the function only parses the data from the given stream but does not restore anything. You can use this check for faulty files before you start restoring the state

Definition at line 998 of file FloatingDockContainer.cpp.

showEvent()

void ads::CFloatingDockContainer::showEvent ( QShowEvent *  event )

overrideprotectedvirtual

Definition at line 853 of file FloatingDockContainer.cpp.

startDragging()

void ads::CFloatingDockContainer::startDragging ( const QPoint &  DragStartMousePos, const QSize &  Size, QWidget *  MouseEventHandler  )

inlineprotected

Call this function to start dragging the floating widget

Definition at line 137 of file FloatingDockContainer.h.

startFloating()

void ads::CFloatingDockContainer::startFloating ( const QPoint &  DragStartMousePos, const QSize &  Size, eDragState  DragState, QWidget *  MouseEventHandler  )

overrideprotectedvirtual

Starts floating at the given global position. Use moveToGlobalPos() to move the widget to a new position depending on the start position given in Pos parameter

Implements ads::IFloatingWidget.

Definition at line 866 of file FloatingDockContainer.cpp.

topLevelDockWidget()

CDockWidget * ads::CFloatingDockContainer::topLevelDockWidget

(

)

const

This function returns the first dock widget in the first dock area. If the function hasSingleDockWidget() returns true, then this function returns this single dock widget.

Definition at line 1023 of file FloatingDockContainer.cpp.

updateWindowTitle()

void ads::CFloatingDockContainer::updateWindowTitle ( )

protected

Call this function to update the window title

Definition at line 963 of file FloatingDockContainer.cpp.

Friends And Related Function Documentation

CDockAreaTabBar

friend class CDockAreaTabBar

friend

Definition at line 112 of file FloatingDockContainer.h.

CDockAreaTitleBar

friend class CDockAreaTitleBar

friend

Definition at line 115 of file FloatingDockContainer.h.

CDockAreaWidget

friend class CDockAreaWidget

friend

Definition at line 118 of file FloatingDockContainer.h.

CDockManager

friend class CDockManager

friend

Definition at line 110 of file FloatingDockContainer.h.

CDockWidget

friend class CDockWidget

friend

Definition at line 117 of file FloatingDockContainer.h.

CDockWidgetTab

friend class CDockWidgetTab

friend

Definition at line 114 of file FloatingDockContainer.h.

CFloatingWidgetTitleBar

friend class CFloatingWidgetTitleBar

friend

Definition at line 119 of file FloatingDockContainer.h.

DockAreaTitleBarPrivate

friend struct DockAreaTitleBarPrivate

friend

Definition at line 116 of file FloatingDockContainer.h.

DockManagerPrivate

friend struct DockManagerPrivate

friend

Definition at line 111 of file FloatingDockContainer.h.

DockWidgetTabPrivate

friend struct DockWidgetTabPrivate

friend

Definition at line 113 of file FloatingDockContainer.h.

FloatingDockContainerPrivate

friend struct FloatingDockContainerPrivate

friend

Definition at line 109 of file FloatingDockContainer.h.

Member Data Documentation

d

FloatingDockContainerPrivate* ads::CFloatingDockContainer::d

private

private data (pimpl)

Definition at line 108 of file FloatingDockContainer.h.

---

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

• FloatingDockContainer.h
• FloatingDockContainer.cpp