diff options
Diffstat (limited to 'src/controls/doc')
-rw-r--r-- | src/controls/doc/qtquickcontrols2.qdocconf | 42 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols2-index.qdoc | 48 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols2-overview.qdoc | 58 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols2.qdoc | 44 |
4 files changed, 192 insertions, 0 deletions
diff --git a/src/controls/doc/qtquickcontrols2.qdocconf b/src/controls/doc/qtquickcontrols2.qdocconf new file mode 100644 index 00000000..993493d5 --- /dev/null +++ b/src/controls/doc/qtquickcontrols2.qdocconf @@ -0,0 +1,42 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtQuickControls2 +description = Qt Quick Controls 2 Reference Documentation +version = $QT_VERSION + +qhp.projects = QtQuickControls2 + +qhp.QtQuickControls2.file = qtquickcontrols2.qhp +qhp.QtQuickControls2.namespace = org.qt-project.qtquickcontrols2.$QT_VERSION_TAG +qhp.QtQuickControls2.virtualFolder = qtquickcontrols2 +qhp.QtQuickControls2.indexTitle = Qt Quick Controls 2 +qhp.QtQuickControls2.indexRoot = + +qhp.QtQuickControls2.filterAttributes = qtquickcontrols2 $QT_VERSION qtrefdoc +qhp.QtQuickControls2.customFilters.Qt.name = QtQuickControls2 $QT_VERSION +qhp.QtQuickControls2.customFilters.Qt.filterAttributes = qtquickcontrols2 $QT_VERSION + +qhp.QtQuickControls2.subprojects = qtquickcontrols2qmltypes + +qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.title = Controls 2 QML Types +qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.indexTitle = Qt Quick Controls 2 QML Types +qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.selectors = qmlclass # cannot choose qmltypes from a specific group QTBUG-32985 +qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.sortPages = true + +depends = qtcore qtgui qtdoc qtqml qtquick qtquicklayouts qtquickdialogs + +# Specify the install path under QT_INSTALL_EXAMPLES +# Examples will be installed under quick/controls - 'controls' subdirectory +# is given as part of \example commands +exampledirs += ../../../examples/quick/controls +examplesinstallpath = quick/controls + +headerdirs += ../ +sourcedirs += ../ + +imagedirs += images + +navigation.landingpage = "Qt Quick Controls 2" +navigation.qmltypespage = "Qt Quick Controls 2 QML Types" + +tagfile = qtquickcontrols2.tags diff --git a/src/controls/doc/src/qtquickcontrols2-index.qdoc b/src/controls/doc/src/qtquickcontrols2-index.qdoc new file mode 100644 index 00000000..028e4bd4 --- /dev/null +++ b/src/controls/doc/src/qtquickcontrols2-index.qdoc @@ -0,0 +1,48 @@ +/**************************************************************************** +** +** Copyright (C) 2015 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 qtquickcontrols2-index.html + \title Qt Quick Controls 2 + + \brief The Qt Quick Controls 2 module provides a set of UI controls for Qt Quick. + + The Qt Quick Controls 2 module provides a set of controls that can be used to + build complete interfaces in Qt Quick. + + The module is new in Qt 5.6. + + Visit the \l{Qt Quick Controls 2 Overview} page to get started. + + \section1 Related information + + \list + \li \l{Qt Quick} + \li \l{Qt Quick Controls 2 Overview} + \li \l{Qt Quick Controls 2 QML Types}{Qt Quick Controls 2 QML Types} + \endlist +*/ diff --git a/src/controls/doc/src/qtquickcontrols2-overview.qdoc b/src/controls/doc/src/qtquickcontrols2-overview.qdoc new file mode 100644 index 00000000..2140aa55 --- /dev/null +++ b/src/controls/doc/src/qtquickcontrols2-overview.qdoc @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** Copyright (C) 2015 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 qtquickcontrols2-overview.html + \title Qt Quick Controls 2 Overview + \brief A set of UI controls to create user interfaces in Qt Quick + + The Qt Quick Controls 2 provide a set of UI controls to create user interfaces + in Qt Quick. + + \section1 Getting Started + + TODO + + \section1 Setting Up Controls from C++ + + TODO + + \section2 Using C++ Data From QML + + TODO + + \section2 Deploying Qt Quick Controls 2 + + TODO + + \section1 Related information + + \list + \li \l{Qt Quick} + \li \l{Qt Quick Controls 2} + \endlist +*/ diff --git a/src/controls/doc/src/qtquickcontrols2.qdoc b/src/controls/doc/src/qtquickcontrols2.qdoc new file mode 100644 index 00000000..bb188eac --- /dev/null +++ b/src/controls/doc/src/qtquickcontrols2.qdoc @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** Copyright (C) 2015 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 QtQuick.Controls 2.0 + \title Qt Quick Controls 2 QML Types + \ingroup qmlmodules + \brief Provides QML types for user interfaces. + + The \l{Qt Quick Controls 2} module provides QML types for creating user + interfaces. These QML types work in conjunction with \l{Qt Quick} and + \l{Qt Quick Layouts}. + + The QML types can be imported into your application using the + following import statement in your .qml file. + + \code + import QtQuick.Controls 2.0 + \endcode +*/ |