aboutsummaryrefslogtreecommitdiffstats
path: root/src/quicktemplates/doc/src/qtquicktemplates-index.qdoc
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2022-11-23 16:50:43 +0800
committerMitch Curtis <mitch.curtis@qt.io>2022-12-01 10:26:28 +0800
commit8b100bed5237b1ec864f059d7fb04b94fd874f49 (patch)
tree3e0503297e0dcdee3ea6245f480b9ce65766a056 /src/quicktemplates/doc/src/qtquicktemplates-index.qdoc
parent4bd87b903b355b53e3105ba1ae7c154c4e55cdaf (diff)
Doc: remove "2" from Qt Quick Controls files
Work on this was already started for the documentation in 1abdfe5d5a052f2298b7bf657513dfa7e0c66a56. The CMake target (docs_QuickControls2) probably can't be renamed until we rename the library, which won't happen until Qt 7. Task-number: QTBUG-95413 Change-Id: Ied20805a91286436606577c3de39671a447f27dd Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Diffstat (limited to 'src/quicktemplates/doc/src/qtquicktemplates-index.qdoc')
-rw-r--r--src/quicktemplates/doc/src/qtquicktemplates-index.qdoc34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/quicktemplates/doc/src/qtquicktemplates-index.qdoc b/src/quicktemplates/doc/src/qtquicktemplates-index.qdoc
new file mode 100644
index 0000000000..49d4c96b44
--- /dev/null
+++ b/src/quicktemplates/doc/src/qtquicktemplates-index.qdoc
@@ -0,0 +1,34 @@
+// Copyright (C) 2017 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \page qtquicktemplates2-index.html
+ \title Qt Quick Templates 2
+ \brief A set of templates to create user interface controls in Qt Quick
+
+ Qt Quick Templates are the foundations of \l {Qt Quick Controls}. Templates
+ are non-visual implementations of controls' logic and behavior. They offer
+ an interface to visualize the controls in QML using \l {Qt Quick}.
+
+ Even though the templates aim to be as style-agnostic as possible, in some
+ cases they have to make certain assumptions about the visual structure of
+ a control. For example, a spinbox has buttons that increment and decrement
+ the value of the spinbox. In order to implement the behavior of a spinbox,
+ the spinbox template needs to know if the user is interacting with the up
+ or down button. A visual implementation of the spinbox template merely needs
+ to position the up and down buttons and visualize them in normal, pressed,
+ and disabled states. Any input event handling and state processing is taken
+ care of by the underlying template.
+
+ \section1 Module Evolution
+ \l{Changes to Qt Quick Controls} lists important changes in the
+ module API and functionality that were done for the Qt 6 series of Qt.
+
+ \section1 Related Information
+
+ \list
+ \li \l{Qt Quick}
+ \li \l{Qt Quick Controls}
+ \li \l{Qt Quick Templates 2 QML Types}
+ \endlist
+*/