geometrize::preferences Namespace Reference

Classes
class	GlobalPreferences
	The GlobalPreferences class models the preferences associated with the application as a whole. These mostly represent application-wide settings that are edited via the tabbed preferences widget. More...
class	ImageTaskPreferences
	The ImageTaskPreferences class models the preferences associated with an image task. More...

Functions
std::string	getGlobalPreferencesConfigPath ()
	getGlobalPreferencesConfigPath Gets the absolute path to where the global preferences config file should be read/written. More...
geometrize::preferences::GlobalPreferences &	getGlobalPreferences ()
	getGlobalPreferences Shorthand function that gets a reference to the shared global preferences object, which stores global application preferences. More...
std::string	getImageTaskPreferencesAutoSavePath (const std::string &hashOfFirstTargetImage)
	getImageTaskPreferencesAutoSavePath Gets the absolute path to where the image task preferences config file should be read/written. More...

Function Documentation

getGlobalPreferences()

geometrize::preferences::GlobalPreferences & geometrize::preferences::getGlobalPreferences

(

)

getGlobalPreferences Shorthand function that gets a reference to the shared global preferences object, which stores global application preferences.

Returns

The global preferences object.

{
    static geometrize::preferences::GlobalPreferences prefs{};
    return prefs;
}

Here is the caller graph for this function:

getGlobalPreferencesConfigPath()

std::string geometrize::preferences::getGlobalPreferencesConfigPath

(

)

getGlobalPreferencesConfigPath Gets the absolute path to where the global preferences config file should be read/written.

Returns

The absolute path to the global preferences config file.

{
    const QString configFilename{"global_preferences.json"};
    const QString globalPreferencesFolder{QStandardPaths::writableLocation(QStandardPaths::StandardLocation::AppDataLocation)};
    const QString globalPreferencesPath{QDir(globalPreferencesFolder).filePath(configFilename)};
    const std::string globalPreferencesPathStr{globalPreferencesPath.toStdString()};
    return globalPreferencesPathStr;
}

Here is the caller graph for this function:

getImageTaskPreferencesAutoSavePath()

std::string geometrize::preferences::getImageTaskPreferencesAutoSavePath

(

const std::string &

hashOfFirstTargetImage

)

getImageTaskPreferencesAutoSavePath Gets the absolute path to where the image task preferences config file should be read/written.

Parameters

hashOfFirstTargetImage

A string containing a hash of the first target image the task was set up to use. NOTE - this hash changes based on the target image, so modifying the "resize image" settings in the application will cause this to change.

Returns

The name of the autosave task settings file, including the file extension

The absolute path the image task auto save path.

{
    const std::vector<std::string> autoSaveSearchPaths = geometrize::searchpaths::getAutosaveTaskSettingsSearchPaths();
    if(autoSaveSearchPaths.empty()) {
        assert(0 && "Image task autosave search paths should never be empty");
        return "";
    }
    const auto autoSaveTaskSettingsFilename = geometrize::searchpaths::getAutosaveTaskSettingsFilename(hashOfFirstTargetImage);
    return autoSaveSearchPaths[0] + QDir::separator().toLatin1() + autoSaveTaskSettingsFilename;
}

Here is the call graph for this function: