Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-08 22:16:58 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added jsdocs for all button properties

Browse source
This commit is contained in:
Anthony J. Thibault 2017-01-31 16:54:15 -08:00
parent 8f362861eb
commit cf855391af
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
libraries/script-engine/src/TabletScriptingInterface.h
View file

@ -119,7 +119,7 @@ public:
* @param msg {object|string} * @param msg {object|string}
*/ */
Q_INVOKABLE void emitScriptEvent(QVariant msg); Q_INVOKABLE void emitScriptEvent(QVariant msg);
Q_INVOKABLE bool onHomeScreen(); Q_INVOKABLE bool onHomeScreen();
QObject* getTabletSurface(); QObject* getTabletSurface();
@ -170,14 +170,14 @@ public:
/**jsdoc /**jsdoc
* Returns the current value of this button's properties * Returns the current value of this button's properties
* @function TabletButtonProxy#getProperties * @function TabletButtonProxy#getProperties
* @returns {object} * @returns {ButtonProperties}
*/ */
Q_INVOKABLE QVariantMap getProperties() const; Q_INVOKABLE QVariantMap getProperties() const;
/**jsdoc /**jsdoc
* Replace the values of some of this button's properties * Replace the values of some of this button's properties
* @function TabletButtonProxy#editProperties * @function TabletButtonProxy#editProperties
* @param properties {object} set of properties to change * @param {ButtonProperties} properties - set of properties to change
*/ */
Q_INVOKABLE void editProperties(QVariantMap properties); Q_INVOKABLE void editProperties(QVariantMap properties);
@ -199,4 +199,13 @@ protected:
QVariantMap _properties; QVariantMap _properties;
}; };
/**jsdoc
* @typedef TabletButtonProxy.ButtonProperties
* @property {string} text - button caption
* @property {string} icon - url to button icon. (50 x 50)
* @property {string} activeText - button caption when button is active
* @property {string} activeIcon - url to button icon used when button is active. (50 x 50)
* @property {string} isActive - true when button is active.
*/
#endif // hifi_TabletScriptingInterface_h #endif // hifi_TabletScriptingInterface_h