From 658b0f610a71fab8c103b913d2cfd11c3c7c6bef Mon Sep 17 00:00:00 2001 From: J-P Nurmi Date: Sun, 14 Aug 2016 15:02:50 +0200 Subject: Platform: add experimental StandardPaths This complements the File/FolderDialog offering. Change-Id: I44a105724321092a6efc4126c8fb25f7d31b77e2 Reviewed-by: Mitch Curtis --- src/imports/platform/platform.pri | 2 + src/imports/platform/qquickplatformfiledialog.cpp | 3 +- .../platform/qquickplatformfolderdialog.cpp | 3 +- .../platform/qquickplatformstandardpaths.cpp | 159 +++++++++++++++++++++ .../platform/qquickplatformstandardpaths_p.h | 90 ++++++++++++ src/imports/platform/qtlabsplatformplugin.cpp | 11 +- 6 files changed, 265 insertions(+), 3 deletions(-) create mode 100644 src/imports/platform/qquickplatformstandardpaths.cpp create mode 100644 src/imports/platform/qquickplatformstandardpaths_p.h (limited to 'src') diff --git a/src/imports/platform/platform.pri b/src/imports/platform/platform.pri index f6e0b99f..1e300251 100644 --- a/src/imports/platform/platform.pri +++ b/src/imports/platform/platform.pri @@ -11,6 +11,7 @@ HEADERS += \ $$PWD/qquickplatformmenuitemgroup_p.h \ $$PWD/qquickplatformmenuseparator_p.h \ $$PWD/qquickplatformmessagedialog_p.h \ + $$PWD/qquickplatformstandardpaths_p.h \ $$PWD/qquickplatformsystemtrayicon_p.h SOURCES += \ @@ -26,4 +27,5 @@ SOURCES += \ $$PWD/qquickplatformmenuitemgroup.cpp \ $$PWD/qquickplatformmenuseparator.cpp \ $$PWD/qquickplatformmessagedialog.cpp \ + $$PWD/qquickplatformstandardpaths.cpp \ $$PWD/qquickplatformsystemtrayicon.cpp diff --git a/src/imports/platform/qquickplatformfiledialog.cpp b/src/imports/platform/qquickplatformfiledialog.cpp index 6174fd99..9da774d4 100644 --- a/src/imports/platform/qquickplatformfiledialog.cpp +++ b/src/imports/platform/qquickplatformfiledialog.cpp @@ -66,6 +66,7 @@ QT_BEGIN_NAMESPACE FileDialog { id: fileDialog currentFile: document.source + folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation) } MyDocument { @@ -90,7 +91,7 @@ QT_BEGIN_NAMESPACE \labs - \sa FolderDialog + \sa FolderDialog, StandardPaths */ QQuickPlatformFileDialog::QQuickPlatformFileDialog(QObject *parent) diff --git a/src/imports/platform/qquickplatformfolderdialog.cpp b/src/imports/platform/qquickplatformfolderdialog.cpp index 1957a5c5..c56658c4 100644 --- a/src/imports/platform/qquickplatformfolderdialog.cpp +++ b/src/imports/platform/qquickplatformfolderdialog.cpp @@ -65,6 +65,7 @@ QT_BEGIN_NAMESPACE FolderDialog { id: folderDialog currentFolder: viewer.folder + folder: StandardPaths.standardLocations(StandardPaths.PicturesLocation)[0] } MyViewer { @@ -89,7 +90,7 @@ QT_BEGIN_NAMESPACE \labs - \sa FileDialog + \sa FileDialog, StandardPaths */ QQuickPlatformFolderDialog::QQuickPlatformFolderDialog(QObject *parent) diff --git a/src/imports/platform/qquickplatformstandardpaths.cpp b/src/imports/platform/qquickplatformstandardpaths.cpp new file mode 100644 index 00000000..004d3c86 --- /dev/null +++ b/src/imports/platform/qquickplatformstandardpaths.cpp @@ -0,0 +1,159 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Labs Platform module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qquickplatformstandardpaths_p.h" + +#include + +QT_BEGIN_NAMESPACE + +/*! + \qmltype StandardPaths + \inherits QtObject + \instantiates QQuickPlatformStandardPaths + \inqmlmodule Qt.labs.platform + \since 5.8 + \brief Provides access to the standard system paths. + + The StandardPaths singleton type provides methods for querying the standard + system paths. The standard paths are mostly useful in conjunction with the + FileDialog and FolderDialog types. + + \qml + FileDialog { + folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation) + } + \endqml + + \labs + + \sa FileDialog, FolderDialog, QStandardPaths +*/ + +static QList toUrlList(const QStringList &paths) +{ + QList urls; + urls.reserve(paths.size()); + for (const QString &path : paths) + urls += QUrl::fromLocalFile(path); + return urls; +} + +QQuickPlatformStandardPaths::QQuickPlatformStandardPaths(QObject *parent) + : QObject(parent) +{ +} + +QObject *QQuickPlatformStandardPaths::create(QQmlEngine *engine, QJSEngine *scriptEngine) +{ + Q_UNUSED(scriptEngine); + return new QQuickPlatformStandardPaths(engine); +} + +/*! + \qmlmethod string Qt.labs.platform::StandardPaths::displayName(StandardLocation type) + + \sa QStandardPaths::displayName() +*/ +QString QQuickPlatformStandardPaths::displayName(QStandardPaths::StandardLocation type) +{ + return QStandardPaths::displayName(type); +} + +/*! + \qmlmethod url Qt.labs.platform::StandardPaths::findExecutable(string executableName, list paths) + + \sa QStandardPaths::findExecutable() +*/ +QUrl QQuickPlatformStandardPaths::findExecutable(const QString &executableName, const QStringList &paths) +{ + return QUrl::fromLocalFile(QStandardPaths::findExecutable(executableName, paths)); +} + +/*! + \qmlmethod url Qt.labs.platform::StandardPaths::locate(StandardLocation type, string fileName, LocateOptions options = LocateFile) + + \sa QStandardPaths::locate() +*/ +QUrl QQuickPlatformStandardPaths::locate(QStandardPaths::StandardLocation type, const QString &fileName, QStandardPaths::LocateOptions options) +{ + return QUrl::fromLocalFile(QStandardPaths::locate(type, fileName, options)); +} + +/*! + \qmlmethod list Qt.labs.platform::StandardPaths::locateAll(StandardLocation type, string fileName, LocateOptions options = LocateFile) + + \sa QStandardPaths::locateAll() +*/ +QList QQuickPlatformStandardPaths::locateAll(QStandardPaths::StandardLocation type, const QString &fileName, QStandardPaths::LocateOptions options) +{ + return toUrlList(QStandardPaths::locateAll(type, fileName, options)); +} + +/*! + \qmlmethod void Qt.labs.platform::StandardPaths::setTestModeEnabled(bool testMode) + + \sa QStandardPaths::setTestModeEnabled() +*/ +void QQuickPlatformStandardPaths::setTestModeEnabled(bool testMode) +{ + QStandardPaths::setTestModeEnabled(testMode); +} + +/*! + \qmlmethod list Qt.labs.platform::StandardPaths::standardLocations(StandardLocation type) + + \sa QStandardPaths::standardLocations() +*/ +QList QQuickPlatformStandardPaths::standardLocations(QStandardPaths::StandardLocation type) +{ + return toUrlList(QStandardPaths::standardLocations(type)); +} + +/*! + \qmlmethod url Qt.labs.platform::StandardPaths::writableLocation(StandardLocation type) + + \sa QStandardPaths::writableLocation() +*/ +QUrl QQuickPlatformStandardPaths::writableLocation(QStandardPaths::StandardLocation type) +{ + return QUrl::fromLocalFile(QStandardPaths::writableLocation(type)); +} + +QT_END_NAMESPACE diff --git a/src/imports/platform/qquickplatformstandardpaths_p.h b/src/imports/platform/qquickplatformstandardpaths_p.h new file mode 100644 index 00000000..b6504e70 --- /dev/null +++ b/src/imports/platform/qquickplatformstandardpaths_p.h @@ -0,0 +1,90 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Labs Platform module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QQUICKPLATFORMSTANDARDPATHS_P_H +#define QQUICKPLATFORMSTANDARDPATHS_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include +#include +#include +#include + +QT_BEGIN_NAMESPACE + +class QQmlEngine; +class QJSEngine; + +class QQuickPlatformStandardPaths : public QObject +{ + Q_OBJECT + Q_ENUMS(QStandardPaths::StandardLocation QStandardPaths::LocateOptions) + +public: + explicit QQuickPlatformStandardPaths(QObject *parent = nullptr); + + static QObject *create(QQmlEngine *engine, QJSEngine *scriptEngine); + + Q_INVOKABLE static QString displayName(QStandardPaths::StandardLocation type); + Q_INVOKABLE static QUrl findExecutable(const QString &executableName, const QStringList &paths = QStringList()); + Q_INVOKABLE static QUrl locate(QStandardPaths::StandardLocation type, const QString &fileName, QStandardPaths::LocateOptions options = QStandardPaths::LocateFile); + Q_INVOKABLE static QList locateAll(QStandardPaths::StandardLocation type, const QString &fileName, QStandardPaths::LocateOptions options = QStandardPaths::LocateFile); + Q_INVOKABLE static void setTestModeEnabled(bool testMode); + Q_INVOKABLE static QList standardLocations(QStandardPaths::StandardLocation type); + Q_INVOKABLE static QUrl writableLocation(QStandardPaths::StandardLocation type); + +private: + Q_DISABLE_COPY(QQuickPlatformStandardPaths) +}; + +QT_END_NAMESPACE + +QML_DECLARE_TYPE(QQuickPlatformStandardPaths) + +#endif // QQUICKPLATFORMSTANDARDPATHS_P_H diff --git a/src/imports/platform/qtlabsplatformplugin.cpp b/src/imports/platform/qtlabsplatformplugin.cpp index b2a3aa09..1762e267 100644 --- a/src/imports/platform/qtlabsplatformplugin.cpp +++ b/src/imports/platform/qtlabsplatformplugin.cpp @@ -51,8 +51,13 @@ #include "qquickplatformmenuitemgroup_p.h" #include "qquickplatformmenuseparator_p.h" +#include "qquickplatformstandardpaths_p.h" + #include "qquickplatformsystemtrayicon_p.h" +Q_DECLARE_METATYPE(QStandardPaths::StandardLocation) +Q_DECLARE_METATYPE(QStandardPaths::LocateOptions) + static inline void initResources() { #ifdef QT_STATIC @@ -89,7 +94,6 @@ void QtLabsPlatformPlugin::registerTypes(const char *uri) qmlRegisterType(uri, 1, 0, "FolderDialog"); qmlRegisterType(uri, 1, 0, "FontDialog"); qmlRegisterType(uri, 1, 0, "MessageDialog"); - qmlRegisterUncreatableType(uri, 1, 0, "StandardButton", QQuickPlatformDialog::tr("Cannot create an instance of StandardButton")); qmlRegisterType(uri, 1, 0, "Menu"); qmlRegisterType(uri, 1, 0, "MenuBar"); @@ -97,6 +101,11 @@ void QtLabsPlatformPlugin::registerTypes(const char *uri) qmlRegisterType(uri, 1, 0, "MenuItemGroup"); qmlRegisterType(uri, 1, 0, "MenuSeparator"); + qmlRegisterUncreatableType(uri, 1, 0, "StandardButton", QQuickPlatformDialog::tr("Cannot create an instance of StandardButton")); + qmlRegisterSingletonType(uri, 1, 0, "StandardPaths", QQuickPlatformStandardPaths::create); + qRegisterMetaType(); + qRegisterMetaType(); + qmlRegisterType(uri, 1, 0, "SystemTrayIcon"); } -- cgit v1.2.3