settingssetup.h File Reference

The settings setup header. More...

#include <QtCore/qstringlist.h>
#include <QtCore/qvariant.h>
#include <QtCore/qurl.h>
#include <QtCore/qobject.h>
#include <QtCore/qfileselector.h>
#include <QtCore/qexception.h>
#include "QtMvvmCore/qtmvvmcore_global.h"

Go to the source code of this file.

Classes
struct	QtMvvm::SettingsElements::Entry
	An entry in the settings to display and edit a value. More...
struct	QtMvvm::SettingsElements::Group
	A logical group of settings entries. More...
struct	QtMvvm::SettingsElements::Section
	A bigger section for different entries and groups. More...
struct	QtMvvm::SettingsElements::Category
	A top level category to organize sections in. More...
struct	QtMvvm::SettingsElements::Setup
	The whole settings setup. More...
class	QtMvvm::SettingsLoaderException
	An exception throw in case loading a settings setup went wrong. More...
class	QtMvvm::ISettingsSetupLoader
	An interface for a generic settings setup loader. More...

Namespaces
	QtMvvm
	The primary namespace of the QtMvvm library.
	QtMvvm::SettingsElements
	A sub namespace for the different elements in a settings setup.

Macros
#define	QtMvvm_ISettingsSetupLoaderIid   "de.skycoder42.qtmvvm.settings.core.ISettingsSetupLoader"
	The Iid of the QtMvvm::ISettingsSetupLoader class.

Detailed Description

The settings setup header.

Definition in file settingssetup.h.

---

Class Documentation

QtMvvm::SettingsElements::Entry

struct QtMvvm::SettingsElements::Entry

An entry in the settings to display and edit a value.

Definition at line 19 of file settingssetup.h.

Class Members
QVariant	defaultValue	A default value to display in case no value is in the settings yet.
QString	frontends	[Internal] A logical string describing the allowed frontends
QString	key	The QSettings key this entry should handle.
QVariantMap	properties	Additional properties to be passed on to the edit view.
QStringList	searchKeys	A list of keys to find this entry by when searching.
QString	selectors	[Internal] A logical string describing the allowed selectors
QString	title	A short title/label of the entry to give it a name.
QString	tooltip	A tooltip with more detailed information about the entry.
QByteArray	type	The input view type (typically the actual data type) to show.

QtMvvm::SettingsElements::Group

struct QtMvvm::SettingsElements::Group

A logical group of settings entries.

Definition at line 43 of file settingssetup.h.

Class Members
QList< Entry >	entries	A list of entries the group contains.
QString	frontends	[Internal] A logical string describing the allowed frontends
QString	selectors	[Internal] A logical string describing the allowed selectors
QString	title	The groups title.
QString	tooltip	A tooltip to describe what the group is about.

QtMvvm::SettingsElements::Section

struct QtMvvm::SettingsElements::Section

A bigger section for different entries and groups.

Definition at line 60 of file settingssetup.h.

Class Members
QString	frontends	[Internal] A logical string describing the allowed frontends
QList< Group >	groups	A list of groups the section contains.
QUrl	icon	An icon for the section.
QString	selectors	[Internal] A logical string describing the allowed selectors
QString	title	The sections title.
QString	tooltip	A tooltip to describe what the section is about.

QtMvvm::SettingsElements::Category

struct QtMvvm::SettingsElements::Category

A top level category to organize sections in.

Definition at line 79 of file settingssetup.h.

Class Members
QString	frontends	[Internal] A logical string describing the allowed frontends
QUrl	icon	An icon for the category.
QList< Section >	sections	A list of sections the category contains.
QString	selectors	[Internal] A logical string describing the allowed selectors
QString	title	The categories title.
QString	tooltip	A tooltip to describe what the category is about.

QtMvvm::SettingsElements::Setup

struct QtMvvm::SettingsElements::Setup

The whole settings setup.

Definition at line 98 of file settingssetup.h.

Class Members
bool	allowRestore	Specifies if the user is allowed to restore the factory defaults.
bool	allowSearch	Specifies if the user is allowed to search in the settings.
QList< Category >	categories	A list of categories the setup is build of.