Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-04-29 21:43:58 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Expand OverlayWindow and OverlayWebWindow JSDoc stubs

Browse source
This commit is contained in:
David Rowe 2018-05-14 09:57:35 +12:00
parent cad5b3fb15
commit 71355840b9
3 changed files with 28 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
libraries/ui/src/QmlWebWindowClass.h
View file

@ -14,7 +14,7 @@
/**jsdoc /**jsdoc
* @class OverlayWebWindow * @class OverlayWebWindow
* @augments OverlayWindow * @augments OverlayWindow
* @param {object} [properties=null] * @param {OverlayWindow.Properties} [properties=null]
* *
* @hifi-interface * @hifi-interface
* @hifi-client-en * @hifi-client-en

8
libraries/ui/src/QmlWindowClass.cpp
View file

@ -87,6 +87,14 @@ QmlWindowClass::QmlWindowClass() {
} }
/**jsdoc
* @typedef {object} OverlayWindow.Properties
* @property {string} title
* @property {string} source
* @property {number} width
* @property {number} height
* @property {boolean} visible
*/
void QmlWindowClass::initQml(QVariantMap properties) { void QmlWindowClass::initQml(QVariantMap properties) {
auto offscreenUi = DependencyManager::get<OffscreenUi>(); auto offscreenUi = DependencyManager::get<OffscreenUi>();
_source = properties[SOURCE_PROPERTY].toString(); _source = properties[SOURCE_PROPERTY].toString();

21
libraries/ui/src/QmlWindowClass.h
View file

@ -21,7 +21,7 @@ class QScriptContext;
/**jsdoc /**jsdoc
* @class OverlayWindow * @class OverlayWindow
* @param {object} [properties=null] * @param {OverlayWindow.Properties} [properties=null]
* *
* @hifi-interface * @hifi-interface
* @hifi-client-en * @hifi-client-en
@ -45,7 +45,7 @@ public:
/**jsdoc /**jsdoc
* @function OverlayWindow.initQml * @function OverlayWindow.initQml
* @param {object} properties * @param {OverlayWindow.Properties} properties
*/ */
Q_INVOKABLE virtual void initQml(QVariantMap properties); Q_INVOKABLE virtual void initQml(QVariantMap properties);
@ -220,8 +220,25 @@ signals:
void webEventReceived(const QVariant& message); void webEventReceived(const QVariant& message);
protected slots: protected slots:
/**jsdoc
* @function OverlayWindow.hasMoved
* @param {Vec2} position
* @returns {Signal}
*/
void hasMoved(QVector2D); void hasMoved(QVector2D);
/**jsdoc
* @function OverlayWindow.hasClosed
* @returns {Signal}
*/
void hasClosed(); void hasClosed();
/**jsdoc
* @function OverlayWindow.qmlToScript
* @param {object} message
* @returns {Signal}
*/
void qmlToScript(const QVariant& message); void qmlToScript(const QVariant& message);
protected: protected: