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:FDL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in a
** written agreement between you and Nokia.
**
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** 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
    \example declarative/animation/basics

    This example shows how to create and combine \l{QML Animation}{animations} in QML.

    \table
    \row
    \o \image qml-coloranim-example.png
    \row
    \o color-animation.qml
    \endtable

    \table
    \row
    \o \image qml-propertyanim-example.png
    \row
    \o property-animation.qml
    \endtable
*/

/*!
    \title Animation: Behavior Examples
    \example declarative/animation/behaviors

    This example shows how to use QML behaviors. 

    \image qml-behaviors-example.png
*/

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

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

    \image qml-easing-example.png
*/

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

    These examples show how to use \l{States}{states} and \l{Transitions}{transitions}.

    The \c states.qml example shows how an item can change between states, and \c transitions.qml
    shows how these state changes can be animated.

    \table
    \row
    \o \image qml-states-example.png
    \row
    \o states.qml
    \endtable

    \table
    \row
    \o \image qml-transitions-example.png
    \row
    \o transitions.qml
    \endtable
*/

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

    These examples show how to use the BorderImage element.

    \table
    \row
    \o \image qml-borderimage-example.png
    \row
    \o borderimage.qml
    \endtable

    \table
    \row
    \o \image qml-borderimage-shadows-example.png
    \row
    \o shadows.qml
    \endtable
*/

/*!
    \title Image Elements: Image Example
    \example declarative/imageelements/image

    This example shows how to use the \l Image element and its \l{Image::fillMode}{fillModes}.

    \image qml-image-example.png
*/

/*!
    \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
    \example declarative/cppextensions/plugins

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

    \image qml-plugins-example.png
*/

/*!
    \title LayoutItem Example
    \example declarative/cppextensions/qgraphicslayouts/layoutitem

    This example show how to use the LayoutItem element to integrate QML items into an existing 
    \l{Graphics View Framework}{Graphics View}-based application.

    \image qml-layoutitem-example.png
*/
/*!
    \title QGraphicsGridLayout Example
    \example declarative/cppextensions/qgraphicslayouts/qgraphicsgridlayout

    This example shows how to use QGraphicsGridLayout to lay out QML items. This is 
    useful if you need to integrate Qt \l{Graphics View Framework}{Graphics View} layouts with
    QML.

    \image qml-qgraphicsgridlayout-example.png
*/
/*!
    \title QGraphicsLinearLayout Example
    \example declarative/cppextensions/qgraphicslayouts/qgraphicslinearlayout

    This example shows how to use QGraphicsLinearLayout to lay out QML items. This is 
    useful if you need to integrate Qt \l{Graphics View Framework}{Graphics View} layouts with
    QML.
    
    \image qml-qgraphicslinearlayout-example.png
*/
/*!
    \title C++ Extensions: QGraphicsLayouts examples
    \page declarative-cppextensions-qgraphicslayouts.html

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

    \list
    \o \l{declarative/cppextensions/qgraphicslayouts/layoutitem}{LayoutItem}
    \o \l{declarative/cppextensions/qgraphicslayouts/qgraphicsgridlayout}{QGraphicsGridLayout}
    \o \l{declarative/cppextensions/qgraphicslayouts/qgraphicslinearlayout}{QGraphicsLinearLayout}
    \endlist

    Also see \l {Integrating QML with existing Qt UI code} for information on using QML 
    in Qt applications that use the Graphics View framework or ordinary QWidget-based views.
*/

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

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

    \image qml-qwidgets-example.png
*/

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

    This examples shows how to use QDeclarativeImageProvider to serve images 
    to QML image elements.

    \image qml-imageprovider-example.png
*/

/*!
    \title C++ Extensions: Network Access Manager Factory Example
    \example declarative/cppextensions/networkaccessmanagerfactory

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

/*!
    \title Internationlization Example
    \example declarative/i18n

    This example shows how to enable text translation in QML.

    \image qml-i18n-example.png
*/

/*!
    \title Positioners Example
    \example declarative/positioners

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

    \image qml-positioners-example.png
*/

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

    This example shows how to handle keyboard input and focus in QML.

    \image qml-focus-example.png
*/

/*!
    \title Models and Views: AbstractItemModel Example
    \example declarative/modelviews/abstractitemmodel

    This example shows how to use a QAbstractItemModel subclass as a model in QML.

    \image qml-abstractitemmodel-example.png
*/

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

    This example shows how to use the GridView element.

    \image qml-gridview-example.png
