Merge branch 'newdocs'
[profile/ivi/qtdeclarative.git] / src / quick / doc / src / examples.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29
30 \page qtquick-codesamples.html
31 \title Qt Quick Code Samples
32 \brief Building UIs with QML
33 \ingroup all-examples
34 \ingroup qtquick
35 \target qtquick-samples
36 \inqmlmodule QtQuick 2
37
38 These are code samples that show how to use various aspects of Qt Quick. Larger
39 compound interfaces are grouped as applications as they demonstrate more Qt
40 Quick features.
41
42 To run the sample applications, open them in Qt Creator or use the included
43 \l {Prototyping with qmlscene}{qmlscene} tool.
44
45 Some of these code samples have a corresponding \l{qtquick-tutorials}{tutorial}.
46 The Qt Quick features are covered in the \l {qtquick-overviews}{main page}.
47 This set of code samples are part of the collection of \l{Qt Examples}.
48
49 \div {class="threecolumn_area"}
50     \div {class="heading"}
51     QML Examples
52     \enddiv
53     Code samples demonstrate a general use for QML features. Some showcase
54     how elements or properties can be used in an application.
55     \li \l{quick/keyinteraction}{Keyboard Focus}
56     \li \l{quick/mousearea}{MouseArea}
57     \li \l{quick/animation}{Animations}
58     \li \l{quick/positioners}{Positioners}
59     \li \l{quick/righttoleft}{Right to Left}
60     \li \l{quick/modelviews}{Model Views}
61     \li \l{quick/imageelements}{Image Elements}
62     \li \l{localstorage}{SQL Local Storage}
63     \li \l{qml/xmlhttprequest}{XmlHttpRequest}
64     \li \l{qml/i18n}{Translation}
65     \li \l{quick/threading}{Threading}
66     \li \l{quick/shadereffects}{Shader Effects}
67     \endlist
68 \enddiv
69 \div {class="threecolumn_area"}
70     \div {class="heading"}
71         QDeclarative Examples
72     \enddiv
73     These examples show how a QML based UI could interact with the
74     QDeclarative module.
75     \div {class="threecolumn_piece"}
76         \div {class="heading"}
77         From Qt C++ to QML
78         \enddiv
79         \list
80         \li \l {qml/cppextensions/referenceexamples/adding}{Exporting C++ Classes}
81         \li \l {qml/cppextensions/referenceexamples/properties}{Exporting Qt C++ Properties}
82         \li \l {qml/cppextensions/referenceexamples/coercion}{C++ Inheritance and Coercion}
83         \li \l {qml/cppextensions/referenceexamples/default}{Default Property}
84         \li \l {qml/cppextensions/referenceexamples/grouped}{Grouped Properties}
85         \li \l {qml/cppextensions/referenceexamples/attached}{Attached Properties}
86         \li \l {qml/cppextensions/referenceexamples/signal}{Signal Support}
87         \li \l {qml/cppextensions/referenceexamples/methods}{Methods Support}
88         \li \l {qml/cppextensions/referenceexamples/valuesource}{Property Value Source}
89         \li \l {qml/cppextensions/referenceexamples/binding}{Binding}
90         \endlist
91     \enddiv
92     \div {class="threecolumn_piece"}
93         \div {class="heading"}
94         Plugins and Resources
95         \enddiv
96         \list
97         \li \l{qml/cppextensions/plugins}{Plugins}
98         \li \l{qml/cppextensions/imageprovider}{Image Provider}
99         \li \l{qml/cppextensions/networkaccessmanagerfactory}{Network Access Manager}
100         \li \l{src/imports/folderlistmodel}{Folder List Model} - a C++ model plugin
101         \endlist
102     \enddiv
103     \div {class="threecolumn_piece"}
104         \div {class="heading"}
105         Qt UI and QML Integration
106         \enddiv
107         \list
108         \li \l{qml-cppextensions-qgraphicslayouts.html}{QGraphicsLayouts}
109         \li \l{qml/cppextensions/qwidgets}{QWidgets}
110         \endlist
111     \enddiv
112     \div {class="threecolumn_piece"}
113         \div {class="heading"}
114         UI Components
115         \enddiv
116         \list
117         \li \l{tutorials/ui-components/dialcontrol}{Dial Control}
118         \li \l{tutorials/ui-components/flipable}{Flipable}
119         \li \l{tutorials/ui-components/progressbar}{Progress Bar}
120         \li \l{tutorials/ui-components/scrollbar}{Scroll Bar}
121         \li \l{tutorials/ui-components/searchbox}{Search Box}
122         \li \l{tutorials/ui-components/slideswitch}{Slide Switch}
123         \li \l{tutorials/ui-components/spinner}{Spinner}
124         \li \l{tutorials/ui-components/tabwidget}{Tab Widget}
125         \endlist
126     \enddiv
127 \enddiv
128
129 \div {class="threecolumn_area"}
130     \div {class="heading"}
131         Learning and Resources
132     \enddiv
133     The Qt Developer Network contains additional content such as learning
134     videos, a wiki, and a forum for posting questions.
135     \div {class="threecolumn_piece"}
136         \div {class="heading"}
137             Elements and Components
138         \enddiv
139         \list
140         \li \l{QML Types provided by the QtQuick Module}
141         \li \l{external: Qt Mobility QML Plugins}{QML Plugins}
142         \li \l{external: Qt Quick Components for Symbian}{Symbian Components}
143         \li MeeGo Components
144         \li \l{QtWebKit QML Module}
145         \endlist
146     \enddiv
147     \div {class="threecolumn_piece"}
148         \div {class="heading"}
149             Qt Developer Network
150         \enddiv
151         \list
152         \li \l{Qt eLearning}{Training Materials}
153         \li \l{Forums on Qt Developer Network}{Forums}
154         \li \l{Wiki on Qt Developer Network}{Wiki}
155         \endlist
156     \enddiv
157     \div {class="threecolumn_piece"}
158         \div {class="heading"}
159             Reference
160         \enddiv
161         \list
162         \li \l{All Classes}{Qt API}
163         \li \l{external: Qt Creator Manual}{Qt Creator Manual}
164         \li \l{Develop with Qt}
165         \endlist
166     \enddiv
167 \enddiv
168 */