Reformat and (slightly) decruft all the things.

This commit is contained in:
Petr Mrázek
2013-11-04 02:53:05 +01:00
parent d6e4fb2971
commit bb7e8985f6
208 changed files with 4492 additions and 3767 deletions

View File

@ -3,7 +3,7 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
@ -13,8 +13,7 @@
* limitations under the License.
*/
#ifndef SETTING_H
#define SETTING_H
#pragma once
#include <QObject>
#include <QVariant>
@ -24,7 +23,7 @@
class SettingsObject;
/*!
*
*
*/
class LIBSETTINGS_EXPORT Setting : public QObject
{
@ -35,23 +34,30 @@ public:
* \param parent The Setting's parent object.
*/
explicit Setting(QString id, QVariant defVal = QVariant(), QObject *parent = 0);
/*!
* \brief Gets this setting's ID.
* This is used to refer to the setting within the application.
* \warning Changing the ID while the setting is registered with a SettingsObject results in undefined behavior.
* \warning Changing the ID while the setting is registered with a SettingsObject results in
* undefined behavior.
* \return The ID of the setting.
*/
virtual QString id() const { return m_id; }
virtual QString id() const
{
return m_id;
}
/*!
* \brief Gets this setting's config file key.
* This is used to store the setting's value in the config file. It is usually
* the same as the setting's ID, but it can be different.
* \return The setting's config file key.
*/
virtual QString configKey() const { return id(); }
virtual QString configKey() const
{
return id();
}
/*!
* \brief Gets this setting's value as a QVariant.
* This is done by calling the SettingsObject's retrieveValue() function.
@ -60,22 +66,23 @@ public:
* \sa value()
*/
virtual QVariant get() const;
/*!
* \brief Gets this setting's actual value (I.E. not as a QVariant).
* This function is just shorthand for get().value<T>()
* \return The setting's actual value.
*/
template<typename T>
inline T value() const { return get().value<T>(); }
template <typename T> inline T value() const
{
return get().value<T>();
}
/*!
* \brief Gets this setting's default value.
* \return The default value of this setting.
*/
virtual QVariant defValue() const;
signals:
/*!
* \brief Signal emitted when this Setting object's value changes.
@ -83,14 +90,15 @@ signals:
* \param value This Setting object's new value.
*/
void settingChanged(const Setting &setting, QVariant value);
/*!
* \brief Signal emitted when this Setting object's value resets to default.
* \param setting A reference to the Setting that changed.
*/
void settingReset(const Setting &setting);
public slots:
public
slots:
/*!
* \brief Changes the setting's value.
* This is done by emitting the settingChanged() signal which will then be
@ -98,7 +106,7 @@ public slots:
* \param value The new value.
*/
virtual void set(QVariant value);
/*!
* \brief Reset the setting to default
* This is done by emitting the settingReset() signal which will then be
@ -106,9 +114,8 @@ public slots:
* \param value The new value.
*/
virtual void reset();
protected:
QString m_id;
QVariant m_defVal;
};
#endif // SETTING_H