CactiChameleon9/PrismLauncher
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

NOISSUE tabs -> spaces

Browse Source
This commit is contained in:
Petr Mrázek
2018-07-15 14:51:05 +02:00
parent 03280cc62e
commit bbb3b3e6f6
577 changed files with 51938 additions and 51938 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
api/logic/settings/Setting.h
View File

@ -29,91 +29,91 @@ class SettingsObject;
*/
class MULTIMC_LOGIC_EXPORT Setting : public QObject
{
Q_OBJECT
Q_OBJECT
public:
/**
* Construct a Setting
*
* Synonyms are all the possible names used in the settings object, in order of preference.
* First synonym is the ID, which identifies the setting in MultiMC.
*
* defVal is the default value that will be returned when the settings object
* doesn't have any value for this setting.
*/
explicit Setting(QStringList synonyms, QVariant defVal = QVariant());
/**
* Construct a Setting
*
* Synonyms are all the possible names used in the settings object, in order of preference.
* First synonym is the ID, which identifies the setting in MultiMC.
*
* defVal is the default value that will be returned when the settings object
* doesn't have any value for this setting.
*/
explicit Setting(QStringList synonyms, QVariant defVal = QVariant());
/*!
* \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.
* \return The ID of the setting.
*/
virtual QString id() const
{
return m_synonyms.first();
}
/*!
* \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.
* \return The ID of the setting.
*/
virtual QString id() const
{
return m_synonyms.first();
}
/*!
* \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 QStringList configKeys() const
{
return m_synonyms;
}
/*!
* \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 QStringList configKeys() const
{
return m_synonyms;
}
/*!
* \brief Gets this setting's value as a QVariant.
* This is done by calling the SettingsObject's retrieveValue() function.
* If this Setting doesn't have a SettingsObject, this returns an invalid QVariant.
* \return QVariant containing this setting's value.
* \sa value()
*/
virtual QVariant get() const;
/*!
* \brief Gets this setting's value as a QVariant.
* This is done by calling the SettingsObject's retrieveValue() function.
* If this Setting doesn't have a SettingsObject, this returns an invalid QVariant.
* \return QVariant containing this setting's value.
* \sa value()
*/
virtual QVariant get() const;
/*!
* \brief Gets this setting's default value.
* \return The default value of this setting.
*/
virtual QVariant defValue() const;
/*!
* \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.
* \param setting A reference to the Setting that changed.
* \param value This Setting object's new value.
*/
void SettingChanged(const Setting &setting, QVariant value);
/*!
* \brief Signal emitted when this Setting object's value changes.
* \param setting A reference to the Setting that changed.
* \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);
/*!
* \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:
/*!
* \brief Changes the setting's value.
* This is done by emitting the SettingChanged() signal which will then be
* handled by the SettingsObject object and cause the setting to change.
* \param value The new value.
*/
virtual void set(QVariant value);
/*!
* \brief Changes the setting's value.
* This is done by emitting the SettingChanged() signal which will then be
* handled by the SettingsObject object and cause the setting to change.
* \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
* handled by the SettingsObject object and cause the setting to change.
*/
virtual void reset();
/*!
* \brief Reset the setting to default
* This is done by emitting the settingReset() signal which will then be
* handled by the SettingsObject object and cause the setting to change.
*/
virtual void reset();
protected:
friend class SettingsObject;
SettingsObject * m_storage;
QStringList m_synonyms;
QVariant m_defVal;
friend class SettingsObject;
SettingsObject * m_storage;
QStringList m_synonyms;
QVariant m_defVal;
};