DockManager Class Reference

#include <DockManager.h>

Inheritance diagram for DockManager:

Public Member Functions
	DockManager (QWidget *parent=nullptr)
	~DockManager ()
ViewPluginDockWidgets	getViewPluginDockWidgets ()
const ViewPluginDockWidgets	getViewPluginDockWidgets () const
ads::CDockAreaWidget *	findDockAreaWidget (hdps::plugin::ViewPlugin *viewPlugin)
void	removeViewPluginDockWidget (hdps::plugin::ViewPlugin *viewPlugin)
void	reset ()
void	addViewPluginDockWidget (ads::DockWidgetArea area, ads::CDockWidget *Dockwidget, ads::CDockAreaWidget *DockAreaWidget=nullptr)
void	removeViewPluginDockWidget (ads::CDockWidget *Dockwidget)
QWidget *	getWidget ()
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
Public Member Functions inherited from hdps::util::Serializable
	Serializable (const QString &serializationName="")
virtual QString	getId () const final
virtual void	setId (const QString &id) final
virtual QString	getSerializationName () const final
virtual void	setSerializationName (const QString &serializationName) final
virtual void	fromParentVariantMap (const QVariantMap &parentVariantMap)
virtual void	insertIntoVariantMap (QVariantMap &variantMap) const final
virtual void	fromJsonDocument (const QJsonDocument &jsonDocument) final
virtual QJsonDocument	toJsonDocument () const final
virtual void	fromJsonFile (const QString &filePath="") final
virtual void	toJsonFile (const QString &filePath="") final
virtual void	makeUnique () final

Friends
class	ViewPluginsDockWidget
class	QPointer< DockManager >

Additional Inherited Members
Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }
Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()
Static Protected Member Functions inherited from hdps::util::Serializable
static void	fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)
static void	fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)
static QVariantMap	toVariantMap (const Serializable *serializable)
static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)
static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)

Detailed Description

Dock manager class

ADS inherited dock manager class, primary purpose it to support layout serialization

inherits ADS dock manager as protected so add/remove of dock widgets has to pass through this class.

Author

Thomas Kroes

Constructor & Destructor Documentation

DockManager()

DockManager::DockManager

(

QWidget *

parent = nullptr

)

Constructs a dock manager derived from the advanced docking system

Parameters

parent

Pointer to parent widget

~DockManager()

DockManager::~DockManager

(

)

Destructor

Member Function Documentation

addViewPluginDockWidget()

void DockManager::addViewPluginDockWidget	(	ads::DockWidgetArea	area,
		ads::CDockWidget *	Dockwidget,
		ads::CDockAreaWidget *	DockAreaWidget = nullptr
	)

Adds a ViewPluginDockWidget

findDockAreaWidget()

ads::CDockAreaWidget * DockManager::findDockAreaWidget

(

hdps::plugin::ViewPlugin *

viewPlugin

)

Find the dock area widget where the widget of viewPlugin resides

Parameters

viewPlugin

Pointer to view plugin that holds the widget

Returns

Pointer to ADS dock widget area (if found, otherwise nullptr)

fromVariantMap()

void DockManager::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load from variant map

Parameters

variantMap

Variant map representation of the serializable object

Reimplemented from hdps::util::Serializable.

getViewPluginDockWidgets() [1/2]

ViewPluginDockWidgets DockManager::getViewPluginDockWidgets

(

)

Get view plugin dock widgets

Returns

Vector of pointers to plugin dock widgets

getViewPluginDockWidgets() [2/2]

const ViewPluginDockWidgets DockManager::getViewPluginDockWidgets

(

)

const

Get view plugin dock widgets

Returns

Vector of pointers to plugin dock widgets

getWidget()

QWidget * DockManager::getWidget

(

)

get as QWidget pointer

removeViewPluginDockWidget() [1/2]

void DockManager::removeViewPluginDockWidget

(

ads::CDockWidget *

Dockwidget

)

Removes a ViewPluginDockWidget

removeViewPluginDockWidget() [2/2]

void DockManager::removeViewPluginDockWidget

(

hdps::plugin::ViewPlugin *

viewPlugin

)

Remove viewPlugin from the dock manager

Parameters

viewPlugin

Pointer to the view plugin to remove

reset()

void DockManager::reset

(

)

Resets the docking layout to defaults

toVariantMap()

QVariantMap DockManager::toVariantMap ( ) const

overridevirtual

Save to variant map

Returns

Variant map representation of the serializable object

Reimplemented from hdps::util::Serializable.

Friends And Related Symbol Documentation

QPointer< DockManager >

friend class QPointer< DockManager >

friend

ViewPluginsDockWidget

friend class ViewPluginsDockWidget

friend

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/private/DockManager.h
• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/private/DockManager.cpp