hdps::WorkspaceManager Class Reference

#include <WorkspaceManager.h>

Inheritance diagram for hdps::WorkspaceManager:

Public Types
enum	ViewMenuOption { LoadSystemViewPlugins = 0x00001 , LoadViewPlugins = 0x00002 , LoadedViewsSubMenu = 0x00004 , Default = LoadSystemViewPlugins | LoadViewPlugins | LoadedViewsSubMenu }
Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }

Public Member Functions
	WorkspaceManager ()
void	initialize () override
void	reset () override
QIcon	getIcon () const override
void	addViewPlugin (plugin::ViewPlugin *viewPlugin, plugin::ViewPlugin *dockToViewPlugin=nullptr, gui::DockAreaFlag dockArea=gui::DockAreaFlag::Right) override
void	isolateViewPlugin (plugin::ViewPlugin *viewPlugin, bool isolate) override
QWidget *	getWidget () override
void	setViewPluginDockWidgetPermissionsGlobally (const util::DockWidgetPermissions &dockWidgetPermissions=util::DockWidgetPermission::All, bool set=true) override
bool	mayLock () const override
bool	mayUnlock () const override
void	newWorkspace () override
void	loadWorkspace (QString filePath="", bool addToRecentWorkspaces=true) override
void	importWorkspaceFromProjectFile (QString projectFilePath="", bool addToRecentWorkspaces=true) override
void	saveWorkspace (QString filePath="", bool addToRecentWorkspaces=true) override
void	saveWorkspaceAs () override
bool	hasWorkspace () const override
const Workspace *	getCurrentWorkspace () const override
Workspace *	getCurrentWorkspace () override
WorkspaceLocations	getWorkspaceLocations (const WorkspaceLocation::Types &types=WorkspaceLocation::Type::All) override
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
QMenu *	getMenu (QWidget *parent=nullptr)
gui::TriggerAction &	getEditWorkspaceSettingsAction ()
Public Member Functions inherited from hdps::AbstractWorkspaceManager
	AbstractWorkspaceManager (QObject *parent=nullptr)
virtual QString	getWorkspaceFilePath () const final
virtual void	setWorkspaceFilePath (const QString &filePath) final
virtual void	beginLoadWorkspace () final
virtual void	endLoadWorkspace () final
virtual void	beginSaveWorkspace () final
virtual void	endSaveWorkspace () final
Public Member Functions inherited from hdps::AbstractManager
	AbstractManager (QObject *parent=nullptr, const QString &name="")
virtual void	beginReset () final
virtual void	endReset () final
virtual void	beginInitialization () final
virtual void	endInitialization () final
virtual bool	isInitialized () const final
gui::LockingAction &	getLockingAction ()
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
Signals inherited from hdps::AbstractWorkspaceManager
void	workspaceAboutToBeCreated ()
void	workspaceCreated (const hdps::Workspace &workspace)
void	workspaceAboutToBeLoaded (const QString &filePath)
void	workspaceLoaded (const QString &filePath)
void	workspaceAboutToBeSaved (const QString &filePath)
void	workspaceSaved (const QString &filePath)
void	workspaceFilePathChanged (const QString &filePath)
Signals inherited from hdps::AbstractManager
void	managerAboutToBeInitialized ()
void	managerInitialized ()
void	managerAboutToBeReset ()
void	managerReset ()
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

Workspace manager class

Manages the placement of view plugins on the screen using the Advanced Dock System (ADS) for Qt

It distinguishes between built-in (system) view plugins (data hierarchy, data properties etc.) and other view plugins (scatter plot, image viewer etc.).

It has a central area where non-system view plugins are docked, and areas around it (left, right, top and bottom) where system view plugins are docked.

It uses two ADS dock managers:

• One for the main layout (_dockManager)
• One for the docking of non-system view plugins in the central area dock widget (_viewPluginsDockManager)

Author

Thomas Kroes

Member Enumeration Documentation

ViewMenuOption

enum hdps::WorkspaceManager::ViewMenuOption

View menu options

Enumerator
LoadSystemViewPlugins
LoadViewPlugins	Show menu for loading system views
LoadedViewsSubMenu	Show menu for loading views
Default	Show menu for toggling loaded views visibility

Constructor & Destructor Documentation

WorkspaceManager()

hdps::WorkspaceManager::WorkspaceManager

(

)

Default constructor

Member Function Documentation

addViewPlugin()

void hdps::WorkspaceManager::addViewPlugin ( plugin::ViewPlugin *  viewPlugin, plugin::ViewPlugin *  dockToViewPlugin = nullptr, gui::DockAreaFlag  dockArea = gui::DockAreaFlag::Right  )

overridevirtual

Add a view plugin to the dockArea of dockViewPlugin

Parameters

viewPlugin	Pointer to view plugin to add to layout
dockToViewPlugin	Pointer to view plugin to which the view plugin will be docked (docked top-level if nullptr)
dockArea	Dock area in which dockToViewPlugin will be docked

Implements hdps::AbstractWorkspaceManager.

fromVariantMap()

void hdps::WorkspaceManager::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load layout from variant

Parameters

Variant

representation of the layout

Reimplemented from hdps::util::Serializable.

getCurrentWorkspace() [1/2]

const Workspace * hdps::WorkspaceManager::getCurrentWorkspace ( ) const

overridevirtual

Get current workspace

Returns

