Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #16563 from ctrlaltdavid/DOC-198

Browse source 
DOC-198: OffscreenFlags JSDoc
This commit is contained in:
jennaingersoll 2019-12-09 16:01:49 -08:00 committed by GitHub
commit 6312a7cdd8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
libraries/ui/src/OffscreenUi.cpp
View file

@ -33,13 +33,20 @@
#include "MainWindow.h"
/**jsdoc
* The <code>OffscreenFlags</code> API enables gamepad joystick navigation of UI.
*
* <p><em>This API currently has no effect and is not used.</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.
*/
// Needs to match the constants in resources/qml/Global.js
@ -72,12 +79,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}
*/