SettingsAccessor Class

(Utils::SettingsAccessor)

Public Types

class Issue
class RestoreData
enum ProceedInfo { Continue, DiscardAndContinue }

Public Functions

SettingsAccessor(const QString &docType, const QString &displayName, const QString &applicationDisplayName)
virtual ~SettingsAccessor() = default
FileName baseFilePath() const
virtual RestoreData readData(const FileName &path, QWidget *parent) const
QVariantMap restoreSettings(QWidget *parent) const
bool saveSettings(const QVariantMap &data, QWidget *parent) const
void setBaseFilePath(const FileName &baseFilePath)
void setReadOnly()
virtual optional<Issue> writeData(const FileName &path, const QVariantMap &data, QWidget *parent) const

Protected Functions

virtual QVariantMap prepareToWriteSettings(const QVariantMap &data) const
virtual QVariantMap preprocessReadSettings(const QVariantMap &data) const
virtual RestoreData readFile(const FileName &path) const
ProceedInfo reportIssues(const Issue &issue, const FileName &path, QWidget *parent) const
QVariantMap restoreSettings(const FileName &settingsPath, QWidget *parent) const
virtual optional<Issue> writeFile(const FileName &path, const QVariantMap &data) const

Member Type Documentation

enum SettingsAccessor::ProceedInfo

Member Function Documentation

SettingsAccessor::SettingsAccessor(const QString &docType, const QString &displayName, const QString &applicationDisplayName)

Default constructs an instance of SettingsAccessor.

[default] SettingsAccessor::~SettingsAccessor()

Destroys the instance of SettingsAccessor. The destructor is virtual.

FileName SettingsAccessor::baseFilePath() const

See also setBaseFilePath().

[virtual protected] QVariantMap SettingsAccessor::prepareToWriteSettings(const QVariantMap &data) const

[virtual protected] QVariantMap SettingsAccessor::preprocessReadSettings(const QVariantMap &data) const

[virtual] RestoreData SettingsAccessor::readData(const FileName &path, QWidget *parent) const

[virtual protected] RestoreData SettingsAccessor::readFile(const FileName &path) const

[protected] ProceedInfo SettingsAccessor::reportIssues(const Issue &issue, const FileName &path, QWidget *parent) const

QVariantMap SettingsAccessor::restoreSettings(QWidget *parent) const

[protected] QVariantMap SettingsAccessor::restoreSettings(const FileName &settingsPath, QWidget *parent) const

bool SettingsAccessor::saveSettings(const QVariantMap &data, QWidget *parent) const

void SettingsAccessor::setBaseFilePath(const FileName &baseFilePath)

See also baseFilePath().

void SettingsAccessor::setReadOnly()

[virtual] optional<Issue> SettingsAccessor::writeData(const FileName &path, const QVariantMap &data, QWidget *parent) const

[virtual protected] optional<Issue> SettingsAccessor::writeFile(const FileName &path, const QVariantMap &data) const