OffscreenFlags JSDoc

This commit is contained in:
David Rowe 2019-10-23 09:54:00 +13:00
parent 9dc1167e73
commit b7af7fe1ab

View file

@ -33,13 +33,22 @@
#include "MainWindow.h"
/**jsdoc
* The <code>OffscreenFlags</code> API enables gamepad joystick navigation of UI.
*
* <p><em>This API no longer works.</em></p>
*
* @namespace OffscreenFlags
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
* @property {boolean} navigationFocused
* @property {boolean} navigationFocusDisabled
*
* @property {boolean} navigationFocused - <code>true</code> if UI has joystick navigation focus, <code>false</code> if it
* doesn't.
* @property {boolean} navigationFocusDisabled - <code>true</code> if UI joystick navigation focus is disabled,
* <code>false</code> if it isn't.
*
* @deprecated This API is deprecated and will be removed.
*/
// Needs to match the constants in resources/qml/Global.js
@ -72,12 +81,14 @@ public:
signals:
/**jsdoc
* Triggered when the value of the <code>navigationFocused</code> property changes.
* @function OffscreenFlags.navigationFocusedChanged
* @returns {Signal}
*/
void navigationFocusedChanged();
/**jsdoc
* Triggered when the value of the <code>navigationFocusDisabled</code> property changes.
* @function OffscreenFlags.navigationFocusDisabledChanged
* @returns {Signal}
*/