#include <Project.h>

Inheritance diagram for hdps::Project:

Signals
void	filePathChanged (const QString &filePath)

Public Member Functions
	Project (QObject *parent=nullptr)

	Project (const QString &filePath, bool preview, QObject *parent=nullptr)

QString	getFilePath () const

void	setFilePath (const QString &filePath)

util::Version	getVersion () const

void	updateContributors ()

void	setStudioMode (bool studioMode)

void	fromVariantMap (const QVariantMap &variantMap, bool preview)

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

const gui::VersionAction &	getApplicationVersionAction () const

const gui::VersionAction &	getProjectVersionAction () const

const gui::ToggleAction &	getReadOnlyAction () const

const gui::StringAction &	getTitleAction () const

const gui::StringAction &	getDescriptionAction () const

const gui::StringsAction &	getTagsAction () const

const gui::StringAction &	getCommentsAction () const

const gui::StringsAction &	getContributorsAction () const

const CompressionAction &	getCompressionAction () const

const gui::ProjectSplashScreenAction &	getSplashScreenAction () const

const gui::ToggleAction &	getStudioModeAction () const

gui::VersionAction &	getApplicationVersionAction ()

gui::VersionAction &	getProjectVersionAction ()

gui::ToggleAction &	getReadOnlyAction ()

gui::StringAction &	getTitleAction ()

gui::StringAction &	getDescriptionAction ()

gui::StringsAction &	getTagsAction ()

gui::StringAction &	getCommentsAction ()

gui::StringsAction &	getContributorsAction ()

CompressionAction &	getCompressionAction ()

gui::ProjectSplashScreenAction &	getSplashScreenAction ()

gui::ToggleAction &	getStudioModeAction ()

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 Protected Attributes
static constexpr bool	DEFAULT_ENABLE_COMPRESSION = false

static constexpr std::uint32_t	DEFAULT_COMPRESSION_LEVEL = 2

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

Project class

TODO: Write description.

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ Project() [1/2]

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

Construct project with parent

Parameters

parent Pointer to parent object

◆ Project() [2/2]

hdps::Project::Project	(	const QString &	filePath,
		bool	preview,
		QObject *	parent = `nullptr`
	)

Construct project from project JSON filePath and parent

Parameters

filePath	Path of the project file
preview	Only extract basic info from the project JSON file for preview purposes
parent	Pointer to parent object

Member Function Documentation

◆ filePathChanged

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

signal

Signals that the project file path changed

Parameters

filePath Location on disk where the project resides

◆ fromVariantMap() [1/2]

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

overridevirtual

Load project from variant

Parameters

Variant representation of the project

Reimplemented from hdps::util::Serializable.

◆ fromVariantMap() [2/2]

void hdps::Project::fromVariantMap	(	const QVariantMap &	variantMap,
		bool	preview
	)

Load project from variant

Parameters

preview	Only extract basic info from the project JSON file for preview purposes
Variant	representation of the project

◆ getApplicationVersionAction() [1/2]

gui::VersionAction & hdps::Project::getApplicationVersionAction ( )

inline

◆ getApplicationVersionAction() [2/2]

const gui::VersionAction & hdps::Project::getApplicationVersionAction ( ) const

inline

◆ getCommentsAction() [1/2]

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

inline

◆ getCommentsAction() [2/2]

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

inline

◆ getCompressionAction() [1/2]

CompressionAction & hdps::Project::getCompressionAction ( )

inline

◆ getCompressionAction() [2/2]

const CompressionAction & hdps::Project::getCompressionAction ( ) const

inline

◆ getContributorsAction() [1/2]

gui::StringsAction & hdps::Project::getContributorsAction ( )

inline

◆ getContributorsAction() [2/2]

const gui::StringsAction & hdps::Project::getContributorsAction ( ) const

inline

◆ getDescriptionAction() [1/2]

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

inline

◆ getDescriptionAction() [2/2]

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

inline

◆ getFilePath()

QString hdps::Project::getFilePath ( ) const

Get project file path

