path: root/doc/src/declarative/examples.qdoc

/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
  \page qdeclarativeexamples.html
  \title QML Examples and Demos
  \brief Building UI's with QML
  \ingroup all-examples

\section1 Running the examples

You can find many simple examples in the \c examples/declarative
sub-directory that show how to use various aspects of QML. In addition, the
\c demos/declarative sub-directory contains more sophisticated demos of large
applications. These demos are intended to show integrated functionality
rather than being instructive on specific elements.

To run the examples and demos, you can use Qt Creator or the included \l {Qt Declarative UI Runtime}{qmlviewer}
command-line application. It has some useful options, revealed by:

\code
    bin/qmlviewer -help
\endcode

For example, from your build directory, run:

\code
    bin/qmlviewer $QTDIR/demos/declarative/samegame/samegame.qml
\endcode

\section1 Examples

\section2 Animation
\list
\o \l{declarative/animation/basics}{Basics}
\o \l{declarative/animation/behaviors}{Behaviors}
\o \l{declarative/animation/easing}{Easing types}
\o \l{declarative/animation/states}{States}
\endlist

\section2 Image Elements
\list
\o \l{declarative/imageelements/borderimage}{BorderImage}
\o \l{declarative/imageelements/image}{Image}
\endlist

\section2 Positioners
\list
\o \l{declarative/positioners}{Example}
\endlist

\section2 Key Interaction
\list
\o \l{declarative/keyinteraction/focus}{Focus}
\endlist

\section2 Touch Interaction
\list
\o \l{declarative/touchinteraction/gestures}{Gestures}
\o \l{declarative/touchinteraction/mousearea}{MouseArea}
\endlist

\section2 UI Components
\list
\o \l{declarative/ui-components/dialcontrol}{Dial control}
\o \l{declarative/ui-components/flipable}{Flipable}
\o \l{declarative/ui-components/progressbar}{Progress bar}
\o \l{declarative/ui-components/scrollbar}{Scroll bar}
\o \l{declarative/ui-components/searchbox}{Search box}
\o \l{declarative/ui-components/slideswitch}{Slide switch}
\o \l{declarative/ui-components/spinner}{Spinner}
\o \l{declarative/ui-components/tabwidget}{Tab widget}
\endlist

\section2 Models and Views
\list
\o \l{declarative/modelviews/gridview}{GridView}
\o \l{declarative/modelviews/listview}{ListView}
\o \l{declarative/modelviews/objectlistmodel}{Object ListModel}
\o \l{declarative/modelviews/package}{Package}
\o \l{declarative/modelviews/parallax}{Parallax}
\o \l{declarative/modelviews/stringlistmodel}{String ListModel}
\o \l{declarative/modelviews/visualitemmodel}{VisualItemModel}
\o \l{declarative/modelviews/webview}{WebView}
\endlist

\section2 XML
\list
\o \l{declarative/xml/xmlhttprequest}{XmlHttpRequest}
\endlist

\section2 Internationalization (i18n)
\list
\o \l{declarative/i18n}{Example}
\endlist

\section2 Threading
\list
\o \l{declarative/threading/threadedlistmodel}{Threaded ListModel}
\o \l{declarative/threading/workerscript}{WorkerScript}
\endlist

\section2 SQL Local Storage
\list
\o \l{declarative/sqllocalstorage}{Example}
\endlist

\section2 C++ Extensions
\list
\o \l{declarative-cppextensions-reference.html}{Reference examples}
\o \l{declarative/cppextensions/plugins}{Plugins}
\o \l{declarative-cppextensions-qgraphicslayouts.html}{QGraphicsLayouts}
\o \l{declarative/cppextensions/qwidgets}{QWidgets}
\o \l{declarative/cppextensions/imageprovider}{Image provider}
\o \l{declarative/cppextensions/networkaccessmanagerfactory}{Network access manager factory}
\endlist

\section2 Toys
\list
\o \l{declarative/toys/clocks}{Clocks}
\o \l{declarative/toys/corkboards}{Corkboards}
\o \l{declarative/toys/dynamicscene}{Dynamic Scene}
\o \l{declarative/toys/tic-tac-toe}{Tic Tac Toe}
\o \l{declarative/toys/tvtennis}{TV Tennis}
\endlist


\section1 Demos

\list
\o \l{demos/declarative/calculator}{Calculator}
\o \l{demos/declarative/flickr}{Flickr Mobile}
\o \l{demos/declarative/minehunt}{Minehunt}
\o \l{demos/declarative/photoviewer}{Photo Viewer}
\o \l{demos/declarative/rssnews}{RSS News Reader}
\o \l{demos/declarative/samegame}{Same Game}
\o \l{demos/declarative/snake}{Snake}
\endlist

\section1 Labs

\list
\o \l{src/imports/folderlistmodel}{Folder List Model} - a C++ model plugin
\endlist

*/