Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-09 15:09:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

File API JSDoc stubs

Browse source
This commit is contained in:
David Rowe 2018-05-11 21:07:12 +12:00
parent 42d0620fd1
commit 496154fdbe
1 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
libraries/script-engine/src/FileScriptingInterface.h
View file

@ -16,6 +16,15 @@
#include <QFileInfo> #include <QFileInfo>
#include <QString> #include <QString>
/**jsdoc
* @namespace File
*
* @hifi-interface
* @hifi-client-entity
* @hifi-server-entity
* @hifi-assignment-client
*/
class FileScriptingInterface : public QObject { class FileScriptingInterface : public QObject {
Q_OBJECT Q_OBJECT
@ -23,11 +32,41 @@ public:
FileScriptingInterface(QObject* parent); FileScriptingInterface(QObject* parent);
public slots: public slots:
/**jsdoc
* @function File.convertUrlToPath
* @param {string} url
* @returns {string}
*/
QString convertUrlToPath(QUrl url); QString convertUrlToPath(QUrl url);
/**jsdoc
* @function File.runUnzip
* @param {string} path
* @param {string} url
* @param {boolean} autoAdd
* @param {boolean} isZip
* @param {boolean} isBlocks
*/
void runUnzip(QString path, QUrl url, bool autoAdd, bool isZip, bool isBlocks); void runUnzip(QString path, QUrl url, bool autoAdd, bool isZip, bool isBlocks);
/**jsdoc
* @function File.getTempDir
* @returns {string}
*/
QString getTempDir(); QString getTempDir();
signals: signals:
/**jsdoc
* @function File.unzipResult
* @param {string} zipFile
* @param {string} unzipFile
* @param {boolean} autoAdd
* @param {boolean} isZip
* @param {boolean} isBlocks
* @returns {Signal}
*/
void unzipResult(QString zipFile, QStringList unzipFile, bool autoAdd, bool isZip, bool isBlocks); void unzipResult(QString zipFile, QStringList unzipFile, bool autoAdd, bool isZip, bool isBlocks);
private: private: