geometrize Namespace Reference

Namespaces
	cli
	common
	constants
	dialog
	exporter
	format
	image
	layout
	logging
	network
	preferences
	scene
	script
	searchpaths
	serialization
	strings
	task
	test
	util
	version

Classes
class	RecentItem
	The RecentItem class models an item that was recently interacted with. More...
class	RecentItems
	The RecentItems class encapsulates a list of items that were recently interacted with. The class keeps a record of these items stored in preferences. Useful for keeping track of recently opened files. More...
class	TabletProximityEventFilter
	The TabletProximityEventFilter captures tablet enter/exit proximity events (like when Wacom pens are held close to the screen) Used to hide the cursor so it doesn't get in the way of wherever the pen is being held. More...
class	TemplateManifest
	The TemplateManifest class represents the metadata for a task template. More...

Functions
QString	getBinaryTranslationFileExtension ()
	getBinaryTranslationFileExtension Gets the file extension for Qt binary translation files. More...
QString	getAppTranslationResourceDirectory ()
	getAppTranslationResourceDirectory Gets the resource path where translation files specific to the app are stored. More...
QString	getQtTranslationResourceDirectory ()
	getQtTranslationResourceDirectory Gets the resource path where translation files for Qt itself are stored. More...
void	setTranslatorsForLocale (const QString &locale)
	installTranslatorsForLocale Installs translators for the application. More...
QIcon	getFlagIconForLocaleCode (const QString &localeCode)
	getFlagIconForLocaleCode Gets a representative national flag for the given locale code. More...
QLocale	getGlobalPreferencesLocale ()
	getGlobalPreferencesLocale Gets a QLocale instance based on the current settings in global preferences. Note that if the string violates the locale format, the "C" locale is used instead. More...
void	setGlobalPreferencesForLocale (const QLocale &locale)
	setGlobalPreferencesForLocale Sets the locale settings based on the given locale name. More...
QStringList	getSupportedLocaleCodes ()
	getSupportedLocaleCodes Iterates over the embedded .qm files and extracts the ISO language codes from their filenames More...
void	setLocaleAndUserInterfaceLanguage (const QString &isoCode)
	setLocaleAndUserInterfaceLanguage Sets the application locale and user interface language to the given language code More...
RecentItems &	getRecentItems ()
	getRecentItems Gets a reference to the recent files list. More...
template<typename Archive >
void	serialize (Archive &ar, geometrize::ImageRunnerShapeBoundsOptions &bounds)
TabletProximityEventFilter &	getSharedTabletProximityEventFilterInstance ()
	getSharedTabletProximityEventFilterInstance Gets a reference to the shared instance of the tablet proximity event filter (since we currently only need one to give to the application instance) More...

Variables
const QString	flagIconResourceDirectory {":/flags/"}
const QString	flagIconFileExtension {".png"}
const QString	errorFlagResourcePath {":/icons/error.png"}
const QString	qtTranslationFilePrefix {"qt_"}
const QString	qtBaseTranslationFilePrefix {"qtbase_"}
const QString	geometrizeTranslationFilePrefix {"geometrize_"}

Function Documentation

getAppTranslationResourceDirectory()

QString geometrize::getAppTranslationResourceDirectory

(

)

getAppTranslationResourceDirectory Gets the resource path where translation files specific to the app are stored.

Returns

The resource path where translation files specific to the app are stored.

{
    return ":/translations/app/";
}

Here is the caller graph for this function:

getBinaryTranslationFileExtension()

QString geometrize::getBinaryTranslationFileExtension

(

)

getBinaryTranslationFileExtension Gets the file extension for Qt binary translation files.

Returns

The file extension for Qt binary file extension, including the dot prefix e.g. ".qm".

{
    return ".qm";
}

Here is the caller graph for this function:

getFlagIconForLocaleCode()

QIcon geometrize::getFlagIconForLocaleCode

(

const QString &

localeCode

)

getFlagIconForLocaleCode Gets a representative national flag for the given locale code.

Parameters

localeCode

A string in the form language_country_locale.

Returns

An icon for the code, or an error symbol if no suitable icon could be found.

