path: root/doc/src/examples/qml-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$
**
****************************************************************************/

/*!
    \title Animation: Basics
    \example declarative/animation/basics

    This example shows how to create \l{QML Animation}{animations} in QML.
*/

/*!
    \title Animation: Behaviors
    \example declarative/animation/behaviors

    This example shows how to use QML behaviors. 
*/

/*!
    \title Animation: Easing types
    \example declarative/animation/easing

    This example shows the different easing modes available for \l{QML Animation}{animations}.
*/

/*!
    \title Animation: States
    \example declarative/animation/states

    This example shows how to use \l{States}{states} and \l{Transitions}{transitions}.
*/

/*!
    \title Image Elements: Border Image
    \example declarative/imageelements/borderimage

    This example shows how to use the BorderImage element.
*/

/*!
    \page declarative-cppextensions-reference.html
    \title C++ Extensions: Reference examples

    These examples show how QML can be extended from C++ in various ways. 
    
    The code for these examples is used throughout the \l {Extending QML in C++} reference
    documentation, which highlights the main principles demonstrated in each example.

    Furthermore, here are additional pages that discuss each example in detail:

    \list
    \o \l {declarative/cppextensions/referenceexamples/adding}{Adding Types}
    \o \l {declarative/cppextensions/referenceexamples/properties}{Object and List Property Types}
    \o \l {declarative/cppextensions/referenceexamples/coercion}{Inheritance and Coercion}
    \o \l {declarative/cppextensions/referenceexamples/default}{Default Property}
    \o \l {declarative/cppextensions/referenceexamples/grouped}{Grouped Properties}
    \o \l {declarative/cppextensions/referenceexamples/attached}{Attached Properties}
    \o \l {declarative/cppextensions/referenceexamples/signal}{Signal Support}
    \o \l {declarative/cppextensions/referenceexamples/valuesource}{Property Value Source}
    \o \l {declarative/cppextensions/referenceexamples/binding}{Binding}
    \endlist

    \note These examples all print information to the console to demonstrate the concepts presented.
    Ensure that you are able to view the application output when running these examples.
    For example, the dbgView tool on Windows can be used to display application output.
*/

/*!
    \title C++ Extensions: Plugins
    \example declarative/cppextensions/plugins

    This example shows how to create a C++ plugin extension by subclassing QDeclarativeExtensionPlugin.
*/

/*!
    \title Graphics Layouts
    \example declarative/cppextensions/qgraphicslayouts/graphicsLayouts

    This example show how to integrate Qt \l{Graphics View Framework}{Graphics View} components
    like QGraphicsLayoutItem, QGraphicsLinearLayout and QGraphicsGridLayout into QML.
*/
/*!
    \title Layout Item
    \example declarative/cppextensions/qgraphicslayouts/layoutItem

    This example show how to integrate QML into an existing 
    \l{Graphics View Framework}{Graphics View}-based application.
*/
/*!
    \page declarative-cppextensions-qgraphicslayouts.html
    \title C++ Extensions: QGraphicsLayouts

    These examples show how to integrate \l{Graphics View Framework}{Graphics View}
    layout components with QML:

    \list
    \o \l{declarative/cppextensions/qgraphicslayouts/graphicsLayouts}{Graphics Layouts}
    \o \l{declarative/cppextensions/qgraphicslayouts/layoutItem}{Layout Item}
    \endlist
*/

/*!
    \title C++ Extensions: QWidgets
    \example declarative/cppextensions/qwidgets

    This example shows how to embed QWidget-based objects into QML using QGraphicsProxyWidget.
*/

/*!
    \title C++ Extensions: Image Provider
    \example declarative/cppextensions/imageprovider

    This examples shows how to use QDeclarativeImageProvider to serve images asynchronously
    into a QML item.
*/

/*!
    \title C++ Extensions: Network access manager
    \example declarative/cppextensions/networkaccessmanagerfactory

    This example shows how to use QDeclarativeNetworkAccessManagerFactory to create a QNetworkAccessManager
    with a proxy.
*/

/*!
    \title Internationlization
    \example declarative/i18n

    This example shows how to enable text translation in QML.
*/

/*!
    \title Positioners
    \example declarative/positioners

    This example shows how to use positioner elements such as Row, Column,
    Grid and Flow.
*/

/*!
    \title Key Interaction: Focus
    \example declarative/keyinteraction/focus

    This example shows how to handle keys and focus in QML.

    \image qml-focus-example.png
*/

