Static utility class for managing the application settings. More...

#include <Settings.h>

Public Member Functions
	Settings ()=delete

Static Public Member Functions
static QStringList	autosaveFiles ()
static QStringList	completedExercises ()
static QStringList	completedTours ()
static QByteArray	dolphinGeometry ()
static int	exerciseProgress (const QString &exerciseId)
	Returns -1 if no record.
static bool	fastMode ()
static QString	fileName ()
	Returns the path to the settings file on disk.
static bool	hideV4Warning ()
static bool	icPreviewDisabled ()
static bool	labelsUnderIcons ()
static QString	language ()
static QByteArray	mainWindowGeometry ()
static QByteArray	mainWindowState ()
static QRect	minimapGeometry ()
static bool	minimapVisible ()
static QStringList	recentFiles ()
static void	setAutosaveFiles (const QStringList &files)
static void	setCompletedExercises (const QStringList &ids)
static void	setCompletedTours (const QStringList &ids)
static void	setDolphinGeometry (const QByteArray &geometry)
static void	setExerciseProgress (const QString &exerciseId, int step)
static void	setFastMode (bool enabled)
static void	setHideV4Warning (bool hide)
static void	setIcPreviewDisabled (bool disabled)
static void	setLabelsUnderIcons (bool enabled)
static void	setLanguage (const QString &lang)
static void	setMainWindowGeometry (const QByteArray &geometry)
static void	setMainWindowState (const QByteArray &state)
static void	setMinimapGeometry (const QRect &geometry)
static void	setMinimapVisible (bool visible)
static void	setRecentFiles (const QStringList &files)
static void	setSplitterGeometry (const QByteArray &geometry)
static void	setSplitterState (const QByteArray &state)
static void	setTheme (Theme theme)
static void	setTourProgress (const QString &tourId, int step)
static void	setUpdateCheckLastDate (const QString &date)
static void	setUpdateChecksDisabled (bool disabled)
static void	setUpdateCheckSkippedVersion (const QString &version)
static void	setWelcomeTourShown (bool shown)
static QByteArray	splitterGeometry ()
static QByteArray	splitterState ()
static Theme	theme ()
static int	tourProgress (const QString &tourId)
	Returns -1 if no record.
static QString	updateCheckLastDate ()
static bool	updateChecksDisabled ()
	Global opt-out of update checks (for offline/managed installs); default false (enabled).
static QString	updateCheckSkippedVersion ()
static bool	welcomeTourShown ()

Detailed Description

Static utility class for managing the application settings.

The Settings class provides a static interface to the Qt settings system, allowing application settings to be stored and retrieved in a consistent manner. It also acts as a central point for accessing configuration values.

Definition at line 25 of file Settings.h.

Constructor & Destructor Documentation

◆ Settings()

Settings::Settings ( )

delete

References theme().

Member Function Documentation

◆ autosaveFiles()

QStringList Settings::autosaveFiles ( )

static

Definition at line 186 of file Settings.cpp.

Referenced by WorkspaceManager::hasModifiedFiles(), WorkspaceManager::loadAutosaveFiles(), WorkSpace::save(), WorkspaceManager::save(), and WorkSpace::~WorkSpace().

◆ completedExercises()

QStringList Settings::completedExercises ( )

static

Definition at line 232 of file Settings.cpp.

Referenced by ExerciseEngine::ExerciseEngine().

◆ completedTours()

QStringList Settings::completedTours ( )

static

Definition at line 255 of file Settings.cpp.

Referenced by TourEngine::TourEngine().

◆ dolphinGeometry()

QByteArray Settings::dolphinGeometry ( )

static

Definition at line 85 of file Settings.cpp.

Referenced by BewavedDolphin::BewavedDolphin().

◆ exerciseProgress()

int Settings::exerciseProgress ( const QString & exerciseId )

static

Returns -1 if no record.

Definition at line 242 of file Settings.cpp.

Referenced by ExerciseEngine::ExerciseEngine().

◆ fastMode()

bool Settings::fastMode ( )

static

Definition at line 97 of file Settings.cpp.

◆ fileName()

QString Settings::fileName ( )

static

Returns the path to the settings file on disk.

Definition at line 26 of file Settings.cpp.

Referenced by MainWindow::MainWindow().

◆ hideV4Warning()

bool Settings::hideV4Warning ( )

static

Definition at line 196 of file Settings.cpp.

◆ icPreviewDisabled()

bool Settings::icPreviewDisabled ( )

static

Definition at line 120 of file Settings.cpp.

Referenced by ICPreviewPopup::showForIC().

◆ labelsUnderIcons()

bool Settings::labelsUnderIcons ( )

static

Definition at line 107 of file Settings.cpp.

Referenced by BewavedDolphin::BewavedDolphin().

◆ language()

QString Settings::language ( )

static

Definition at line 142 of file Settings.cpp.

Referenced by MainWindow::populateLanguageMenu(), and ExerciseTourResources::translate().

◆ mainWindowGeometry()

QByteArray Settings::mainWindowGeometry ( )

static

Definition at line 45 of file Settings.cpp.

◆ mainWindowState()

QByteArray Settings::mainWindowState ( )

static

Definition at line 55 of file Settings.cpp.

◆ minimapGeometry()

QRect Settings::minimapGeometry ( )

static

Position/size of the minimap overview, relative to its parent WorkSpace. Invalid (QRect().isValid() == false) if never set – callers fall back to a default corner.

Definition at line 300 of file Settings.cpp.

◆ minimapVisible()

bool Settings::minimapVisible ( )

static

Definition at line 287 of file Settings.cpp.

Referenced by MainWindow::MainWindow().

◆ recentFiles()

QStringList Settings::recentFiles ( )

static

Definition at line 174 of file Settings.cpp.

Referenced by RecentFiles::RecentFiles().

◆ setAutosaveFiles()

void Settings::setAutosaveFiles ( const QStringList & files )

static

Definition at line 191 of file Settings.cpp.

Referenced by WorkspaceManager::loadAutosaveFiles(), WorkSpace::save(), WorkspaceManager::save(), and WorkSpace::~WorkSpace().

◆ setCompletedExercises()

void Settings::setCompletedExercises ( const QStringList & ids )

static

Definition at line 237 of file Settings.cpp.

Referenced by ExerciseEngine::ExerciseEngine().

◆ setCompletedTours()

void Settings::setCompletedTours ( const QStringList & ids )

static

Definition at line 260 of file Settings.cpp.

Referenced by TourEngine::TourEngine().

◆ setDolphinGeometry()

void Settings::setDolphinGeometry ( const QByteArray & geometry )

static

Definition at line 90 of file Settings.cpp.

Referenced by BewavedDolphin::~BewavedDolphin().

◆ setExerciseProgress()

void Settings::setExerciseProgress	(	const QString &	exerciseId,
		int	step )

static

Definition at line 248 of file Settings.cpp.

Referenced by ExerciseEngine::ExerciseEngine().

◆ setFastMode()

void Settings::setFastMode ( bool enabled )

static

Definition at line 102 of file Settings.cpp.

◆ setHideV4Warning()

void Settings::setHideV4Warning ( bool hide )

static

Definition at line 201 of file Settings.cpp.

◆ setIcPreviewDisabled()

void Settings::setIcPreviewDisabled ( bool disabled )

static

Definition at line 125 of file Settings.cpp.

◆ setLabelsUnderIcons()

void Settings::setLabelsUnderIcons ( bool enabled )

static

Definition at line 115 of file Settings.cpp.

◆ setLanguage()

void Settings::setLanguage ( const QString & lang )

static

Definition at line 147 of file Settings.cpp.

Referenced by LanguageManager::loadTranslation().

◆ setMainWindowGeometry()

void Settings::setMainWindowGeometry ( const QByteArray & geometry )

static

Definition at line 50 of file Settings.cpp.

◆ setMainWindowState()

void Settings::setMainWindowState ( const QByteArray & state )

static

Definition at line 60 of file Settings.cpp.

◆ setMinimapGeometry()

void Settings::setMinimapGeometry ( const QRect & geometry )

static

Definition at line 305 of file Settings.cpp.

◆ setMinimapVisible()

void Settings::setMinimapVisible ( bool visible )

static

Definition at line 295 of file Settings.cpp.

◆ setRecentFiles()

void Settings::setRecentFiles ( const QStringList & files )

static

Definition at line 179 of file Settings.cpp.

◆ setSplitterGeometry()

void Settings::setSplitterGeometry ( const QByteArray & geometry )

static

Definition at line 70 of file Settings.cpp.

◆ setSplitterState()

void Settings::setSplitterState ( const QByteArray & state )

static

Definition at line 80 of file Settings.cpp.

◆ setTheme()

void Settings::setTheme ( Theme theme )

static

Definition at line 167 of file Settings.cpp.

References theme().

Referenced by ThemeManager::setTheme().

◆ setTourProgress()

void Settings::setTourProgress	(	const QString &	tourId,
		int	step )

static

Definition at line 271 of file Settings.cpp.

Referenced by TourEngine::TourEngine().

◆ setUpdateCheckLastDate()

void Settings::setUpdateCheckLastDate ( const QString & date )

static

Definition at line 215 of file Settings.cpp.

◆ setUpdateChecksDisabled()

void Settings::setUpdateChecksDisabled ( bool disabled )

static

Definition at line 135 of file Settings.cpp.

◆ setUpdateCheckSkippedVersion()

void Settings::setUpdateCheckSkippedVersion ( const QString & version )

static

Definition at line 225 of file Settings.cpp.

◆ setWelcomeTourShown()

void Settings::setWelcomeTourShown ( bool shown )

static

Definition at line 281 of file Settings.cpp.

Referenced by MainWindow::show().

◆ splitterGeometry()

QByteArray Settings::splitterGeometry ( )

static

Definition at line 65 of file Settings.cpp.

◆ splitterState()

QByteArray Settings::splitterState ( )

static

Definition at line 75 of file Settings.cpp.

◆ theme()

Theme Settings::theme ( )

static

Definition at line 154 of file Settings.cpp.

References System.

Referenced by setTheme(), and Settings().

◆ tourProgress()

int Settings::tourProgress ( const QString & tourId )

static

Returns -1 if no record.

Definition at line 265 of file Settings.cpp.

Referenced by TourEngine::TourEngine().

◆ updateCheckLastDate()

QString Settings::updateCheckLastDate ( )

static

Definition at line 210 of file Settings.cpp.

Referenced by UpdateChecker::checkForUpdates().

◆ updateChecksDisabled()

bool Settings::updateChecksDisabled ( )

static

Global opt-out of update checks (for offline/managed installs); default false (enabled).

Definition at line 130 of file Settings.cpp.

Referenced by UpdateChecker::checkForUpdates().

◆ updateCheckSkippedVersion()

QString Settings::updateCheckSkippedVersion ( )

static

Definition at line 220 of file Settings.cpp.

◆ welcomeTourShown()

bool Settings::welcomeTourShown ( )

static

Whether the built-in welcome tour has already been auto-started once. Set the first time MainWindow::show() runs, regardless of whether the tour is completed or dismissed, so it never auto-starts again after that first launch.

Definition at line 276 of file Settings.cpp.

Referenced by MainWindow::show().

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Settings()

Member Function Documentation

◆ autosaveFiles()

◆ completedExercises()

◆ completedTours()

◆ dolphinGeometry()

◆ exerciseProgress()

◆ fastMode()

◆ fileName()

◆ hideV4Warning()

◆ icPreviewDisabled()

◆ labelsUnderIcons()

◆ language()

◆ mainWindowGeometry()

◆ mainWindowState()

◆ minimapGeometry()

◆ minimapVisible()

◆ recentFiles()

◆ setAutosaveFiles()

◆ setCompletedExercises()

◆ setCompletedTours()

◆ setDolphinGeometry()

◆ setExerciseProgress()

◆ setFastMode()

◆ setHideV4Warning()

◆ setIcPreviewDisabled()

◆ setLabelsUnderIcons()

◆ setLanguage()

◆ setMainWindowGeometry()

◆ setMainWindowState()

◆ setMinimapGeometry()

◆ setMinimapVisible()

◆ setRecentFiles()

◆ setSplitterGeometry()

◆ setSplitterState()

◆ setTheme()

◆ setTourProgress()

◆ setUpdateCheckLastDate()

◆ setUpdateChecksDisabled()

◆ setUpdateCheckSkippedVersion()

◆ setWelcomeTourShown()

◆ splitterGeometry()

◆ splitterState()

◆ theme()

◆ tourProgress()

◆ updateCheckLastDate()

◆ updateChecksDisabled()

◆ updateCheckSkippedVersion()

◆ welcomeTourShown()