ViewPluginDockWidget Class Reference

#include <ViewPluginDockWidget.h>

Inheritance diagram for ViewPluginDockWidget:

Public Member Functions
	ViewPluginDockWidget (const QString &title="", QWidget *parent=nullptr)
	ViewPluginDockWidget (const QString &title, hdps::plugin::ViewPlugin *viewPlugin, QWidget *parent=nullptr)
	ViewPluginDockWidget (const QVariantMap &variantMap)
	~ViewPluginDockWidget ()
QString	getTypeString () const override
void	initialize () override
void	loadViewPlugin ()
hdps::plugin::ViewPlugin *	getViewPlugin ()
void	restoreViewPluginState ()
QMenu *	getSettingsMenu () override
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
void	cacheVisibility ()
void	restoreVisibility ()
Public Member Functions inherited from DockWidget
	DockWidget (const QString &title, QWidget *parent=nullptr)
	~DockWidget ()
void	showEvent (QShowEvent *showEvent) override
void	setWidget (QWidget *widget, eInsertMode insertMode=AutoScrollArea)
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

Static Public Member Functions
static void	restoreViewPluginStates ()
Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

Static Protected Attributes
static QList< ViewPluginDockWidget * >	active = QList<ViewPluginDockWidget*>()

Friends
class	ViewPluginsDockWidget
class	WorkspaceManager

Additional Inherited Members
Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }
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

View plugin dock widget class

Dock widget which shows the contents of an HDPS view plugin.

Author

Thomas Kroes

Constructor & Destructor Documentation

ViewPluginDockWidget() [1/3]

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

Construct view plugin dock from title and parent widget

Parameters

title	Title of the dock widget
parent	Pointer to parent widget

ViewPluginDockWidget() [2/3]

ViewPluginDockWidget::ViewPluginDockWidget	(	const QString &	title,
		hdps::plugin::ViewPlugin *	viewPlugin,
		QWidget *	parent = nullptr
	)

Construct view plugin dock from title, viewPlugin and parent widget

Parameters

title	Title of the dock widget
viewPlugin	Pointer to view plugin
parent	Pointer to parent widget

ViewPluginDockWidget() [3/3]

ViewPluginDockWidget::ViewPluginDockWidget

(

const QVariantMap &

variantMap

)

Construct view plugin dock from variantMap

Parameters

variantMap

View plugin variant map

~ViewPluginDockWidget()

ViewPluginDockWidget::~ViewPluginDockWidget

(

)

Destructor (needed to update the active dock widgets)

Member Function Documentation

cacheVisibility()

void ViewPluginDockWidget::cacheVisibility

(

)

Caches the visibility

fromVariantMap()

void ViewPluginDockWidget::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load view plugin dock widget from variant

Parameters

Variant

representation of the view plugin dock widget

Reimplemented from DockWidget.

getSettingsMenu()

QMenu * ViewPluginDockWidget::getSettingsMenu ( )

overridevirtual

Get settings menu for view plugin dock widget (edit view, create screenshot etc.)

Returns

Pointer to settings menu

Reimplemented from DockWidget.

getTypeString()

QString ViewPluginDockWidget::getTypeString ( ) const

overridevirtual

Get string that describes the dock widget type

Returns

Type string

Reimplemented from DockWidget.

getViewPlugin()

ViewPlugin * ViewPluginDockWidget::getViewPlugin

(

)

Get the view plugin

Returns

Pointer to view plugin (might be nullptr)

initialize()

void ViewPluginDockWidget::initialize ( )

overridevirtual

Performs custom view plugin dock widget initialization

Reimplemented from DockWidget.

loadViewPlugin()

void ViewPluginDockWidget::loadViewPlugin

(

)

Load view plugin

restoreViewPluginState()

void ViewPluginDockWidget::restoreViewPluginState

(

)

Restores the view plugin state

restoreViewPluginStates()

void ViewPluginDockWidget::restoreViewPluginStates ( )

static

Restores the view plugin states of all active view plugins

restoreVisibility()

void ViewPluginDockWidget::restoreVisibility

(

)

Restores the visibility

toVariantMap()

QVariantMap ViewPluginDockWidget::toVariantMap ( ) const

overridevirtual

Save view plugin dock widget to variant

Returns

Variant representation of the view plugin dock widget

Reimplemented from DockWidget.

Friends And Related Symbol Documentation

ViewPluginsDockWidget

friend class ViewPluginsDockWidget

friend

Loaded view plugin dock widgets

WorkspaceManager

friend class WorkspaceManager

friend

Member Data Documentation

active

QList< ViewPluginDockWidget * > ViewPluginDockWidget::active = QList<ViewPluginDockWidget*>()

staticprotected

Created dock widgets for settings actions

---

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

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