Returns: Location on disk where the project resides

◆ getProjectVersionAction() [1/2]

gui::VersionAction & hdps::Project::getProjectVersionAction ( )

inline

◆ getProjectVersionAction() [2/2]

const gui::VersionAction & hdps::Project::getProjectVersionAction ( ) const

inline

◆ getReadOnlyAction() [1/2]

gui::ToggleAction & hdps::Project::getReadOnlyAction ( )

inline

◆ getReadOnlyAction() [2/2]

const gui::ToggleAction & hdps::Project::getReadOnlyAction ( ) const

inline

◆ getSplashScreenAction() [1/2]

gui::ProjectSplashScreenAction & hdps::Project::getSplashScreenAction ( )

inline

◆ getSplashScreenAction() [2/2]

const gui::ProjectSplashScreenAction & hdps::Project::getSplashScreenAction ( ) const

inline

◆ getStudioModeAction() [1/2]

gui::ToggleAction & hdps::Project::getStudioModeAction ( )

inline

◆ getStudioModeAction() [2/2]

const gui::ToggleAction & hdps::Project::getStudioModeAction ( ) const

inline

◆ getTagsAction() [1/2]

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

inline

◆ getTagsAction() [2/2]

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

inline

◆ getTitleAction() [1/2]

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

inline

◆ getTitleAction() [2/2]

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

inline

◆ getVersion()

util::Version hdps::Project::getVersion ( ) const

Get version of the application (major and minor version number) with which the project is created

Returns: Pair of integers representing major and minor version number respectively

◆ setFilePath()

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

Set project file path

Parameters

filePath Location on disk where the project resides

◆ setStudioMode()

void hdps::Project::setStudioMode ( bool studioMode )

Set studio mode to studioMode

Parameters

studioMode Studio mode

◆ toVariantMap()

QVariantMap hdps::Project::toVariantMap ( ) const

overridevirtual

Save project to variant

Returns: Variant representation of the project

Reimplemented from hdps::util::Serializable.

◆ updateContributors()

void hdps::Project::updateContributors ( )

Update the contributors (adds current user if not already added)

Member Data Documentation

◆ DEFAULT_COMPRESSION_LEVEL

constexpr std::uint32_t hdps::Project::DEFAULT_COMPRESSION_LEVEL = 2

staticconstexprprotected

No compression by default

◆ DEFAULT_ENABLE_COMPRESSION

constexpr bool hdps::Project::DEFAULT_ENABLE_COMPRESSION = false

staticconstexprprotected

Toggle between view- and studio mode action

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

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

Signals

Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Project() [1/2]

◆ Project() [2/2]

Member Function Documentation

◆ filePathChanged

◆ fromVariantMap() [1/2]

◆ fromVariantMap() [2/2]

◆ getApplicationVersionAction() [1/2]

◆ getApplicationVersionAction() [2/2]

◆ getCommentsAction() [1/2]

◆ getCommentsAction() [2/2]

◆ getCompressionAction() [1/2]

◆ getCompressionAction() [2/2]

◆ getContributorsAction() [1/2]

◆ getContributorsAction() [2/2]

◆ getDescriptionAction() [1/2]

◆ getDescriptionAction() [2/2]

◆ getFilePath()

◆ getProjectVersionAction() [1/2]

◆ getProjectVersionAction() [2/2]

◆ getReadOnlyAction() [1/2]

◆ getReadOnlyAction() [2/2]

◆ getSplashScreenAction() [1/2]

◆ getSplashScreenAction() [2/2]

◆ getStudioModeAction() [1/2]

◆ getStudioModeAction() [2/2]

◆ getTagsAction() [1/2]

◆ getTagsAction() [2/2]

◆ getTitleAction() [1/2]

◆ getTitleAction() [2/2]

◆ getVersion()

◆ setFilePath()

◆ setStudioMode()

◆ toVariantMap()

◆ updateContributors()

Member Data Documentation

◆ DEFAULT_COMPRESSION_LEVEL

◆ DEFAULT_ENABLE_COMPRESSION