mirror of
https://github.com/HifiExperiments/overte.git
synced 2025-08-09 04:27:57 +02:00
tabletInterface API JSDoc
This commit is contained in:
parent
77021f3236
commit
a1de44310f
1 changed files with 26 additions and 0 deletions
|
@ -44,6 +44,14 @@ class OffscreenQmlSurface;
|
||||||
* @hifi-interface
|
* @hifi-interface
|
||||||
* @hifi-client-entity
|
* @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 {
|
class TabletScriptingInterface : public QObject, public Dependency {
|
||||||
Q_OBJECT
|
Q_OBJECT
|
||||||
public:
|
public:
|
||||||
|
@ -83,6 +91,13 @@ public:
|
||||||
* @param {string} name - Tablet name.
|
* @param {string} name - Tablet name.
|
||||||
* @returns {TabletProxy} Tablet instance.
|
* @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);
|
Q_INVOKABLE TabletProxy* getTablet(const QString& tabletId);
|
||||||
|
|
||||||
void preloadSounds();
|
void preloadSounds();
|
||||||
|
@ -91,6 +106,11 @@ public:
|
||||||
* @function Tablet.playSound
|
* @function Tablet.playSound
|
||||||
* @param {Tablet.AudioEvents} sound
|
* @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);
|
Q_INVOKABLE void playSound(TabletAudioEvents aEvent);
|
||||||
|
|
||||||
void setToolbarMode(bool toolbarMode);
|
void setToolbarMode(bool toolbarMode);
|
||||||
|
@ -108,6 +128,12 @@ signals:
|
||||||
* @function Tablet.tabletNotification
|
* @function Tablet.tabletNotification
|
||||||
* @returns {Signal}
|
* @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();
|
void tabletNotification();
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
|
Loading…
Reference in a new issue