hdps::AbstractWorkspaceManager Class Reference

#include <AbstractWorkspaceManager.h>

Inheritance diagram for hdps::AbstractWorkspaceManager:

Signals
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 ()

Public Member Functions
	AbstractWorkspaceManager (QObject *parent=nullptr)
virtual void	addViewPlugin (plugin::ViewPlugin *viewPlugin, plugin::ViewPlugin *dockToViewPlugin=nullptr, gui::DockAreaFlag dockArea=gui::DockAreaFlag::Right)=0
virtual void	isolateViewPlugin (plugin::ViewPlugin *viewPlugin, bool isolate)=0
virtual QWidget *	getWidget ()=0
virtual QMenu *	getMenu (QWidget *parent=nullptr)=0
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
virtual void	setViewPluginDockWidgetPermissionsGlobally (const util::DockWidgetPermissions &dockWidgetPermissions=util::DockWidgetPermission::All, bool set=true)=0
virtual void	newWorkspace ()=0
virtual void	loadWorkspace (QString filePath="", bool addToRecentWorkspaces=true)=0
virtual void	importWorkspaceFromProjectFile (QString filePath="", bool addToRecentWorkspaces=true)=0
virtual void	saveWorkspace (QString filePath="", bool addToRecentWorkspaces=true)=0
virtual void	saveWorkspaceAs ()=0
virtual bool	hasWorkspace () const =0
virtual const Workspace *	getCurrentWorkspace () const =0
virtual Workspace *	getCurrentWorkspace ()=0
virtual WorkspaceLocations	getWorkspaceLocations (const WorkspaceLocation::Types &types=WorkspaceLocation::Type::All)=0
Public Member Functions inherited from hdps::AbstractManager
	AbstractManager (QObject *parent=nullptr, const QString &name="")
virtual void	initialize ()
virtual void	beginReset () final
virtual void	reset ()=0
virtual void	endReset () final
virtual void	beginInitialization () final
virtual void	endInitialization () final
virtual bool	isInitialized () const final
virtual QIcon	getIcon () const
gui::LockingAction &	getLockingAction ()
virtual bool	mayLock () const
virtual bool	mayUnlock () const
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	fromVariantMap (const QVariantMap &variantMap)
virtual void	fromParentVariantMap (const QVariantMap &parentVariantMap)
virtual QVariantMap	toVariantMap () const
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

Abstract workspace manager class

Base abstract workspace manager class for managing workspaces and layout.

Author

Thomas Kroes

Constructor & Destructor Documentation

AbstractWorkspaceManager()

hdps::AbstractWorkspaceManager::AbstractWorkspaceManager ( QObject *  parent = nullptr )

inline

Construct workspace manager with parent object

Parameters

parent

Pointer to parent object

Member Function Documentation

addViewPlugin()

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

pure virtual

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 new view plugins are docked (new view plugins be docked top-level if nullptr)
dockArea	Dock area in which dockToViewPlugin will be docked

Implemented in hdps::WorkspaceManager.

beginLoadWorkspace()

virtual void hdps::AbstractWorkspaceManager::beginLoadWorkspace ( )

inlinefinalvirtual

Begin the workspace loading process

beginSaveWorkspace()

virtual void hdps::AbstractWorkspaceManager::beginSaveWorkspace ( )

inlinefinalvirtual

Begin the workspace saving process

endLoadWorkspace()

virtual void hdps::AbstractWorkspaceManager::endLoadWorkspace ( )

inlinefinalvirtual

End the workspace loading process

endSaveWorkspace()

virtual void hdps::AbstractWorkspaceManager::endSaveWorkspace ( )

inlinefinalvirtual

End the workspace saving process

getCurrentWorkspace() [1/2]

virtual const Workspace * hdps::AbstractWorkspaceManager::getCurrentWorkspace ( ) const

pure virtual

Get current workspace

Returns

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

Implemented in hdps::WorkspaceManager.

getCurrentWorkspace() [2/2]

virtual Workspace * hdps::AbstractWorkspaceManager::getCurrentWorkspace ( )

pure virtual

Get current workspace

Returns

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

Implemented in hdps::WorkspaceManager.

getMenu()

virtual QMenu * hdps::AbstractWorkspaceManager::getMenu ( QWidget *  parent = nullptr )

pure virtual

Get workspace menu

Parameters

menu	Pointer to parent menu

Returns

Pointer to created menu

Implemented in hdps::WorkspaceManager.

