ads::DockContainerWidgetPrivate Class Reference

Public Member Functions
void	addDockArea (CDockAreaWidget *NewDockWidget, DockWidgetArea area=CenterDockWidgetArea)
void	addDockAreasToList (const QList< CDockAreaWidget * > NewDockAreas)
CDockAreaWidget *	addDockWidgetToContainer (DockWidgetArea area, CDockWidget *Dockwidget)
CDockAreaWidget *	addDockWidgetToDockArea (DockWidgetArea area, CDockWidget *Dockwidget, CDockAreaWidget *TargetDockArea)
void	adjustSplitterSizesOnInsertion (QSplitter *Splitter, qreal LastRatio=1.0)
void	appendDockAreas (const QList< CDockAreaWidget * > NewDockAreas)
	DockContainerWidgetPrivate (CDockContainerWidget *_public)
void	dropIntoCenterOfSection (CFloatingDockContainer *FloatingWidget, CDockAreaWidget *TargetArea)
void	dropIntoContainer (CFloatingDockContainer *FloatingWidget, DockWidgetArea area)
void	dropIntoSection (CFloatingDockContainer *FloatingWidget, CDockAreaWidget *TargetArea, DockWidgetArea area)
void	dumpRecursive (int level, QWidget *widget)
void	emitDockAreasAdded ()
void	emitDockAreasRemoved ()
eDropMode	getDropMode (const QPoint &TargetPos)
void	initVisibleDockAreaCount ()
void	moveIntoCenterOfSection (QWidget *Widget, CDockAreaWidget *TargetArea)
void	moveToContainer (QWidget *Widgett, DockWidgetArea area)
void	moveToNewSection (QWidget *Widget, CDockAreaWidget *TargetArea, DockWidgetArea area)
CDockSplitter *	newSplitter (Qt::Orientation orientation, QWidget *parent=nullptr)
void	onDockAreaViewToggled (bool Visible)
void	onVisibleDockAreaCountChanged ()
bool	restoreChildNodes (CDockingStateReader &Stream, QWidget *&CreatedWidget, bool Testing)
bool	restoreDockArea (CDockingStateReader &Stream, QWidget *&CreatedWidget, bool Testing)
bool	restoreSplitter (CDockingStateReader &Stream, QWidget *&CreatedWidget, bool Testing)
void	saveChildNodesState (QXmlStreamWriter &Stream, QWidget *Widget)
void	updateSplitterHandles (QSplitter *splitter)
int &	visibleDockAreaCount ()
bool	widgetResizesWithContainer (QWidget *widget)

Public Attributes
CDockContainerWidget *	_this
QList< CDockAreaWidget * >	DockAreas
QPointer< CDockManager >	DockManager
bool	isFloating = false
CDockAreaWidget *	LastAddedAreaCache [5]
QGridLayout *	Layout = nullptr
QSplitter *	RootSplitter = nullptr
CDockAreaWidget *	TopLevelDockArea = nullptr
int	VisibleDockAreaCount = -1
unsigned int	zOrderIndex = 0

Detailed Description

Private data class of CDockContainerWidget class (pimpl)

Definition at line 127 of file DockContainerWidget.cpp.

Constructor & Destructor Documentation

DockContainerWidgetPrivate()

ads::DockContainerWidgetPrivate::DockContainerWidgetPrivate

(

CDockContainerWidget *

_public

)

Private data constructor

Definition at line 350 of file DockContainerWidget.cpp.

Member Function Documentation

addDockArea()

void ads::DockContainerWidgetPrivate::addDockArea	(	CDockAreaWidget *	NewDockWidget,
		DockWidgetArea	area = CenterDockWidgetArea
	)

Add dock area to this container

Definition at line 1127 of file DockContainerWidget.cpp.

addDockAreasToList()

void ads::DockContainerWidgetPrivate::addDockAreasToList

(

const QList< CDockAreaWidget * >

NewDockAreas

)

Adds new dock areas to the internal dock area list

Definition at line 798 of file DockContainerWidget.cpp.

addDockWidgetToContainer()

CDockAreaWidget * ads::DockContainerWidgetPrivate::addDockWidgetToContainer	(	DockWidgetArea	area,
		CDockWidget *	Dockwidget
	)

Adds dock widget to container and returns the dock area that contains the inserted dock widget

Definition at line 1114 of file DockContainerWidget.cpp.

