doc/src/declarative/examples.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2015 The Qt Company Ltd.
   4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
  15 ** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29   \page qdeclarativeexamples.html
  30   \title QML Examples and Demos
  31   \brief Building UIs with QML
  32   \ingroup all-examples
  33
  34
  35 Qt includes a set of examples and demos that show how to use various aspects
  36 of QML. The examples are small demonstrations of particular QML components,
  37 while the demos contain more complete and functional applications.
  38
  39 To run the examples and demos, open them in Qt Creator or use the included
  40 \l {QML Viewer} tool. The \l {QML Viewer} can be run from the command line:
  41
  42 \code
  43     qmlviewer $QTDIR/demos/declarative/samegame/samegame.qml
  44 \endcode
  45
  46 On Mac OS X, you can run the included "QMLViewer" application from the
  47 Finder, or use the command line:
  48
  49 \code
  50     QMLViewer.app/Contents/MacOS/QMLViewer $QTDIR/demos/declarative/samegame/samegame.qml
  51 \endcode
  52
  53
  54 \section1 Demos
  55
  56 The QML demos integrate a variety of features to demonstrate how QML
  57 can be used to produce sophisticated interfaces and applications:
  58
  59
  60 \table
  61 \row
  62
  63 \o
  64 \l{demos/declarative/calculator}{Calculator}
  65 \image qml-calculator-example-small.png
  66
  67 \o
  68 \l{demos/declarative/flickr}{Flickr Mobile}
  69 \image qml-flickr-demo-small.png
  70
  71 \o
  72 \l{demos/declarative/minehunt}{Minehunt}
  73 \image qml-minehunt-demo-small.png
  74
  75 \row
  76
  77 \o
  78 \l{demos/declarative/photoviewer}{Photo Viewer}
  79 \image qml-photoviewer-demo-small.png
  80
  81 \o
  82 \l{demos/declarative/rssnews}{RSS News Reader}
  83 \image qml-rssnews-demo-small.png
  84
  85 \o
  86 \l{demos/declarative/samegame}{Same Game}
  87 \image qml-samegame-demo-small.png
  88
  89 \row
  90
  91 \o
  92 \l{demos/declarative/snake}{Snake}
  93 \image qml-snake-demo-small.png
  94
  95 \o
  96 \l{demos/declarative/twitter}{Twitter}
  97 \image qml-twitter-demo-small.png
  98
  99 \o
 100 \l{demos/declarative/webbrowser}{Web Browser}
 101 \image qml-webbrowser-demo-small.png
 102
 103 \endtable
 104
 105 The demos can be found in Qt's \c demos/declarative directory.
 106
 107
 108 \section1 Examples
 109
 110 The QML examples are small, simple applications that show how to use a particular
 111 QML component or feature. If you are new
 112 to QML, you may also find the \l{QML Tutorial}{Hello World} and
 113 \l {QML Advanced Tutorial}{Same Game} tutorials useful.
 114
 115 The examples can be found in Qt's \c examples/declarative directory.
 116
 117 \section2 Animation
 118 \list
 119 \o \l{declarative/animation/basics/color-animation}{Color Animation}
 120 \o \l{declarative/animation/behaviors/behavior-example}{Behaviors}
 121 \o \l{declarative/animation/easing}{Easing}
 122 \o \l{declarative/animation/basics/property-animation}{Property Animation}
 123 \o \l{declarative/animation/states}{States}
 124 \o \l{declarative/animation/behaviors/wigglytext}{Wiggly Text}
 125 \endlist
 126
 127 \section2 Image Elements
 128 \list
 129 \o \l{declarative/imageelements/borderimage}{BorderImage}
 130 \o \l{declarative/imageelements/image}{Image}
 131 \endlist
 132
 133 \section2 Text
 134 \list
 135 \o \l{declarative/text/fonts}{Fonts}
 136 \o \l{declarative/text/textselection}{Text Selection}
 137 \endlist
 138
 139 \section2 Positioners
 140 \list
 141 \o \l{declarative/positioners}{Example}
 142 \endlist
 143
 144 \section2 Key Interaction
 145 \list
 146 \o \l{declarative/keyinteraction/focus}{Focus}
 147 \endlist
 148
 149 \section2 Touch Interaction
 150 \list
 151 \o \l{declarative/touchinteraction/mousearea}{MouseArea}
 152 \endlist
 153
 154 \section2 UI Components
 155 \list
 156 \o \l{declarative/ui-components/dialcontrol}{Dial control}
 157 \o \l{declarative/ui-components/flipable}{Flipable}
 158 \o \l{declarative/ui-components/progressbar}{Progress bar}
 159 \o \l{declarative/ui-components/scrollbar}{Scroll bar}
 160 \o \l{declarative/ui-components/searchbox}{Search box}
 161 \o \l{declarative/ui-components/slideswitch}{Slide switch}
 162 \o \l{declarative/ui-components/spinner}{Spinner}
 163 \o \l{declarative/ui-components/tabwidget}{Tab widget}
 164 \endlist
 165
 166 \section2 Toys
 167 \list
 168 \o \l{declarative/toys/clocks}{Clocks}
 169 \o \l{declarative/toys/corkboards}{Corkboards}
 170 \o \l{declarative/toys/dynamicscene}{Dynamic Scene}
 171 \o \l{declarative/toys/tic-tac-toe}{Tic Tac Toe}
 172 \o \l{declarative/toys/tvtennis}{TV Tennis}
 173 \endlist
 174
 175 \section2 Models and Views
 176 \list
 177 \o \l{declarative/modelviews/gridview}{GridView}
 178 \o \l{Models and Views: ListView Examples}{ListView}
 179 \o \l{declarative/modelviews/pathview}{PathView}
 180 \o \l{declarative/modelviews/package}{Package}
 181 \o \l{declarative/modelviews/parallax}{Parallax}
 182 \o \l{declarative/modelviews/visualitemmodel}{VisualItemModel}
 183
 184 \o \l{declarative/modelviews/stringlistmodel}{String ListModel}
 185 \o \l{declarative/modelviews/objectlistmodel}{Object ListModel}
 186 \o \l{declarative/modelviews/abstractitemmodel}{AbstractItemModel}
 187
 188 \o \l{Models and Views: WebView Examples}{WebView}
 189 \endlist
 190
 191 \section2 XML
 192 \list
 193 \o \l{declarative/xml/xmlhttprequest}{XmlHttpRequest}
 194 \endlist
 195
 196 \section2 Internationalization (i18n)
 197 \list
 198 \o \l{declarative/i18n}{Example}
 199 \endlist
 200
 201 \section2 Right-to-left User Interfaces
 202 \list
 203 \o \l{declarative/righttoleft/layoutmirroring}{Layout mirroring}
 204 \o \l{declarative/righttoleft/layoutdirection}{Layout direction}
 205 \o \l{declarative/righttoleft/textalignment}{Text alignment}
 206 \endlist
 207
 208 \section2 Threading
 209 \list
 210 \o \l{declarative/threading/threadedlistmodel}{Threaded ListModel}
 211 \o \l{declarative/threading/workerscript}{WorkerScript}
 212 \endlist
 213
 214 \section2 Screen Orientation
 215 \list
 216 \o \l{declarative/screenorientation}{Example}
 217 \endlist
 218
 219 \section2 SQL Local Storage
 220 \list
 221 \o \l{declarative/sqllocalstorage}{Example}
 222 \endlist
 223
 224 \section2 C++ Extensions
 225 \list
 226 \o \l{declarative-cppextensions-reference.html}{Reference examples}
 227 \o \l{declarative/cppextensions/plugins}{Plugins}
 228 \o \l{declarative-cppextensions-qgraphicslayouts.html}{QGraphicsLayouts}
 229 \o \l{declarative/cppextensions/qwidgets}{QWidgets}
 230 \o \l{declarative/cppextensions/imageprovider}{Image provider}
 231 \o \l{declarative/cppextensions/networkaccessmanagerfactory}{Network access manager factory}
 232 \endlist
 233
 234
 235 \section1 Labs
 236
 237 \list
 238 \o \l{src/imports/folderlistmodel}{Folder List Model} - a C++ model plugin
 239 \o \l{declarative/shadereffects}{Shader Effects}
 240 \endlist
 241
 242 */
 243