Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-16 07:56:55 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

tabletInterface API JSDoc

Browse source
This commit is contained in:
David Rowe 2018-05-15 10:02:38 +12:00
parent 77021f3236
commit a1de44310f
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
libraries/ui/src/ui/TabletScriptingInterface.h
View file

@ -44,6 +44,14 @@ class OffscreenQmlSurface;
* @hifi-interface
* @hifi-client-entity
*/
/**jsdoc
* @namespace tabletInterface
*
* @hifi-interface
* @hifi-client-entity
*
* @deprecated This API is deprecated and will be removed. Use {@link Tablet} instead.
*/
class TabletScriptingInterface : public QObject, public Dependency {
Q_OBJECT
public:
@ -83,6 +91,13 @@ public:
* @param {string} name - Tablet name.
* @returns {TabletProxy} Tablet instance.
*/
/**jsdoc
* Creates or returns a new TabletProxy and returns it.
* @function tabletInterface.getTablet
* @param {string} name - Tablet name.
* @returns {TabletProxy} Tablet instance.
* @deprecated This function is deprecated and will be removed. Use {@link Tablet.getTablet} instead.
*/
Q_INVOKABLE TabletProxy* getTablet(const QString& tabletId);
void preloadSounds();
@ -91,6 +106,11 @@ public:
* @function Tablet.playSound
* @param {Tablet.AudioEvents} sound
*/
/**jsdoc
* @function tabletInterface.playSound
* @param {Tablet.AudioEvents} sound
* @deprecated This function is deprecated and will be removed. Use {@link Tablet.playSound} instead.
*/
Q_INVOKABLE void playSound(TabletAudioEvents aEvent);
void setToolbarMode(bool toolbarMode);
@ -108,6 +128,12 @@ signals:
* @function Tablet.tabletNotification
* @returns {Signal}
*/
/**jsdoc
* Triggered when a tablet message or dialog is created.
* @function tabletInterface.tabletNotification
* @returns {Signal}
* @deprecated This function is deprecated and will be removed. Use {@link Tablet.tabletNotification} instead.
*/
void tabletNotification();
private: