An extension of the normal settings viewmodel with the DataSyncSettingsAccessor as accessor. More...

#include <datasyncsettingsviewmodel.h>

Inheritance diagram for QtMvvm::DataSyncSettingsViewModel:

Public Member Functions
Q_INVOKABLE	DataSyncSettingsViewModel (QObject *parent=nullptr)
	Invokable constructor.

Public Member Functions inherited from QtMvvm::SettingsViewModel
Q_INVOKABLE	SettingsViewModel (QObject *parent=nullptr)
	Invokable constructor.

QtMvvm::ISettingsAccessor *	accessor () const
	READ accessor for SettingsViewModel::accessor.

virtual bool	canRestoreDefaults () const
	READ accessor for SettingsViewModel::canRestoreDefaults.

virtual QtMvvm::MessageConfig	restoreConfig () const
	READ accessor for SettingsViewModel::restoreConfig.

ISettingsSetupLoader *	settingsSetupLoader () const
	READ accessor for SettingsViewModel::settingsSetupLoader.

SettingsElements::Setup	loadSetup (const QString &frontend) const
	Loads the settings setup of the prepared file for the given frontend. More...

QSettings *	settings () const
	Returns the settings this viewmodel operates on (or null if not using QtMvvm::QSettingsAccessor)

virtual Q_INVOKABLE QVariant	loadValue (const QString &key, const QVariant &defaultValue={}) const
	Loads the value for the given key from the settings. More...

virtual Q_INVOKABLE void	saveValue (const QString &key, const QVariant &value)
	Saves the value with the given key. More...

virtual Q_INVOKABLE void	resetValue (const QString &key)
	Resets the value or group identified by the key. More...

QTMVVM_REVISION_1 Q_INVOKABLE void	resetAll (const SettingsElements::Setup &setup)
	Resets all values that are defined by the entries in the given setup. More...

Public Member Functions inherited from QtMvvm::ViewModel
	ViewModel (QObject *parent=nullptr)
	Default constructor with parent.

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

virtual void *	qt_metacast (const char *)

virtual int	qt_metacall (QMetaObject::Call, int, void **)

	QObject (QObject *parent)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

Static Public Member Functions
static QVariantHash	showParams (const QString &setup, const QString &setupFile={})
	Generates show parameter to show a settings viewmodel via ViewModel::show. More...

static QVariantHash	showParams (QtDataSync::DataStore *dataStore, const QString &setupFile={})
	Generates show parameter to show a settings viewmodel via ViewModel::show. More...

static QVariantHash	showParams (QtDataSync::DataTypeStore< DataSyncSettingsEntry > *dataStore, const QString &setupFile={})
	Generates show parameter to show a settings viewmodel via ViewModel::show. More...

Static Public Member Functions inherited from QtMvvm::SettingsViewModel
static QVariantHash	showParams (ISettingsAccessor *accessor, const QString &setupFile={})
	Generates show parameter to show a settings viewmodel via ViewModel::show. More...

static QVariantHash	showParams (QSettings *settings, const QString &setupFile={})
	Generates show parameter to show a settings viewmodel via ViewModel::show. More...

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Static Public Attributes
static const QString	paramSetup
	The parameter for a setup name for the onInit() method. More...

static const QString	paramDataStore
	The parameter for a QtDataSync::DataStore object for the onInit() method. More...

static const QString	paramDataTypeStore
	The parameter for a QtDataSync::DataTypeStore object for the onInit() method. More...

Static Public Attributes inherited from QtMvvm::SettingsViewModel
static const QString	paramAccessor
	The parameter for an ISettingsAccessor object for the onInit() method. More...

static const QString	paramSettings
	The parameter for a QSettings object for the onInit() method. More...

static const QString	paramSetupFile
	The parameter for a settings setup file for the onInit() method. More...

Protected Member Functions
void	onInit (const QVariantHash &params) override
	Called by the presenter to initialize the viewmodel. More...

Protected Member Functions inherited from QtMvvm::ViewModel
template<typename TViewModel >
void	show (const QVariantHash &params={}) const
	Show another viewmodel as a child of this one. More...

void	show (const char *viewModelName, const QVariantHash &params={}) const
	Show another viewmodel as a child of this one. More...

void	show (const QMetaObject *viewMetaObject, const QVariantHash &params={}) const
	Show another viewmodel as a child of this one. More...

template<typename TViewModel >
void	showForResult (quint32 requestCode, const QVariantHash &params={}) const
	Show another viewmodel as a child of this one and expect its result. More...

void	showForResult (quint32 requestCode, const char *viewModelName, const QVariantHash &params={}) const
	Show another viewmodel as a child of this one and expect its result. More...

void	showForResult (quint32 requestCode, const QMetaObject *viewMetaObject, const QVariantHash &params={}) const
	Show another viewmodel as a child of this one and expect its result. More...

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Additional Inherited Members
Public Slots inherited from QtMvvm::SettingsViewModel
virtual void	callAction (const QString &key, const QVariantMap &parameters)
	Is called when an action type edit is pressed. More...

QTMVVM_REVISION_1 void	setAccessor (QtMvvm::ISettingsAccessor *accessor)
	WRITE accessor for SettingsViewModel::accessor.

