Falkon/falkonOfficial
Falkon/falkonOfficial
1
Fork 0
mirror of https://invent.kde.org/network/falkon.git synced 2024-12-20 02:36:34 +01:00
Code Releases Activity

Added documentation for FileUtils API

Browse Source
This commit is contained in:
Anmol Gautam 2018-07-17 21:36:29 +05:30
parent 68201ffe59
commit dfb7efee5e
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/lib/plugins/qml/api/fileutils/qmlfileutils.h
View File

@ -19,13 +19,33 @@
#include <QObject>
/**
* @brief The QmlFileUtils class, exposed to QML as FileUtils
*/
class QmlFileUtils : public QObject
{
Q_OBJECT
public:
explicit QmlFileUtils(QString filePath, QObject *parent = nullptr);
/**
* @brief Get the path of the file within the plugin directory.
* If the filePath provided is resolved to be outside the plugin
* directory then empty string is returned
* @param file path within the plugin directory
* @return resolved path
*/
Q_INVOKABLE QString resolve(const QString &filePath);
/**
* @brief Read the contents of the file within the plugin directory
* @param file path within the plugin directory
* @return contents of the file
*/
Q_INVOKABLE QString readAllFileContents(const QString &fileName);
/**
* @brief Checks if the file exists within the plugin directory
* @param file path within the plugin directory
* @return true if file exists, otherwise false
*/
Q_INVOKABLE bool exists(const QString &filePath);
private:
QString m_path;