Pointer to current workspace (nullptr if no workspace is loaded)

Implements hdps::AbstractWorkspaceManager.

getCurrentWorkspace() [2/2]

Workspace * hdps::WorkspaceManager::getCurrentWorkspace ( )

overridevirtual

Get current workspace

Returns

Pointer to current workspace (nullptr if no workspace is loaded)

Implements hdps::AbstractWorkspaceManager.

getEditWorkspaceSettingsAction()

gui::TriggerAction & hdps::WorkspaceManager::getEditWorkspaceSettingsAction ( )

inline

getIcon()

QIcon hdps::WorkspaceManager::getIcon ( ) const

overridevirtual

Get manager icon

Returns

Icon

Reimplemented from hdps::AbstractManager.

getMenu()

QMenu * hdps::WorkspaceManager::getMenu ( QWidget *  parent = nullptr )

virtual

Get workspace menu

Parameters

menu	Pointer to parent menu

Returns

Pointer to created menu

Implements hdps::AbstractWorkspaceManager.

getWidget()

QWidget * hdps::WorkspaceManager::getWidget ( )

overridevirtual

Get workspace widget

Returns

Pointer to workspace widget

Implements hdps::AbstractWorkspaceManager.

getWorkspaceLocations()

WorkspaceLocations hdps::WorkspaceManager::getWorkspaceLocations ( const WorkspaceLocation::Types &  types = WorkspaceLocation::Type::All )

overridevirtual

Get workspace locations for location types

Returns

List of workspace locations

Implements hdps::AbstractWorkspaceManager.

hasWorkspace()

bool hdps::WorkspaceManager::hasWorkspace ( ) const

overridevirtual

Get whether a workspace exists

Returns

Boolean determining whether a workspace exists

Implements hdps::AbstractWorkspaceManager.

importWorkspaceFromProjectFile()

void hdps::WorkspaceManager::importWorkspaceFromProjectFile ( QString  projectFilePath = "", bool  addToRecentWorkspaces = true  )

overridevirtual

Import a workspace from a project file

Parameters

projectFilePath	File path of the project (choose file path with dialog when empty)
addToRecentWorkspaces	Whether to add the workspace file path to the recent workspace file paths

Implements hdps::AbstractWorkspaceManager.

initialize()

void hdps::WorkspaceManager::initialize ( )

overridevirtual

Perform manager startup initialization

Reimplemented from hdps::AbstractManager.

isolateViewPlugin()

void hdps::WorkspaceManager::isolateViewPlugin ( plugin::ViewPlugin *  viewPlugin, bool  isolate  )

overridevirtual

Set whether viewPlugin is isolated or not (closes all other view plugins when isolated)

Parameters

viewPlugin	Pointer to view plugin to add to layout
isolate	Whether to isolate viewPlugin or to reset the view layout prior to isolation

Implements hdps::AbstractWorkspaceManager.

loadWorkspace()

void hdps::WorkspaceManager::loadWorkspace ( QString  filePath = "", bool  addToRecentWorkspaces = true  )

overridevirtual

Load a workspace from disk

Parameters

filePath	File path of the workspace (choose file path with dialog when empty)
addToRecentWorkspaces	Whether to add the workspace file path to the recent workspace file paths

Implements hdps::AbstractWorkspaceManager.

mayLock()

bool hdps::WorkspaceManager::mayLock ( ) const

overridevirtual

Get whether the manager be locked

Returns

Boolean determining whether the manager be locked

Reimplemented from hdps::AbstractManager.

mayUnlock()

bool hdps::WorkspaceManager::mayUnlock ( ) const

overridevirtual

Get whether the manager be unlocked

Returns

Boolean determining whether the manager be unlocked

Reimplemented from hdps::AbstractManager.

newWorkspace()

void hdps::WorkspaceManager::newWorkspace ( )

overridevirtual

Creates a new workspace

Implements hdps::AbstractWorkspaceManager.

reset()

void hdps::WorkspaceManager::reset ( )

overridevirtual

Resets the contents of the workspace manager

Implements hdps::AbstractManager.

saveWorkspace()

void hdps::WorkspaceManager::saveWorkspace ( QString  filePath = "", bool  addToRecentWorkspaces = true  )

overridevirtual

Save a workspace to disk

Parameters

filePath	File path of the workspace (choose file path with dialog when empty)
addToRecentWorkspaces	Whether to add the workspace file path to the recent workspace file paths

Implements hdps::AbstractWorkspaceManager.

saveWorkspaceAs()

void hdps::WorkspaceManager::saveWorkspaceAs ( )

overridevirtual

Save a workspace to disk on a different location

Implements hdps::AbstractWorkspaceManager.

setViewPluginDockWidgetPermissionsGlobally()

void hdps::WorkspaceManager::setViewPluginDockWidgetPermissionsGlobally ( const util::DockWidgetPermissions &  dockWidgetPermissions = util::DockWidgetPermission::All, bool  set = true  )

overridevirtual

Freeze all dock widgets with dockWidgetPermissions

Parameters

dockWidgetPermissions	Global dock widget permission flags
set	Whether to set or unset the dock widget permission flags

Implements hdps::AbstractWorkspaceManager.

toVariantMap()

QVariantMap hdps::WorkspaceManager::toVariantMap ( ) const

overridevirtual

Save layout to variant

Returns

Variant representation of the layout

Reimplemented from hdps::util::Serializable.

---

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

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