*/

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

    These examples show how to use the ListView element.

    \table
    \row
    \o \image qml-listview-dynamiclist-example.png
    \row
    \o dynamiclist.qml
    \endtable

    \table
    \row
    \o \image qml-listview-expandingdelegates-example.png
    \row
    \o expandingdelegates.qml
    \endtable

    \table
    \row
    \o \image qml-listview-highlight-example.png
    \row
    \o highlight.qml
    \endtable

    \table
    \row
    \o \image qml-listview-highlightranges-example.png
    \row
    \o highlightranges.qml
    \endtable

    \table
    \row
    \o \image qml-listview-sections-example.png
    \row
    \o sections.qml
    \endtable
*/

/*!
    \title Models and Views: PathView Example
    \example declarative/modelviews/pathview

    This example shows how to use the PathView element.

    \image qml-pathview-example.png
*/

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

    This example shows how to use a QList<QObject*> as a model in QML.

    \image qml-objectlistmodel-example.png
*/

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

    This example shows how to use the \l Package element.

    \image qml-package-example.png
*/

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

    This example shows how to combine and switch between views.

    \image qml-parallax-example.png
*/

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

    This example shows how to use a QStringList as a model in QML.

    \image qml-stringlistmodel-example.png
*/

/*!
    \title Models and Views: VisualItemModel Example
    \example declarative/modelviews/visualitemmodel

    This example shows how to use the VisualItemModel element.

    \image qml-visualitemmodel-example.png
*/

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

    These examples shows how to use the WebView element.

    \table
    \row
    \o \image qml-webview-alert-example.png
    \row
    \o alert.qml
    \endtable

    \table
    \row
    \o \image qml-webview-autosize-example.png
    \row
    \o autosize.qml
    \endtable

    \table
    \row
    \o \image qml-webview-googlemaps-example.png
    \row
    \o googlemaps.qml
    \endtable

    \table
    \row
    \o \image qml-webview-inlinehtml-example.png
    \row
    \o inlinehtml.qml
    \endtable

    \table
    \row
    \o \image qml-webview-newwindows-example.png
    \row
    \o newwindows.qml
    \endtable
*/


/*!
    \title Screen orientation
    \example declarative/screenorientation

    This example shows how to implement screen orientation support for your application.
*/

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

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

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

    These examples show how to discover available fonts from QML and manipulate
    text in various ways.

    \table
    \row
    \o \image qml-fonts-availableFonts-example.png
    \row
    \o availableFonts.qml
    \endtable

    \table
    \row
    \o \image qml-fonts-banner-example.png
    \row
    \o banner.qml
    \endtable

    \table
    \row
    \o \image qml-fonts-fonts-example.png
    \row
    \o fonts.qml
    \endtable

    \table
    \row
    \o \image qml-fonts-hello-example.png
    \row
    \o hello.qml
    \endtable
*/

/*!
    \title Text: Text Selection Example
    \example declarative/text/textselection

    This example shows how text selection, copy and paste operations
    can be implemented on top of the TextEdit element.

    \image qml-textselection-example.png
*/

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

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

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

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

/*!
    \title Toys: Clocks Example
    \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 SpringAnimation behaviors.

    \image qml-clocks-example.png
*/

/*!
    \title Toys: Corkboards Example
    \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.

    \image qml-corkboards-example.png
*/

/*!
    \title Toys: Dynamic Scene Example
    \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.

    \image qml-dynamicscene-example.png
*/

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

    This example presents a simple implementation of Tic Tac Toe.

    \image qml-tic-tac-toe-example.png
*/

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

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

    \image qml-tvtennis-example.png
*/

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

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

/*!
    \title Touch Interaction: MouseArea Example
    \example declarative/touchinteraction/mousearea

    This example shows how to use the MouseArea element to access information
    about mouse input.

    \image qml-mousearea-example.png
*/

/*!
    \title UI Components: Dial Control Example
    \example declarative/ui-components/dialcontrol

    This example shows how to create a dial-type control. It combines
    \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors
    to produce an interactive speedometer-type dial.

    \image qml-dialcontrol-example.png
*/


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

    This example shows how to use the \l Flipable element.

    \image qml-flipable-example.png
*/

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

    This example shows how to create a progress bar.

    \image qml-progressbar-example.png
*/

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

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

    \image qml-scrollbar-example.png
*/

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

    This example shows how to combine TextInput, FocusScope and BorderImage
    elements to display multiple text input fields.

    \image qml-searchbox-example.png
*/

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

    This example shows how to create a slide switch control.

    \image qml-slideswitch-example.png
*/

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

    This example shows how to create a spinner-type component using the PathView element.

    \image qml-spinner-example.png
*/

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

    This example shows how to create a tab widget. It also demonstrates how
    \l {Setting default properties}{default properties} can be used to collect and 
    assemble the child items declared within an \l Item.

    \image qml-tabwidget-example.png
*/

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

    This example shows how to use the \l XmlHttpRequest API in QML.

    \image qml-xmlhttprequest-example.png
*/