Warning: That file was not part of the compilation database. It may have many parsing errors.

1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:FDL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Free Documentation License Usage
18** Alternatively, this file may be used under the terms of the GNU Free
19** Documentation License version 1.3 as published by the Free Software
20** Foundation and appearing in the file included in the packaging of
21** this file. Please review the following information to ensure
22** the GNU Free Documentation License version 1.3 requirements
23** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29\page qtquick-index.html
30\title Qt Quick
31\brief The Qt Quick module implements the "standard library" for QML
32
33The Qt Quick module is the standard library for writing QML applications.
34While the \l{Qt QML} module provides the QML engine and
35language infrastructure, the Qt Quick module provides all the basic
36types necessary for creating user interfaces with QML. It
37provides a visual canvas and includes types for creating and animating
38visual components, receiving user input, creating data models and views
39and delayed object instantiation.
40
41The Qt Quick module provides both a \l{Qt Quick QML Types}{QML API} which supplies
42QML types for creating user interfaces with the QML language, and a
43\l{Qt Quick C++ Classes}{C++ API} for extending QML applications with C++ code.
44
45\note A set of Qt Quick-based UI controls is also available to create user
46interfaces. See \l{Qt Quick Controls 2} for more information.
47
48For those new to QML and Qt Quick, please see
49\l{QML Applications}
50for an introduction to writing QML applications.
51
52\section1 Important Concepts in Qt Quick
53
54Qt Quick provides everything needed to create a rich application with a fluid
55and dynamic user interface. It enables user interfaces to be built around the
56behavior of user interface components and how they connect with one another,
57and it provides a visual canvas with its own coordinate system and rendering
58engine. Animation and transition effects are a first class concept in Qt Quick,
59and visual effects can be supplemented through specialized components for
60particle and shader effects.
61
62\list
63\li \l{Important Concepts In Qt Quick - The Visual Canvas}{The Visual Canvas}
64\li \l{Important Concepts In Qt Quick - User Input}{User Input}
65\li \l{Important Concepts In Qt Quick - Positioning}{Positioning}
66\li \l{Important Concepts in Qt Quick - States, Transitions and Animations}{States, Transitions And Animations}
67\li \l{Important Concepts In Qt Quick - Data - Models, Views and Data Storage}{Data - Models, Views and Data Storage}
68\li \l{Important Concepts In Qt Quick - Graphical Effects}{Particles And Graphical Effects}
69\li \l{Important Concepts In Qt Quick - Convenience Types}{Convenience Types}
70\endlist
71
72When using the \c QtQuick module, you will need to know how to write QML
73applications using the QML language. In particular, QML Basics and QML
74Essentials from the \l{QML Applications} page.
75
76To find out more about using the QML language, see the \l{Qt QML} module documentation.
77
78\section1 C++ Extension Points
79
80\list
81 \li \l{C++ Extension Points Provided By Qt Quick}{C++ Extension Points}
82 \list
83 \li \l{user-defined-qquickitem-derived-types}{Creating User-Defined QQuickItem-Derived Types}
84 \li \l{scene-graph-related-classes}{Scene Graph-Related Classes}
85 \li \l{pixmap-and-threaded-image-support}{Pixmap and Threaded Image Support}
86 \endlist
87\endlist
88
89\section1 Licenses and Attributions
90
91Qt Quick is available under commercial licenses from \l{The Qt Company}.
92In addition, it is available under free software licenses. Since Qt 5.4,
93these free software licenses are
94\l{GNU Lesser General Public License, version 3}, or
95the \l{GNU General Public License, version 2}.
96See \l{Qt Licensing} for further details.
97
98\section1 Reference Documentation
99
100Additional Qt Quick information:
101\list
102\li \l{Qt Quick C++ Classes} - the C++ API provided by the
103 Qt Quick module
104\li \l{Qt Quick QML Types} - a list of QML types provided by the
105 \c{QtQuick} import
106 \list
107 \li \l{Qt Quick XmlListModel QML Types}{XML List Model} - contains types
108 for creating models from XML data
109 \li \l{Qt Quick Local Storage QML Types}{Local Storage} - a submodule
110 containing a JavaScript interface for an SQLite database
111 \li \l{Qt Quick Particles QML Types}{Particles} - provides a particle
112 system for Qt Quick
113 \li \l{Qt Quick Layouts}{Layouts} - provides layouts for arranging Qt Quick items
114 \li \l{Qt Quick Window QML Types}{Window} - contains types for creating
115 top-level windows and accessing screen information
116 \li \l{Qt Quick Dialogs}{Dialogs} - contains types for creating and
117 interacting with system dialogs
118 \li \l{Qt Quick Test QML Types}{Tests} - contains types for writing unit test for a QML application
119 \endlist
120\li \l{Qt Quick Examples and Tutorials}
121\li \l{Best Practices for QML and Qt Quick}{Qt Quick Guidelines}
122\endlist
123
124Further information for writing QML applications:
125\list
126\li \l{QML Applications}
127 - essential information for application development with QML and Qt Quick
128\li \l{Qt QML} - documentation for the
129 Qt QML module, which provides the QML engine and language infrastructure
130\endlist
131*/
132

Warning: That file was not part of the compilation database. It may have many parsing errors.