GUI::Project::Utils Namespace Reference

Description

Defines convenience function for project manager and document.

Functions
QString	autosaveDir (const QString &projectFileName)
	Returns name of autosave directory for project with given project file name. E.g. from '/projects/Untitled2/Untitled2.pro' returns '/projects/Untitled2/autosave'. More...
QString	autosaveName (const QString &projectFileName)
	Returns name of project for autoSave from given project file name. E.g. from '/projects/Untitled2/Untitled2.pro' returns '/projects/Untitled2/autosave/Untitled2.pro'. More...
QString	autosaveSubdir ()
	Returns fixed name for autosave sub-directory. More...
bool	hasAutosavedData (const QString &projectFileName)
	Returns true if project with given projectFileName contains autosaved data. More...
QString	projectDir (const QString &projectFileName)
	Returns project directory deduced from project file name. More...
QString	projectName (const QString &projectFileName)
	Returns project name deduced from project file name. More...

Variables
constexpr const char *	projectFileExtension {".pro"}

Function Documentation

autosaveDir()

QString GUI::Project::Utils::autosaveDir

(

const QString &

projectFileName

)

Returns name of autosave directory for project with given project file name. E.g. from '/projects/Untitled2/Untitled2.pro' returns '/projects/Untitled2/autosave'.

Definition at line 33 of file ProjectUtils.cpp.

{
    return projectDir(projectFileName) + "/" + autosaveSubdir();
}

References autosaveSubdir(), and projectDir().

Referenced by AutosaveController::autosaveDir(), and autosaveName().

Here is the call graph for this function:

autosaveName()

QString GUI::Project::Utils::autosaveName

(

const QString &

projectFileName

)

Returns name of project for autoSave from given project file name. E.g. from '/projects/Untitled2/Untitled2.pro' returns '/projects/Untitled2/autosave/Untitled2.pro'.

Definition at line 38 of file ProjectUtils.cpp.

{
    return autosaveDir(projectFileName) + "/" + projectName(projectFileName) + projectFileExtension;
}

References autosaveDir(), projectFileExtension, and projectName().

Referenced by AutosaveController::autosaveName(), hasAutosavedData(), ProjectManager::loadProject(), and ProjectManager::restoreProjectDialog().

Here is the call graph for this function:

autosaveSubdir()

QString GUI::Project::Utils::autosaveSubdir

(

)

Returns fixed name for autosave sub-directory.

Definition at line 28 of file ProjectUtils.cpp.

{
    return "autosave";
}

Referenced by AutosaveController::assureAutoSaveDirExists(), autosaveDir(), and SaveService::process_queue().

hasAutosavedData()

bool GUI::Project::Utils::hasAutosavedData

(

const QString &

projectFileName

)

Returns true if project with given projectFileName contains autosaved data.

Definition at line 43 of file ProjectUtils.cpp.

{
    return QFile::exists(projectFileName) && QFile::exists(autosaveName(projectFileName));
}

References autosaveName().

Referenced by ProjectManager::loadProject().

Here is the call graph for this function:

projectDir()

QString GUI::Project::Utils::projectDir

(

const QString &

projectFileName

)

Returns project directory deduced from project file name.

Definition at line 23 of file ProjectUtils.cpp.

{
    return QFileInfo(projectFileName).path();
}

Referenced by AutosaveController::assureAutoSaveDirExists(), autosaveDir(), NewProjectDialog::checkIfProjectNameIsValid(), DatafieldIOService::cleanOldFiles(), SimulationView::exportPythonScript(), SaveLoadInterface::fileName(), NewProjectDialog::getProjectFileName(), DataItem::loadData(), DatafieldIOService::loadDataFiles(), DatafieldIOService::save(), DataItem::saveData(), ProjectDocument::saveProjectData(), and ProjectDocument::setProjectFileName().

projectName()

QString GUI::Project::Utils::projectName

(

const QString &

projectFileName

)

Returns project name deduced from project file name.

Definition at line 18 of file ProjectUtils.cpp.

{
    return QFileInfo(projectFileName).baseName();
}

Referenced by NewProjectDialog::NewProjectDialog(), autosaveName(), NewProjectDialog::checkIfProjectNameIsValid(), ProjectManager::restoreProjectDialog(), and ProjectDocument::setProjectFileName().

Variable Documentation

projectFileExtension

constexpr const char* GUI::Project::Utils::projectFileExtension {".pro"}

inlineconstexpr

Definition at line 24 of file ProjectUtils.h.

Referenced by autosaveName(), NewProjectDialog::getProjectFileName(), and ProjectDocument::projectFileName().