getWidget()

virtual QWidget * hdps::AbstractWorkspaceManager::getWidget ( )

pure virtual

Get workspace widget

Returns

Pointer to workspace widget

Implemented in hdps::WorkspaceManager.

getWorkspaceFilePath()

virtual QString hdps::AbstractWorkspaceManager::getWorkspaceFilePath ( ) const

inlinefinalvirtual

Get the file path of the loaded workspace

Returns

File path of the loaded workspace

getWorkspaceLocations()

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

pure virtual

Get workspace locations for location types

Returns

List of workspace locations

Implemented in hdps::WorkspaceManager.

hasWorkspace()

virtual bool hdps::AbstractWorkspaceManager::hasWorkspace ( ) const

pure virtual

Get whether a workspace exists

Returns

Boolean determining whether a workspace exists

Implemented in hdps::WorkspaceManager.

importWorkspaceFromProjectFile()

virtual void hdps::AbstractWorkspaceManager::importWorkspaceFromProjectFile ( QString  filePath = "", bool  addToRecentWorkspaces = true  )

pure virtual

Import a workspace from a project file

Parameters

filePath	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

Implemented in hdps::WorkspaceManager.

isolateViewPlugin()

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

pure virtual

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

Implemented in hdps::WorkspaceManager.

loadWorkspace()

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

pure virtual

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

Implemented in hdps::WorkspaceManager.

newWorkspace()

virtual void hdps::AbstractWorkspaceManager::newWorkspace ( )

pure virtual

Creates a new workspace

Implemented in hdps::WorkspaceManager.

saveWorkspace()

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

pure virtual

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

Implemented in hdps::WorkspaceManager.

saveWorkspaceAs()

virtual void hdps::AbstractWorkspaceManager::saveWorkspaceAs ( )

pure virtual

Save a workspace to disk on a different location

Implemented in hdps::WorkspaceManager.

setViewPluginDockWidgetPermissionsGlobally()

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

pure virtual

Applies the CSS stylesheet to the dock managers virtual void applyStyleSheet() final { QFile styleSheetFile(":/styles/ads_light.css");

styleSheetFile.open(QIODevice::ReadOnly);

QTextStream styleSheetStream(&styleSheetFile); auto stylesheet = styleSheetStream.readAll();

styleSheetFile.close();

_mainDockManager->setStyleSheet(stylesheet); auto dockManagers = findChildren<CDockManager*>();

for (auto dockManager : dockManagers) dockManager->setStyleSheet(stylesheet); } Set dockWidgetPermissions for all view plugin dock widgets

Parameters

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

Implemented in hdps::WorkspaceManager.

setWorkspaceFilePath()

virtual void hdps::AbstractWorkspaceManager::setWorkspaceFilePath ( const QString &  filePath )

inlinefinalvirtual

Set the file path of the loaded workspace

Parameters

filePath

File path of the loaded workspace

workspaceAboutToBeCreated

void hdps::AbstractWorkspaceManager::workspaceAboutToBeCreated ( )

signal

Signals that a new workspace is about to be created

workspaceAboutToBeLoaded

void hdps::AbstractWorkspaceManager::workspaceAboutToBeLoaded ( const QString &  filePath )

signal

Signals that a workspace is about to be loaded from filePath

Parameters

filePath

File path of the workspace

workspaceAboutToBeSaved

void hdps::AbstractWorkspaceManager::workspaceAboutToBeSaved ( const QString &  filePath )

signal

Signals that a workspace is about to be saved to filePath

Parameters

filePath

File path of the workspace

workspaceCreated

void hdps::AbstractWorkspaceManager::workspaceCreated ( const hdps::Workspace &  workspace )

signal

Signals that workspace is created

Parameters

workspace

Reference to the created workspace

workspaceFilePathChanged

void hdps::AbstractWorkspaceManager::workspaceFilePathChanged ( const QString &  filePath )

signal

Signals that the location of the current workspace changed to filePath

Parameters

filePath

File path of the workspace

workspaceLoaded

void hdps::AbstractWorkspaceManager::workspaceLoaded ( const QString &  filePath )

signal

Signals that a workspace is loaded from filePath

Parameters

filePath

File path of the workspace

workspaceSaved

void hdps::AbstractWorkspaceManager::workspaceSaved ( const QString &  filePath )

signal

Signals that a workspace is saved to filePath

Parameters

filePath

File path of the workspace

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/AbstractWorkspaceManager.h