/*!
    \title Models and Views: GridView
    \example declarative/modelviews/gridview

    This example shows how to use the GridView element.
*/

/*!
    \title Models and Views: ListView
    \example declarative/modelviews/listview

    This example shows how to use the ListView element.
*/

/*!
    \title Models and Views: Object ListModel
    \example declarative/modelviews/objectlistmodel

    This example shows how to create a C++ extension that exposes a
    QList<QObject*> as a model in QML.
*/

/*!
    \title Models and Views: Package
    \example declarative/modelviews/package

    This example shows how to use the Package element.
*/

/*!
    \title Models and Views: Parallax
    \example declarative/modelviews/parallax

    This example shows how to combine and switch between views.
*/

/*!
    \title Models and Views: String ListModel
    \example declarative/modelviews/stringlistmodel

    This example shows how to create a C++ extension that exposes a
    QStringList as a model in QML.
*/

/*!
    \title Models and Views: WebView
    \example declarative/modelviews/webview

    This example shows how to use the WebView element.
*/

/*!
    \title SQL Local Storage
    \example declarative/sqllocalstorage

    This example shows how to use the SQL Local Storage API in QML.
*/

/*!
    \title Text: Fonts
    \example declarative/text/fonts

    This example shows how to discover available fonts from QML and use
    fonts in different ways.
*/

/*!
    \title Threading: Threaded ListModel
    \example declarative/threading/threadedlistmodel

    This example shows how to use a ListModel from multiple threads using
    WorkerScript.
*/

/*!
    \title Threading: WorkerScript
    \example declarative/threading/workerscript

    This example shows how to use the WorkerScript element for threading in QML.
*/

/*!
    \title Toys: Clocks
    \example declarative/toys/clocks

    This example displays a set of clocks with different times for different cities.
    Each clock is created by combining \l Image elements with \l Rotation transforms 
    and \l SpringFollow animations.
*/

/*!
    \title Toys: Corkboards
    \example declarative/toys/corkboards

    This example presents a flickable set of interactive corkboards. It is created
    through a combination of elements like \l ListModel, \l Repeater and \l TextEdit
    together with rotation and scaling transforms, animation and mouse interaction.
*/

/*!
    \title Toys: Dial
    \example declarative/toys/dial

    This example presents an interactive speedometer-type dial by combining
    \l Image elements with \l Rotation transforms and \l SpringFollow animations.
*/

/*!
    \title Toys: Dynamic Scene
    \example declarative/toys/dynamicscene

    This example presents an interactive drag-and-drop scene. It demonstrates
    how to use QML's \l{Dynamic Object Creation} support to dynamically create and
    destroy objects.
*/

/*!
    \title Toys: Tic-Tac-Toe
    \example declarative/toys/tic-tac-toe

    This example presents a simple implementation of Tic Tac Toe.
*/

/*!
    \title Toys: TV Tennis
    \example declarative/toys/tvtennis

    This example shows how to use animation components such as \l SpringFollow,
    \l SequentialAnimation and \l PropertyAction to create a game of TV tennis.
*/

/*!
    \title Touch Interaction: Gestures
    \example declarative/touchinteraction/gestures

    This example shows how to use the GestureArea element.
*/

/*!
    \title Touch Interaction: Mouse Area
    \example declarative/touchinteraction/mousearea

    This example shows how to use the MouseArea element.
*/

/*!
    \title UI Components: Flipable
    \example declarative/ui-components/flipable

    This example shows how to use the Flipable element.
*/

/*!
    \title UI Components: Progress Bars
    \example declarative/ui-components/progressbar

    This example shows how to create a progress bar.
*/

/*!
    \title UI Components: Scroll Bar
    \example declarative/ui-components/scrollbar

    This example shows how to create scroll bars for a Flickable element
    using the \l {Flickable::visibleArea.xPosition}{Flickable::visibleArea}
    properties.
*/

/*!
    \title UI Components: Search Box
    \example declarative/ui-components/searchbox

    This example shows how to create a search box.
*/

/*!
    \title UI Components: Slide Switch
    \example declarative/ui-components/slideswitch

    This example shows how to create a slide switch.
*/

/*!
    \title UI Components: Spinner
    \example declarative/ui-components/spinner

    This example shows how to create a spinner-type component.
*/

/*!
    \title UI Components: Tab Widget
    \example declarative/ui-components/tabwidget

    This example shows how to create a tab widget.
*/

/*!
    \title XML: XMLHttpRequest
    \example declarative/xml/xmlhttprequest

    This example shows how to use \l XmlHttpRequest in QML.
*/