{
    static const QIcon errorIcon{errorFlagResourcePath};
    assert(!errorIcon.isNull());
 
    // Should start with a minimum-two digit language code
    if(localeCode.length() < 2) {
        return errorIcon;
    }
 
    const auto iconExists = [](const QString& file) {
        const QString path{flagIconResourceDirectory + file + flagIconFileExtension};
        const QFileInfo info(path);
        return info.exists() && info.isFile();
    };
 
    const auto makeIcon = [](const QString& file) {
        const QIcon icon(flagIconResourceDirectory + file + flagIconFileExtension);
        assert(!icon.isNull());
        return icon;
    };
 
    // Try to find flag for locale code, with fallback
    // If "language_country_locale" fails, then "language_country" and lastly "language" will be tried
    const auto makeIconPaths = [](const QString& localeCode) {
        const QString separator{"_"};
 
        #if (QT_VERSION < QT_VERSION_CHECK(5, 14, 0))
        const QStringList parts{localeCode.split(separator, QString::SkipEmptyParts)};
        #else
        const QStringList parts{localeCode.split(separator, Qt::SkipEmptyParts)};
        #endif
 
        QStringList paths;
        if(parts.length() >= 3) {
            paths.push_back(parts[0] + "_" + parts[1] + "_" + parts[2]);
        }
        if(parts.length() >= 2) {
            paths.push_back(parts[0] + "_" + parts[1]);
        }
        if(parts.length() >= 1) {
            paths.push_back(parts[0]);
        }
        return paths;
    };
 
    const QStringList paths{makeIconPaths(localeCode)};
    for(const auto& path : paths) {
        if(iconExists(path)) {
            return makeIcon(path);
        }
    }
 
    return errorIcon;
}

Here is the caller graph for this function:

getGlobalPreferencesLocale()

QLocale geometrize::getGlobalPreferencesLocale

(

)

getGlobalPreferencesLocale Gets a QLocale instance based on the current settings in global preferences. Note that if the string violates the locale format, the "C" locale is used instead.

Returns

A QLocale instance based on the global preferences.

{
    const auto& prefs = geometrize::preferences::getGlobalPreferences();
 
    const QString language{QString::fromStdString(prefs.getLanguageIsoCode())};
    const QString country{QString::fromStdString(prefs.getCountryIsoCode())};
    const QString script{QString::fromStdString(prefs.getScriptIsoCode())};
 
    QString localeCode = "";
    if(!language.isEmpty()) {
        localeCode += language;
    }
    if(!script.isEmpty()) {
        localeCode += "_" + script;
    }
    if(!country.isEmpty()) {
        localeCode += "_" + country;
    }
 
    return QLocale(localeCode);
}

Here is the call graph for this function:

getQtTranslationResourceDirectory()

QString geometrize::getQtTranslationResourceDirectory

(

)

getQtTranslationResourceDirectory Gets the resource path where translation files for Qt itself are stored.

Returns

The resource path where translation files for Qt are stored.

{
    return ":/translations/qt/";
}

Here is the caller graph for this function:

getRecentItems()

RecentItems & geometrize::getRecentItems

(

)

getRecentItems Gets a reference to the recent files list.

getRecentItems Gets a reference to the app's recently opened files.

Returns

The recent files list.

A reference to the app's recently opened files.

{
    const QString recentlyOpenedItemsSettingsGroup = "recently_opened_items";
    const unsigned int maxRecentlyOpenedItems = 75;
 
    static geometrize::RecentItems items{recentlyOpenedItemsSettingsGroup, maxRecentlyOpenedItems};
    return items;
}

Here is the caller graph for this function:

getSharedTabletProximityEventFilterInstance()

TabletProximityEventFilter & geometrize::getSharedTabletProximityEventFilterInstance

(

)

getSharedTabletProximityEventFilterInstance Gets a reference to the shared instance of the tablet proximity event filter (since we currently only need one to give to the application instance)

Returns

A reference to the tablet proximity event filter

{
    static TabletProximityEventFilter* sharedInstance = new TabletProximityEventFilter(QApplication::instance());
    return *sharedInstance;
}

Here is the caller graph for this function:

getSupportedLocaleCodes()

QStringList geometrize::getSupportedLocaleCodes

(

)

getSupportedLocaleCodes Iterates over the embedded .qm files and extracts the ISO language codes from their filenames

Returns

A list of supported locale codes, sorted alphabetically e.g. "en_GB, ru_RU" etc

{
    QStringList supportedLocaleCodes;
    QDirIterator it(geometrize::getAppTranslationResourceDirectory());
    while (it.hasNext()) {
        it.next();
        QString fileName{it.fileName()};
        const QString localeCode{fileName.remove("geometrize_").remove(geometrize::getBinaryTranslationFileExtension())};
        supportedLocaleCodes.append(localeCode);
    }
    supportedLocaleCodes.sort();
    return supportedLocaleCodes;
}

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

template<typename Archive >

void geometrize::serialize	(	Archive &	ar,
		geometrize::ImageRunnerShapeBoundsOptions &	bounds
	)

{
    ar(cereal::make_nvp("enabled", bounds.enabled),
       cereal::make_nvp("xMinPercent", bounds.xMinPercent),
       cereal::make_nvp("yMinPercent", bounds.yMinPercent),
       cereal::make_nvp("xMaxPercent", bounds.xMaxPercent),
       cereal::make_nvp("yMaxPercent", bounds.yMaxPercent));
}

setGlobalPreferencesForLocale()

void geometrize::setGlobalPreferencesForLocale

(

const QLocale &

locale

)

setGlobalPreferencesForLocale Sets the locale settings based on the given locale name.

Parameters

localeName

The locale name. Note this sets only the language and country, not the script or other settings. Even if the string violates the locale format, the string may be saved to the preferences anyway.

{
    auto& prefs = geometrize::preferences::getGlobalPreferences();
 
    const QStringList parts{locale.name().split("-")};
 
    if(parts.length() == 0 || parts.length() > 3) {
        assert(0 && "Failed to extract locale name, will fail to set preferences");
        return;
    }
 
    if(parts.length() == 1) {
        prefs.setLanguageIsoCode(parts[0].toStdString());
        return;
    }
 
    if(parts.length() == 2) {
        prefs.setLanguageIsoCode(parts[0].toStdString());
        prefs.setCountryIsoCode(parts[1].toStdString());
        return;
    }
 
    if(parts.length() == 3) {
        prefs.setLanguageIsoCode(parts[0].toStdString());
        prefs.setScriptIsoCode(parts[1].toStdString());
 
        const QStringList countryAndMaybeCodesetOrModifier{parts[2].split(".")};
        assert(countryAndMaybeCodesetOrModifier.length() > 0 && countryAndMaybeCodesetOrModifier.length() <= 3);
 
        if(countryAndMaybeCodesetOrModifier.length() > 0) {
            prefs.setCountryIsoCode(countryAndMaybeCodesetOrModifier[0].toStdString());
        }
        return;
    }
}

Here is the call graph for this function:

setLocaleAndUserInterfaceLanguage()

void geometrize::setLocaleAndUserInterfaceLanguage

(

const QString &

isoCode

)

setLocaleAndUserInterfaceLanguage Sets the application locale and user interface language to the given language code

Parameters

isoCode

The locale code to set the application to. Note: has a hack that transforms Portuguese "pt" to "pt_PT" to prefer Portuguese over Brazilian-Portuguese Also sets global preferences to remember the given code.

{
    QString code = isoCode;
    if(code == "pt") {
        // NOTE hack - the default Portuguese translations are pt_PT not pt_BR, we make that explicit here
        // This is because Qt defaults to Brazilian version, whereas we preferred to default to Portugal
        code = "pt_PT";
    }
 
    geometrize::preferences::GlobalPreferences& prefs{geometrize::preferences::getGlobalPreferences()};
    prefs.setLanguageIsoCode(code.toStdString());
    QLocale::setDefault(QLocale(code));
    geometrize::setTranslatorsForLocale(code);
}

Here is the call graph for this function:

Here is the caller graph for this function:

setTranslatorsForLocale()

void geometrize::setTranslatorsForLocale

(

const QString &

locale

)

installTranslatorsForLocale Installs translators for the application.

Parameters

locale

A string in the form language_country. Note this is not threadsafe.

{
    QCoreApplication* application{QCoreApplication::instance()};
    if(application == nullptr) {
        assert(0 && "Attempting to set application translator before app is created");
        return;
    }
 
    // Remove and destroy old translators
    purgeTranslators(application);
 
    // Install the new translators
    const auto loadAndAddTranslator = [&application](const QString& file, const QString& directory) {
        QTranslator* translator{new QTranslator()};
        translator->load(file, directory);
        installTranslator(application, translator);
    };
    loadAndAddTranslator(qtTranslationFilePrefix + locale + geometrize::getBinaryTranslationFileExtension(), getQtTranslationResourceDirectory());
    loadAndAddTranslator(qtBaseTranslationFilePrefix + locale + geometrize::getBinaryTranslationFileExtension(), getQtTranslationResourceDirectory());
    loadAndAddTranslator(geometrizeTranslationFilePrefix + locale + geometrize::getBinaryTranslationFileExtension(), getAppTranslationResourceDirectory());
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

errorFlagResourcePath

const QString geometrize::errorFlagResourcePath {":/icons/error.png"}

flagIconFileExtension

const QString geometrize::flagIconFileExtension {".png"}

flagIconResourceDirectory

const QString geometrize::flagIconResourceDirectory {":/flags/"}

geometrizeTranslationFilePrefix

const QString geometrize::geometrizeTranslationFilePrefix {"geometrize_"}

qtBaseTranslationFilePrefix

const QString geometrize::qtBaseTranslationFilePrefix {"qtbase_"}

qtTranslationFilePrefix

const QString geometrize::qtTranslationFilePrefix {"qt_"}