BasicSettingsAccessor Class

(Utils::BasicSettingsAccessor)

Public Types

class Issue
class RestoreData
typedef ButtonMap
enum ProceedInfo { Continue, DiscardAndContinue }

Public Functions

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

Protected Functions

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

Member Type Documentation

typedef BasicSettingsAccessor::ButtonMap

enum BasicSettingsAccessor::ProceedInfo

Member Function Documentation

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

Default constructs an instance of BasicSettingsAccessor.

[default] BasicSettingsAccessor::~BasicSettingsAccessor()

Destroys the instance of BasicSettingsAccessor. The destructor is virtual.

Utils::FileName BasicSettingsAccessor::baseFilePath() const

See also setBaseFilePath().

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

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

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

[protected] RestoreData BasicSettingsAccessor::readFile(const Utils::FileName &path) const

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

QVariantMap BasicSettingsAccessor::restoreSettings(QWidget *parent) const

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

void BasicSettingsAccessor::setBaseFilePath(const Utils::FileName &baseFilePath)

See also baseFilePath().

[virtual] Utils::optional<Issue> BasicSettingsAccessor::writeData(const Utils::FileName &path, const QVariantMap &data) const

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