Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-04-23 09:25:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Toolbars API JSDoc stubs

Browse source
This commit is contained in:
David Rowe 2018-05-13 10:56:21 +12:00
parent fb1f7fea90
commit 46ebb0457e
1 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
libraries/ui/src/ui/ToolbarScriptingInterface.h
View file

@ -19,14 +19,30 @@
class QQuickItem;
/**jsdoc
* @class ToolbarButtonProxy
*
* @hifi-interface
* @hifi-client-entity
*/
class ToolbarButtonProxy : public QmlWrapper {
Q_OBJECT
public:
ToolbarButtonProxy(QObject* qmlObject, QObject* parent = nullptr);
/**jsdoc
* @function ToolbarButtonProxy#editProperties
* @param {object} properties
*/
Q_INVOKABLE void editProperties(const QVariantMap& properties);
signals:
/**jsdoc
* @function ToolbarButtonProxy#clicked
* @returns {Signal}
*/
void clicked();
protected:
@ -36,19 +52,48 @@ protected:
Q_DECLARE_METATYPE(ToolbarButtonProxy*);
/**jsdoc
* @class ToolbarProxy
*
* @hifi-interface
* @hifi-client-entity
*/
class ToolbarProxy : public QmlWrapper {
Q_OBJECT
public:
ToolbarProxy(QObject* qmlObject, QObject* parent = nullptr);
/**jsdoc
* @function ToolbarProxy#addButton
* @property {object} properties
* @returns {ToolbarButtonProxy}
*/
Q_INVOKABLE ToolbarButtonProxy* addButton(const QVariant& properties);
/**jsdoc
* @function ToolbarProxy#removeButton
* @property {string} name
*/
Q_INVOKABLE void removeButton(const QVariant& name);
};
Q_DECLARE_METATYPE(ToolbarProxy*);
/**jsdoc
* @namespace Toolbars
*
* @hifi-interface
* @hifi-client-entity
*/
class ToolbarScriptingInterface : public QObject, public Dependency {
Q_OBJECT
public:
/**jsdoc
* @function Toolbars.getToolbar
* @param {string} toolbarID
* @returns {ToolbarProxy}
*/
Q_INVOKABLE ToolbarProxy* getToolbar(const QString& toolbarId);
};