void	setSettingsSetupLoader (QtMvvm::ISettingsSetupLoader *settingsSetupLoader)
	WRITE accessor for SettingsViewModel::settingsSetupLoader.

Public Slots inherited from QtMvvm::ViewModel
virtual void	onResult (quint32 requestCode, const QVariant &result)
	Called by the presenter when a result of a showed viewmodel is ready. More...

Signals inherited from QtMvvm::SettingsViewModel
QTMVVM_REVISION_1 void	accessorChanged (QtMvvm::ISettingsAccessor *accessor)
	NOTIFY accessor for SettingsViewModel::accessor.

void	settingsSetupLoaderChanged (QtMvvm::ISettingsSetupLoader *settingsSetupLoader, QPrivateSignal)
	NOTIFY accessor for SettingsViewModel::settingsSetupLoader.

void	beginLoadSetup ()
	Is emitted when the initialization has been completed and the viewmodel is ready for loading settings.

QTMVVM_REVISION_1 void	valueChanged (const QString &key)
	Signal to be emitted whenver a value in the settings is changed or removed to update the GUI.

QTMVVM_REVISION_1 void	resetAccepted (QPrivateSignal)
	Is emitted when the user accepted the reset triggered by resetAll() More...

Signals inherited from QtMvvm::ViewModel
void	resultReady (const QVariant &result)
	Should be emitted when the viewmodels result is ready. More...

QTMVVM_REVISION_1 void	instanceInvoked (const QVariantHash &params, QPrivateSignal)
	Is emitted on single instance viewmodels when they get shown again. More...

Properties inherited from QtMvvm::SettingsViewModel
QtMvvm::ISettingsAccessor	accessor
	Holds the settings accessor used by the viewmodel to access the settings. More...

bool	canRestoreDefaults
	Specifies if restoring the defaults is generally allowed. More...

QtMvvm::MessageConfig	restoreConfig
	The message configuration to be used to for a dialog to ask for settings restore. More...

QtMvvm::ISettingsSetupLoader	settingsSetupLoader
	The settings setup loader to use to create the settings dialog. Is an injected property. More...

Properties inherited from QObject
	objectName

Detailed Description

An extension of the normal settings viewmodel with the DataSyncSettingsAccessor as accessor.

Definition at line 17 of file datasyncsettingsviewmodel.h.

Member Function Documentation

◆ onInit()

void QtMvvm::DataSyncSettingsViewModel::onInit ( const QVariantHash & params )

overrideprotectedvirtual

Called by the presenter to initialize the viewmodel.

Parameters

params The parameters to initialize the viewmodel with

This method is called by the presenter right after creating the view and reparenting the viewmodel to the view. The parameters are the ones that have been passed to the show method called to show this viewmodel instance. Reimplement this method if you need to perform initializations after beeing assigned to a viewmodel or if you want to support a parametrized viewmodel.

See also: ViewModel::show, ViewModel::showForResult, CoreApp::show

Reimplemented from QtMvvm::SettingsViewModel.

◆ showParams() [1/3]

QtMvvm::DataSyncSettingsViewModel::showParams	(	const QString &	setup,
		const QString &	setupFile = `{}`
	)

static

Generates show parameter to show a settings viewmodel via ViewModel::show.

Parameters

setup	The name of the QtDataSync::Setup to be passed to the internally used DataSyncSettingsAccessor
setupFile	The path to a file to be used to create the settings. Can be empty to use the default path

Returns: A paramater hash to be passed to ViewModel::show

It's a shortcut to generate parameters for the show methods to show a settings viewmodel.

Note: Unless you need to explicitly set the settings or setup file a normal show without any parameters will just do fine.

See also: ViewModel::show, DataSyncSettingsViewModel::paramSetup, SettingsViewModel::paramSetupFile, DataSyncSettingsAccessor

◆ showParams() [2/3]

QtMvvm::DataSyncSettingsViewModel::showParams	(	QtDataSync::DataStore *	dataStore,
		const QString &	setupFile = `{}`
	)

static

Generates show parameter to show a settings viewmodel via ViewModel::show.

Parameters

dataStore	The store to be passed to the internally used DataSyncSettingsAccessor
setupFile	The path to a file to be used to create the settings. Can be empty to use the default path

Returns: A paramater hash to be passed to ViewModel::show

It's a shortcut to generate parameters for the show methods to show a settings viewmodel.

Note: Unless you need to explicitly set the settings or setup file a normal show without any parameters will just do fine.

See also: ViewModel::show, DataSyncSettingsViewModel::paramDataStore, SettingsViewModel::paramSetupFile, DataSyncSettingsAccessor

◆ showParams() [3/3]

QtMvvm::DataSyncSettingsViewModel::showParams	(	QtDataSync::DataTypeStore< DataSyncSettingsEntry > *	dataStore,
		const QString &	setupFile = `{}`
	)

static

Generates show parameter to show a settings viewmodel via ViewModel::show.

Parameters

dataStore	The store to be passed to the internally used DataSyncSettingsAccessor
setupFile	The path to a file to be used to create the settings. Can be empty to use the default path