Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-08-16 18:56:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Snapshot API JSDoc stubs

Browse source
This commit is contained in:
David Rowe 2018-05-12 16:32:33 +12:00
parent b445371ad8
commit 74617822fa
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
interface/src/ui/Snapshot.h
View file

@ -34,6 +34,14 @@ private:
QUrl _URL; QUrl _URL;
}; };
/**jsdoc
* @namespace Snapshot
*
* @hifi-interface
* @hifi-client-entity
*/
class Snapshot : public QObject, public Dependency { class Snapshot : public QObject, public Dependency {
Q_OBJECT Q_OBJECT
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
@ -46,11 +54,28 @@ public:
static void uploadSnapshot(const QString& filename, const QUrl& href = QUrl("")); static void uploadSnapshot(const QString& filename, const QUrl& href = QUrl(""));
signals: signals:
/**jsdoc
* @function Snapshot.snapshotLocationSet
* @param {string} location
* @returns {Signal}
*/
void snapshotLocationSet(const QString& value); void snapshotLocationSet(const QString& value);
public slots: public slots:
/**jsdoc
* @function Snapshot.getSnapshotsLocation
* @returns {string}
*/
Q_INVOKABLE QString getSnapshotsLocation(); Q_INVOKABLE QString getSnapshotsLocation();
/**jsdoc
* @function Snapshot.setSnapshotsLocation
* @param {String} location
*/
Q_INVOKABLE void setSnapshotsLocation(const QString& location); Q_INVOKABLE void setSnapshotsLocation(const QString& location);
private: private:
static QFile* savedFileForSnapshot(QImage& image, static QFile* savedFileForSnapshot(QImage& image,
bool isTemporary, bool isTemporary,