addDockWidgetToDockArea()

CDockAreaWidget * ads::DockContainerWidgetPrivate::addDockWidgetToDockArea	(	DockWidgetArea	area,
		CDockWidget *	Dockwidget,
		CDockAreaWidget *	TargetDockArea
	)

Adds dock widget to a existing DockWidgetArea

Definition at line 1230 of file DockContainerWidget.cpp.

adjustSplitterSizesOnInsertion()

void ads::DockContainerWidgetPrivate::adjustSplitterSizesOnInsertion ( QSplitter *  Splitter, qreal  LastRatio = 1.0  )

inline

Ensures equal distribution of the sizes of a splitter if an dock widget is inserted from code

Definition at line 311 of file DockContainerWidget.cpp.

appendDockAreas()

void ads::DockContainerWidgetPrivate::appendDockAreas

(

const QList< CDockAreaWidget * >

NewDockAreas

)

Wrapper function for DockAreas append, that ensures that dock area signals are properly connected to dock container slots

Definition at line 829 of file DockContainerWidget.cpp.

dropIntoCenterOfSection()

void ads::DockContainerWidgetPrivate::dropIntoCenterOfSection	(	CFloatingDockContainer *	FloatingWidget,
		CDockAreaWidget *	TargetArea
	)

Creates a new tab for a widget dropped into the center of a section

Definition at line 477 of file DockContainerWidget.cpp.

dropIntoContainer()

void ads::DockContainerWidgetPrivate::dropIntoContainer	(	CFloatingDockContainer *	FloatingWidget,
		DockWidgetArea	area
	)

Drop floating widget into container

Definition at line 418 of file DockContainerWidget.cpp.

dropIntoSection()

void ads::DockContainerWidgetPrivate::dropIntoSection	(	CFloatingDockContainer *	FloatingWidget,
		CDockAreaWidget *	TargetArea,
		DockWidgetArea	area
	)

Drop floating widget into dock area

Definition at line 512 of file DockContainerWidget.cpp.

dumpRecursive()

void ads::DockContainerWidgetPrivate::dumpRecursive	(	int	level,
		QWidget *	widget
	)

Helper function for recursive dumping of layout

Definition at line 1174 of file DockContainerWidget.cpp.

emitDockAreasAdded()

void ads::DockContainerWidgetPrivate::emitDockAreasAdded ( )

inline

Definition at line 290 of file DockContainerWidget.cpp.

emitDockAreasRemoved()

void ads::DockContainerWidgetPrivate::emitDockAreasRemoved ( )

inline

Definition at line 284 of file DockContainerWidget.cpp.

getDropMode()

eDropMode ads::DockContainerWidgetPrivate::getDropMode

(

const QPoint &

TargetPos

)

Calculate the drop mode from the given target position

Definition at line 358 of file DockContainerWidget.cpp.

initVisibleDockAreaCount()

void ads::DockContainerWidgetPrivate::initVisibleDockAreaCount ( )

inline

Initializes the visible dock area count variable if it is not initialized yet

Definition at line 253 of file DockContainerWidget.cpp.

moveIntoCenterOfSection()

void ads::DockContainerWidgetPrivate::moveIntoCenterOfSection	(	QWidget *	Widget,
		CDockAreaWidget *	TargetArea
	)

Creates a new tab for a widget dropped into the center of a section

Definition at line 611 of file DockContainerWidget.cpp.

moveToContainer()

void ads::DockContainerWidgetPrivate::moveToContainer	(	QWidget *	Widgett,
		DockWidgetArea	area
	)

Moves the dock widget or dock area given in Widget parameter to a a dock area in container

Definition at line 753 of file DockContainerWidget.cpp.

moveToNewSection()

void ads::DockContainerWidgetPrivate::moveToNewSection	(	QWidget *	Widget,
		CDockAreaWidget *	TargetArea,
		DockWidgetArea	area
	)

Moves the dock widget or dock area given in Widget parameter to a new dock widget area

Definition at line 650 of file DockContainerWidget.cpp.

newSplitter()

CDockSplitter* ads::DockContainerWidgetPrivate::newSplitter ( Qt::Orientation  orientation, QWidget *  parent = nullptr  )

inline

Helper function for creation of new splitter

Definition at line 299 of file DockContainerWidget.cpp.

onDockAreaViewToggled()

void ads::DockContainerWidgetPrivate::onDockAreaViewToggled ( bool  Visible )

inline

Definition at line 339 of file DockContainerWidget.cpp.

onVisibleDockAreaCountChanged()

void ads::DockContainerWidgetPrivate::onVisibleDockAreaCountChanged

(

)

The visible dock area count changes, if dock areas are remove, added or when its view is toggled

Definition at line 398 of file DockContainerWidget.cpp.

restoreChildNodes()

bool ads::DockContainerWidgetPrivate::restoreChildNodes	(	CDockingStateReader &	Stream,
		QWidget *&	CreatedWidget,
		bool	Testing
	)

Restore state of child nodes.

Parameters

[in]	Stream	The data stream that contains the serialized state
[out]	CreatedWidget	The widget created from parsed data or 0 if the parsed widget was an empty splitter
[in]	Testing	If Testing is true, only the stream data is parsed without modifiying anything.

Definition at line 1086 of file DockContainerWidget.cpp.

restoreDockArea()

bool ads::DockContainerWidgetPrivate::restoreDockArea	(	CDockingStateReader &	Stream,
		QWidget *&	CreatedWidget,
		bool	Testing
	)

Restores a dock area.

See also

restoreChildNodes() for details

Definition at line 994 of file DockContainerWidget.cpp.

restoreSplitter()

bool ads::DockContainerWidgetPrivate::restoreSplitter	(	CDockingStateReader &	Stream,
		QWidget *&	CreatedWidget,
		bool	Testing
	)

Restores a splitter.

See also

restoreChildNodes() for details

Definition at line 878 of file DockContainerWidget.cpp.

saveChildNodesState()

void ads::DockContainerWidgetPrivate::saveChildNodesState	(	QXmlStreamWriter &	Stream,
		QWidget *	Widget
	)

Save state of child nodes

Definition at line 843 of file DockContainerWidget.cpp.

updateSplitterHandles()

void ads::DockContainerWidgetPrivate::updateSplitterHandles

(

QSplitter *

splitter

)

This function forces the dock container widget to update handles of splitters based if a central widget exists.

Definition at line 713 of file DockContainerWidget.cpp.

visibleDockAreaCount()

int& ads::DockContainerWidgetPrivate::visibleDockAreaCount ( )

inline

Access function for the visible dock area counter

Definition at line 270 of file DockContainerWidget.cpp.

widgetResizesWithContainer()

bool ads::DockContainerWidgetPrivate::widgetResizesWithContainer

(

QWidget *

widget

)

If no central widget exists, the widgets resize with the container. If a central widget exists, the widgets surrounding the central widget do not resize its height or width.

Definition at line 728 of file DockContainerWidget.cpp.

Member Data Documentation

_this

CDockContainerWidget* ads::DockContainerWidgetPrivate::_this

Definition at line 130 of file DockContainerWidget.cpp.

DockAreas

QList<CDockAreaWidget*> ads::DockContainerWidgetPrivate::DockAreas

Definition at line 133 of file DockContainerWidget.cpp.

DockManager

QPointer<CDockManager> ads::DockContainerWidgetPrivate::DockManager

Definition at line 131 of file DockContainerWidget.cpp.

isFloating

bool ads::DockContainerWidgetPrivate::isFloating = false

Definition at line 136 of file DockContainerWidget.cpp.

LastAddedAreaCache

CDockAreaWidget* ads::DockContainerWidgetPrivate::LastAddedAreaCache[5]

Definition at line 137 of file DockContainerWidget.cpp.

Layout

QGridLayout* ads::DockContainerWidgetPrivate::Layout = nullptr

Definition at line 134 of file DockContainerWidget.cpp.

RootSplitter

QSplitter* ads::DockContainerWidgetPrivate::RootSplitter = nullptr

Definition at line 135 of file DockContainerWidget.cpp.

TopLevelDockArea

CDockAreaWidget* ads::DockContainerWidgetPrivate::TopLevelDockArea = nullptr

Definition at line 139 of file DockContainerWidget.cpp.

VisibleDockAreaCount

int ads::DockContainerWidgetPrivate::VisibleDockAreaCount = -1

Definition at line 138 of file DockContainerWidget.cpp.

zOrderIndex

unsigned int ads::DockContainerWidgetPrivate::zOrderIndex = 0

Definition at line 132 of file DockContainerWidget.cpp.

---

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

• DockContainerWidget.cpp