diff options
Diffstat (limited to 'src/quickdialogs2/quickdialogs2/doc')
-rw-r--r-- | src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-filedialog-gtk.png | bin | 0 -> 39560 bytes | |||
-rw-r--r-- | src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-fontdialog-gtk.png | bin | 0 -> 32399 bytes | |||
-rw-r--r-- | src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf | 40 | ||||
-rw-r--r-- | src/quickdialogs2/quickdialogs2/doc/src/includes/fallback.qdocinc | 1 | ||||
-rw-r--r-- | src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc | 68 | ||||
-rw-r--r-- | src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-qmltypes.qdoc | 46 |
6 files changed, 155 insertions, 0 deletions
diff --git a/src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-filedialog-gtk.png b/src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-filedialog-gtk.png Binary files differnew file mode 100644 index 0000000000..9360d747a2 --- /dev/null +++ b/src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-filedialog-gtk.png diff --git a/src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-fontdialog-gtk.png b/src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-fontdialog-gtk.png Binary files differnew file mode 100644 index 0000000000..0c6217bdb4 --- /dev/null +++ b/src/quickdialogs2/quickdialogs2/doc/images/qtquickdialogs-fontdialog-gtk.png diff --git a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf new file mode 100644 index 0000000000..b41c30ca1d --- /dev/null +++ b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf @@ -0,0 +1,40 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/config/exampleurl-qtquickcontrols2.qdocconf) + +project = QtQuickDialogs +description = Qt Quick Dialogs Reference Documentation +version = $QT_VERSION + +qhp.projects = QtQuickDialogs + +qhp.QtQuickDialogs.file = qtquickdialogs.qhp +qhp.QtQuickDialogs.namespace = org.qt-project.qtquickdialogs.$QT_VERSION_TAG +qhp.QtQuickDialogs.virtualFolder = qtquickdialogs +qhp.QtQuickDialogs.indexTitle = Qt Quick Dialogs +qhp.QtQuickDialogs.indexRoot = + +qhp.QtQuickDialogs.filterAttributes = qtquickdialogs $QT_VERSION qtrefdoc +qhp.QtQuickDialogs.customFilters.Qt.name = QtQuickDialogs $QT_VERSION +qhp.QtQuickDialogs.customFilters.Qt.filterAttributes = qtquickdialogs $QT_VERSION + +qhp.QtQuickDialogs.subprojects = qmltypes +qhp.QtQuickDialogs.subprojects.qmltypes.title = QML Types +qhp.QtQuickDialogs.subprojects.qmltypes.indexTitle = Qt Quick Dialogs QML Types +qhp.QtQuickDialogs.subprojects.qmltypes.selectors = qmlclass +qhp.QtQuickDialogs.subprojects.qmltypes.sortPages = true + +depends = qtcore qtgui qtdoc qtqml qtquick qtquickcontrols qtlabsplatform + +# This module has no documented C++ types, clear the module header +moduleheader = + +headerdirs += .. +sourcedirs += .. \ + src + +imagedirs += images + +navigation.landingpage = "Qt Quick Dialogs" +navigation.qmltypespage = "Qt Quick Dialogs QML Types" + +tagfile = qtquickdialogs.tags diff --git a/src/quickdialogs2/quickdialogs2/doc/src/includes/fallback.qdocinc b/src/quickdialogs2/quickdialogs2/doc/src/includes/fallback.qdocinc new file mode 100644 index 0000000000..f3a4a1805b --- /dev/null +++ b/src/quickdialogs2/quickdialogs2/doc/src/includes/fallback.qdocinc @@ -0,0 +1 @@ +Qt Quick Dialogs uses a Qt Quick implementation as a fallback on platforms that do not have a native implementation available. diff --git a/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc new file mode 100644 index 0000000000..92a25c3fd4 --- /dev/null +++ b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://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 https://www.qt.io/terms-conditions. For further +** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtquickdialogs-index.html + \title Qt Quick Dialogs + + \brief Provides QML types for creating and interacting with system dialogs. + + The Qt Quick Dialogs module allows to create and interact with system dialogs + from QML. The module was introduced in Qt 6.2. + + \section1 Using the Module + + The \l{Qt Quick Dialogs QML Types}{QML types} can be imported into your + application using the following import statement in your \c {.qml} file: + + \qml + import QtQuick.Dialogs + \endqml + + \section1 License and Attributions + + Qt Quick Dialogs is available under commercial licenses from \l{The Qt Company}. + In addition, it is available under the + \l{GNU Lesser General Public License, version 3}, or + the \l{GNU General Public License, version 2}. + See \l{Qt Licensing} for further details. + + \section1 Reference + + \list + \li \l{Qt Quick Dialogs QML Types}{QML Types} + \endlist + + \section1 Related Modules + + \list + \li \l{Qt Quick} + \li \l{Qt Quick Controls} + \li \l{Qt Quick Templates 2} + \li \l{Qt Labs Platform} + \endlist +*/ diff --git a/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-qmltypes.qdoc b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-qmltypes.qdoc new file mode 100644 index 0000000000..748df4ab85 --- /dev/null +++ b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-qmltypes.qdoc @@ -0,0 +1,46 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://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 https://www.qt.io/terms-conditions. For further +** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmlmodule QtQuick.Dialogs + \title Qt Quick Dialogs QML Types + \ingroup qmlmodules + \brief Provides QML types for creating and interacting with system dialogs. + + The Qt Quick Dialogs module allows to create and interact with system dialogs + from QML. The module was introduced in Qt 6.2. + + The QML types can be imported into your + application using the following import statement in your \c {.qml} file: + + \qml + import QtQuick.Dialogs + \endqml + + \section1 QML Types + +*/ |