Manages and persists the settings on the lowest level. More...

#include <settings_manager.h>

Inheritance diagram for hal::SettingsManager:

Collaboration diagram for hal::SettingsManager:

Public Slots
void	handleItemDestroyed (QObject *obj)

Public Member Functions
void	registerSetting (SettingsItem *item)

void	persistUserSettings ()

QPoint	mainWindowPosition () const

QSize	mainWindowSize () const

void	mainWindowSaveGeometry (const QPoint &pos, const QSize &size)

QVariant	settingsValue (const QString &tag) const

QVariant	defaultValue (const QString &tag) const

LoggerSettings	loggerSettings () const

void	saveLoggerSettings (const LoggerSettings &settings)

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

	QObject (QObject *parent)

virtual	~QObject ()

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 ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Static Public Member Functions
static SettingsManager *	instance ()

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)

Public Attributes
QList< SettingsItem * >	mSettingsList

Public Attributes inherited from QObject
typedef	QObjectList

Additional Inherited Members
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)

Properties inherited from QObject
	objectName

Detailed Description

Manages and persists the settings on the lowest level.

This class is the connection between the actual settings file that is saved on the disk and the logical SettingsItems.There exist two different settings files, one for the default values and on for the actual user specified values. This class is implemented as a singleton pattern.

Definition at line 47 of file settings_manager.h.

Member Function Documentation

◆ defaultValue()

QVariant hal::SettingsManager::defaultValue ( const QString & tag ) const

Get the value in the default settings file for a given key.

Parameters

tag	- The key.

Returns: The value encapsulated in a QVariant.

Definition at line 63 of file settings_manager.cpp.

References QSettings::value().

◆ handleItemDestroyed

void hal::SettingsManager::handleItemDestroyed ( QObject * obj )

slot

Removes the item -if possible- from the manager's settings list.

Parameters

obj	- The item to be removed.

Definition at line 46 of file settings_manager.cpp.

References mSettingsList.

Referenced by registerSetting().

◆ instance()

SettingsManager * hal::SettingsManager::instance ( )

static

Get the singleton instance of the SettingsManager.

Returns: The singleton instance.

Definition at line 12 of file settings_manager.cpp.

Referenced by hal::SettingsItemCheckbox::SettingsItemCheckbox(), hal::SettingsItemDropdown::SettingsItemDropdown(), hal::SettingsItemKeybind::SettingsItemKeybind(), hal::SettingsItemSlider::SettingsItemSlider(), hal::SettingsItemSpinbox::SettingsItemSpinbox(), and hal::SettingsItemText::SettingsItemText().

◆ loggerSettings()

LoggerSettings hal::SettingsManager::loggerSettings ( ) const

Definition at line 91 of file settings_manager.cpp.

References hal::LoggerSettings::debugSeverity, hal::LoggerSettings::errorSeverity, hal::LoggerSettings::infoSeverity, QVariant::toBool(), QSettings::value(), and hal::LoggerSettings::warningSeverity.

◆ mainWindowPosition()

QPoint hal::SettingsManager::mainWindowPosition ( ) const

Get the MainWindow's position that is saved in the user settings file.

Returns: The position.

Definition at line 73 of file settings_manager.cpp.

References QVariant::toPoint(), and QSettings::value().

◆ mainWindowSaveGeometry()

void hal::SettingsManager::mainWindowSaveGeometry	(	const QPoint &	pos,
		const QSize &	size
	)

Writes the MainWindow's position and size to the user settings file.

Parameters

pos	- The MainWindow's position.
size	- The MainWindow's size.

Definition at line 84 of file settings_manager.cpp.

References QSettings::setValue(), and QSettings::sync().

◆ mainWindowSize()

QSize hal::SettingsManager::mainWindowSize ( ) const

Get the MainWindow's size that is saved in the user settings file.

Returns

Definition at line 78 of file settings_manager.cpp.

References QApplication::desktop(), QDesktopWidget::screenGeometry(), QRect::size(), QVariant::toSize(), and QSettings::value().

◆ persistUserSettings()

void hal::SettingsManager::persistUserSettings ( )

Writes all settings to the user settings file.

Definition at line 52 of file settings_manager.cpp.

References mSettingsList, QSettings::remove(), QSettings::setValue(), and QSettings::sync().

◆ registerSetting()

void hal::SettingsManager::registerSetting ( SettingsItem * item )

Appends the given item to its list and either sets the value from the either the defaultFile or UserSettingsFile if it exits in one of them.

Parameters

item	- The item to register.

Definition at line 30 of file settings_manager.cpp.

References QObject::connect(), QSettings::contains(), QObject::destroyed(), handleItemDestroyed(), mSettingsList, hal::SettingsItem::restoreFromSettings(), hal::SettingsItem::setDefaultValue(), hal::SettingsItem::tag(), and QSettings::value().

Referenced by hal::SettingsItemCheckbox::SettingsItemCheckbox(), hal::SettingsItemDropdown::SettingsItemDropdown(), hal::SettingsItemKeybind::SettingsItemKeybind(), hal::SettingsItemSlider::SettingsItemSlider(), hal::SettingsItemSpinbox::SettingsItemSpinbox(), and hal::SettingsItemText::SettingsItemText().

◆ saveLoggerSettings()

void hal::SettingsManager::saveLoggerSettings ( const LoggerSettings & settings )

Definition at line 102 of file settings_manager.cpp.

References hal::LoggerSettings::debugSeverity, hal::LoggerSettings::errorSeverity, hal::LoggerSettings::infoSeverity, QSettings::setValue(), QSettings::sync(), and hal::LoggerSettings::warningSeverity.

◆ settingsValue()

QVariant hal::SettingsManager::settingsValue ( const QString & tag ) const

Get the value in the user settings file for a given key.

Parameters

tag	- The key.

Returns: The value encapsulated in a QVariant.

Definition at line 68 of file settings_manager.cpp.

References QSettings::value().

Member Data Documentation

◆ mSettingsList

QList<SettingsItem*> hal::SettingsManager::mSettingsList

Definition at line 66 of file settings_manager.h.

Referenced by handleItemDestroyed(), persistUserSettings(), and registerSetting().

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

/home/runner/work/hal/hal/plugins/gui/include/gui/settings/settings_manager.h
/home/runner/work/hal/hal/plugins/gui/src/settings/settings_manager.cpp

Public Slots

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ defaultValue()

◆ handleItemDestroyed

◆ instance()

◆ loggerSettings()

◆ mainWindowPosition()

◆ mainWindowSaveGeometry()

◆ mainWindowSize()

◆ persistUserSettings()

◆ registerSetting()

◆ saveLoggerSettings()

◆ settingsValue()

Member Data Documentation

◆ mSettingsList