hdps::Workspace Class Reference

#include <Workspace.h>

Inheritance diagram for hdps::Workspace:

Signals
void	filePathChanged (const QString &filePath)

Public Member Functions
	Workspace (QObject *parent=nullptr)
	Workspace (const QString &filePath, QObject *parent=nullptr)
QString	getFilePath () const
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
const gui::LockingAction &	getLockingAction () const
const gui::StringAction &	getTitleAction () const
const gui::StringAction &	getDescriptionAction () const
const gui::StringsAction &	getTagsAction () const
const gui::StringAction &	getCommentsAction () const
gui::LockingAction &	getLockingAction ()
gui::StringAction &	getTitleAction ()
gui::StringAction &	getDescriptionAction ()
gui::StringsAction &	getTagsAction ()
gui::StringAction &	getCommentsAction ()
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 QImage	getPreviewImage (const QString &workspaceFilePath, const QSize &targetSize=QSize(500, 500))
Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

Protected Member Functions
void	setFilePath (const QString &filePath)

Friends
class	AbstractWorkspaceManager

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

Workspace class

TODO: Write description.

Author

Thomas Kroes

Constructor & Destructor Documentation

Workspace() [1/2]

hdps::Workspace::Workspace

(

QObject *

parent = nullptr

)

Construct workspace with parent

Parameters

parent

Pointer to parent object

Workspace() [2/2]

hdps::Workspace::Workspace	(	const QString &	filePath,
		QObject *	parent = nullptr
	)

Construct workspace with parent and load from filePath

Parameters

filePath	Path of the workspace file
parent	Pointer to parent object

Member Function Documentation

filePathChanged

void hdps::Workspace::filePathChanged ( const QString &  filePath )

signal

Signals that the workspace file path changed

Parameters

filePath

Location on disk where the workspace resides

fromVariantMap()

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

overridevirtual

Load workspace from variant

Parameters

Variant

representation of the workspace

Reimplemented from hdps::util::Serializable.

getCommentsAction() [1/2]

gui::StringAction & hdps::Workspace::getCommentsAction ( )

inline

getCommentsAction() [2/2]

const gui::StringAction & hdps::Workspace::getCommentsAction ( ) const

inline

getDescriptionAction() [1/2]

gui::StringAction & hdps::Workspace::getDescriptionAction ( )

inline

getDescriptionAction() [2/2]

const gui::StringAction & hdps::Workspace::getDescriptionAction ( ) const

inline

getFilePath()

QString hdps::Workspace::getFilePath

(

)

const

Get workspace file path

Returns

Location on disk where the workspace resides

getLockingAction() [1/2]

gui::LockingAction & hdps::Workspace::getLockingAction ( )

inline

getLockingAction() [2/2]

const gui::LockingAction & hdps::Workspace::getLockingAction ( ) const

inline

getPreviewImage()

QImage hdps::Workspace::getPreviewImage ( const QString &  workspaceFilePath, const QSize &  targetSize = QSize(500, 500)  )

static

Get preview image

Parameters

workspaceFilePath

Path of the work space file

Returns

Preview image

getTagsAction() [1/2]

gui::StringsAction & hdps::Workspace::getTagsAction ( )

inline

getTagsAction() [2/2]

const gui::StringsAction & hdps::Workspace::getTagsAction ( ) const

inline

getTitleAction() [1/2]

gui::StringAction & hdps::Workspace::getTitleAction ( )

inline

getTitleAction() [2/2]

const gui::StringAction & hdps::Workspace::getTitleAction ( ) const

inline

setFilePath()

void hdps::Workspace::setFilePath ( const QString &  filePath )

protected

Set workspace file path

Parameters

filePath

Location on disk where the workspace resides

toVariantMap()

QVariantMap hdps::Workspace::toVariantMap ( ) const

overridevirtual

Save workspace to variant

Returns

Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

Friends And Related Symbol Documentation

AbstractWorkspaceManager

friend class AbstractWorkspaceManager

friend

Workspace comments action

---

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

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