Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-08-04 03:13:09 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #12729 from ctrlaltdavid/21814

Browse source 
Settings API JSDoc
This commit is contained in:
MiladNazeri 2018-04-11 11:48:15 -07:00 committed by GitHub
commit 9f7a765ec3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
interface/src/scripting/SettingsScriptingInterface.h
View file

@ -15,6 +15,11 @@
#include <QObject> #include <QObject>
#include <QString> #include <QString>
/**jsdoc
* The Settings API provides a facility to store and retrieve values that persist between Interface runs.
* @namespace Settings
*/
class SettingsScriptingInterface : public QObject { class SettingsScriptingInterface : public QObject {
Q_OBJECT Q_OBJECT
SettingsScriptingInterface() { }; SettingsScriptingInterface() { };
@ -22,8 +27,37 @@ public:
static SettingsScriptingInterface* getInstance(); static SettingsScriptingInterface* getInstance();
public slots: public slots:
/**jsdoc
* Retrieve the value from a named setting.
* @function Settings.getValue
* @param {string} key - The name of the setting.
* @param {string|number|boolean|object} [defaultValue=""] - The value to return if the setting doesn't exist.
* @returns {string|number|boolean|object} The value stored in the named setting if it exists, otherwise the
* <code>defaultValue</code>.
* @example <caption>Retrieve non-existent setting values.</caption>
* var value1 = Settings.getValue("Script Example/Nonexistent Key");
* print("Value: " + (typeof value1) + " " + JSON.stringify(value1)); // string ""
*
* var value2 = Settings.getValue("Script Example/Nonexistent Key", true);
* print("Value: " + (typeof value2) + " " + JSON.stringify(value2)); // boolean true
*/
QVariant getValue(const QString& setting); QVariant getValue(const QString& setting);
QVariant getValue(const QString& setting, const QVariant& defaultValue); QVariant getValue(const QString& setting, const QVariant& defaultValue);
/**jsdoc
* Store a value in a named setting. If the setting already exists its value is overwritten, otherwise a new setting is
* created. If the value is set to <code>null</code> or <code>undefined</code>, the setting is deleted.
* @function Settings.setValue
* @param {string} key - The name of the setting. Be sure to use a unique name if creating a new setting.
* @param {string|number|boolean|object|undefined} value - The value to store in the setting. If <code>null</code> or
* <code>undefined</code> is specified, the setting is deleted.
* @example <caption>Store and retrieve an object value.</caption>
* Settings.setValue("Script Example/My Key", { x: 0, y: 10, z: 0 });
*
* var value = Settings.getValue("Script Example/My Key");
* print("Value: " + (typeof value) + " " + JSON.stringify(value)); // object {"x":0,"y":10,"z":0}
*/
void setValue(const QString& setting, const QVariant& value); void setValue(const QString& setting, const QVariant& value);
}; };