DockWidget Class Reference

#include <DockWidget.h>

Inheritance diagram for DockWidget:

Public Member Functions
	DockWidget (const QString &title, QWidget *parent=nullptr)
	~DockWidget ()
virtual QString	getTypeString () const
virtual void	initialize ()
void	showEvent (QShowEvent *showEvent) override
virtual QMenu *	getSettingsMenu ()
void	setWidget (QWidget *widget, eInsertMode insertMode=AutoScrollArea)
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

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 widget class

ADS dock widget class enhanced with:

• Serialization
• Ability to choose additional settings from tool button in tab bar

Author

Thomas Kroes

Constructor & Destructor Documentation

DockWidget()

DockWidget::DockWidget	(	const QString &	title,
		QWidget *	parent = nullptr
	)

Constructor

Parameters

title	Title of the dock widget
parent	Pointer to parent widget

~DockWidget()

DockWidget::~DockWidget

(

)

Destructor

Member Function Documentation

fromVariantMap()

void DockWidget::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load widget action from variant

Parameters

Variant

representation of the widget action

Reimplemented from hdps::util::Serializable.

Reimplemented in ViewPluginDockWidget.

getSettingsMenu()

QMenu * DockWidget::getSettingsMenu ( )

virtual

Get settings menu (when derived dock widgets return a valid menu, a tool button will in the tab bar that shows this menu)

Returns

Pointer to settings menu

Reimplemented in ViewPluginDockWidget.

getTypeString()

QString DockWidget::getTypeString ( ) const

virtual

Get string that describes the dock widget type

Returns

Type string

Reimplemented in CentralDockWidget, and ViewPluginDockWidget.

initialize()

virtual void DockWidget::initialize ( )

inlinevirtual

Performs custom dock widget initialization

Reimplemented in ViewPluginDockWidget.

setWidget()

void DockWidget::setWidget	(	QWidget *	widget,
		eInsertMode	insertMode = AutoScrollArea
	)

Override ADS dock widget

Parameters

widget	Pointer to widget
insertMode	Insert modus

showEvent()

void DockWidget::showEvent ( QShowEvent *  showEvent )

override

Invoked when the menu is shown

Parameters

showEvent

Pointer to the show event

toVariantMap()

QVariantMap DockWidget::toVariantMap ( ) const

overridevirtual

Save widget action to variant

Returns

Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

Reimplemented in ViewPluginDockWidget.

---

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

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