diff options
Diffstat (limited to 'src/imports/platform/doc/src')
3 files changed, 137 insertions, 0 deletions
diff --git a/src/imports/platform/doc/src/includes/widgets.qdocinc b/src/imports/platform/doc/src/includes/widgets.qdocinc new file mode 100644 index 00000000..c89c3ca0 --- /dev/null +++ b/src/imports/platform/doc/src/includes/widgets.qdocinc @@ -0,0 +1,29 @@ +//! [1] +The Qt Labs Platform module uses Qt Widgets as a fallback on platforms that +do not have a native implementation available. Therefore, applications that +use types from the Qt Labs Platform module should link to QtWidgets and use +\l QApplication instead of \l QGuiApplication. + +To link against the QtWidgets library, add the following to your qmake project +file: + +\code +QT += widgets +\endcode + +Create an instance of \l QApplication in \c main(): + +\code +#include <QApplication> +#include <QQmlApplicationEngine> + +int main(int argc, char *argv[]) +{ + QApplication::setAttribute(Qt::AA_EnableHighDpiScaling); + QApplication app(argc, argv); + QQmlApplicationEngine engine; + engine.load(QUrl(QStringLiteral("qrc:/main.qml"))); + return app.exec(); +} +\endcode +//! [1] diff --git a/src/imports/platform/doc/src/qtlabsplatform-index.qdoc b/src/imports/platform/doc/src/qtlabsplatform-index.qdoc new file mode 100644 index 00000000..aec2a923 --- /dev/null +++ b/src/imports/platform/doc/src/qtlabsplatform-index.qdoc @@ -0,0 +1,50 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** 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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtlabsplatform-index.html + \title Qt Labs Platform + + \brief The experimental Qt Labs Platform module provides QML types for + native platform extensions. + + The experimental Qt Labs Platform module provides QML types for native + platform extensions. The module was introduced in Qt 5.8. + + \section1 QML Types + + \generatelist {qmltypesbymodule Qt.labs.platform} + + \labs + + \section1 Related Information + + \list + \li \l{Qt Quick} + \li \l{Qt Quick Controls 2} + \endlist +*/ diff --git a/src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc b/src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc new file mode 100644 index 00000000..470b93c4 --- /dev/null +++ b/src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** 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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmlmodule Qt.labs.platform 1.0 + \title Qt Labs Platform QML Types + \ingroup qmlmodules + \brief Provides QML types for native platform extensions. + + The experimental \l{Qt Labs Platform} module provides QML types for native + platform extensions. These QML types work in conjunction with \l{Qt Quick} + and \l{Qt Quick Controls 2}. + + The QML types can be imported into your application using the + following import statement in your .qml file: + + \badcode + import Qt.labs.platform 1.0 + \endcode + + \section1 QML Types + + \generatelist {qmltypesbymodule Qt.labs.platform} + + \labs + + \section1 Related Information + + \list + \li \l {Qt Quick Controls 2 QML Types} + \endlist + + \noautolist +*/ |