summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorDaniel Molkentin <daniel.molkentin@nokia.com>2011-11-22 18:16:13 (GMT)
committerDaniel Molkentin <daniel.molkentin@nokia.com>2011-11-22 18:34:17 (GMT)
commit7eed617cf248e923e7b2ee49d842d5f7b2fb7816 (patch)
treef0ddaf319364b05d0233ecb16983608585c39415 /doc/src
parent702abf9b4cb062128fbae62ff0faa70f14404eac (diff)
downloadQt-7eed617cf248e923e7b2ee49d842d5f7b2fb7816.zip
Qt-7eed617cf248e923e7b2ee49d842d5f7b2fb7816.tar.gz
Qt-7eed617cf248e923e7b2ee49d842d5f7b2fb7816.tar.bz2
Help: Add \depends to all declarative examples & demos
Reviwed-By: trustme
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/examples/qml-calculator.qdoc2
-rw-r--r--doc/src/examples/qml-examples.qdoc141
-rw-r--r--doc/src/examples/qml-flickr.qdoc2
-rw-r--r--doc/src/examples/qml-folderlistmodel.qdoc1
-rw-r--r--doc/src/examples/qml-photoviewer.qdoc2
-rw-r--r--doc/src/examples/qml-rssnews.qdoc2
-rw-r--r--doc/src/examples/qml-samegame.qdoc2
-rw-r--r--doc/src/examples/qml-twitter.qdoc2
-rw-r--r--doc/src/examples/qml-webbrowser.qdoc2
9 files changed, 147 insertions, 9 deletions
diff --git a/doc/src/examples/qml-calculator.qdoc b/doc/src/examples/qml-calculator.qdoc
index 2e2cdc8..edc87e2 100644
--- a/doc/src/examples/qml-calculator.qdoc
+++ b/doc/src/examples/qml-calculator.qdoc
@@ -31,5 +31,7 @@
\brief The Qt Quick Calculator demo shows how to write a simple calculator application in QML and JavaScript.
+ \depends helper/qmlapplicationviewer
+
\image qml-calculator-example.png
*/
diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc
index bde2ed7..52fa2e4 100644
--- a/doc/src/examples/qml-examples.qdoc
+++ b/doc/src/examples/qml-examples.qdoc
@@ -31,6 +31,8 @@
\brief This example shows how to create and combine \l{QML Animation}{animations} in QML.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-coloranim-example.png
@@ -44,6 +46,8 @@
\brief This example shows how to create and combine \l{QML Animation}{animations} in QML.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-propertyanim-example.png
@@ -58,6 +62,8 @@
\brief This example shows how to use QML behaviors.
+ \depends helper/qmlapplicationviewer
+
\image qml-behaviors-example.png
*/
@@ -67,6 +73,8 @@
\brief This example shows the different easing modes available for \l{QML Animation}{animations}.
+ \depends helper/qmlapplicationviewer
+
\image qml-easing-example.png
*/
@@ -76,6 +84,8 @@
\brief These examples show how to use \l{States}{states} and \l{Transitions}{transitions}.
+ \depends helper/qmlapplicationviewer
+
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.
@@ -100,6 +110,8 @@
\brief These examples show how to use the BorderImage element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-borderimage-example.png
@@ -113,6 +125,8 @@
\brief This example shows how to use the BorderImage element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-borderimage-shadows-example.png
@@ -127,6 +141,8 @@
\brief This example shows how to use the \l Image element and its \l{Image::fillMode}{fillModes}.
+ \depends helper/qmlapplicationviewer
+
\image qml-image-example.png
*/
@@ -248,6 +264,8 @@
\brief This example shows how to enable text translation in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-i18n-example.png
\section1 Introduction
@@ -286,12 +304,16 @@
\title Right-to-left User Interfaces: Text Alignment Example
\example declarative/righttoleft/textalignment
- This example shows how the horizontal alignment of \l Text,
+ \brief This example shows how the horizontal alignment of \l Text,
\l TextInput and \l TextEdit is affected by the reading direction
- of the text and by the layout mirrroring. Click on the gray buttons
+ of the text and by the layout mirrroring.
+
+ Click on the gray buttons
shown at the bottom of the example to toggle between different
horizontal alignment options.
+ \depends helper/qmlapplicationviewer
+
\sa {QML Right-to-left User Interfaces}
*/
@@ -299,11 +321,15 @@
\title Right-to-left User Interfaces: Layout Direction Example
\example declarative/righttoleft/layoutdirection
- This example shows how to control the horizontal layout direction of
+ \ brief This example shows how to control the horizontal layout direction of
\l Row, \l Grid and \l Flow positioners, and \l ListView and \l GridView
- model views. Click on the gray buttons shown at the bottom of the example
+ model views.
+
+ Click on the gray buttons shown at the bottom of the example
to toggle the layout direction of the shown elements.
+ \depends helper/qmlapplicationviewer
+
\image qml-righttoleft-layoutdirection-example.png
\sa {QML Right-to-left User Interfaces}
@@ -314,10 +340,13 @@
\title Right-to-left User Interfaces: Layout Mirroring Example
\example declarative/righttoleft/layoutmirroring
- This example shows how to mirror the application layouts
- using \l LayoutMirroring attached property. Click on the grey button
- shown at the bottom of the example to enable or disable the
- layout mirroring.
+ \brief This example shows how to mirror the application layouts
+ using \l LayoutMirroring attached property.
+
+ Click on the grey button shown at the bottom of the example to
+ enable or disable the layout mirroring.
+
+ \depends helper/qmlapplicationviewer
\image qml-righttoleft-layoutmirroring-example.png
@@ -331,6 +360,8 @@
\brief This example shows how to use positioner elements such as \l Row, \l Column,
\l Grid and \l Flow.
+ \depends helper/qmlapplicationviewer
+
\image qml-positioners-example.png
*/
@@ -340,6 +371,8 @@
\brief This example shows how to handle keyboard input and focus in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-focus-example.png
*/
@@ -349,6 +382,8 @@
\brief This example shows how to use a QAbstractItemModel subclass as a model in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-abstractitemmodel-example.png
*/
@@ -358,6 +393,8 @@
\brief This example shows how to use the GridView element.
+ \depends helper/qmlapplicationviewer
+
\image qml-gridview-example.png
*/
@@ -369,6 +406,8 @@
and removed from a ListModel, and how these list
modifications can be animated.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-listview-dynamiclist-example.png
@@ -383,6 +422,9 @@
\brief This example shows how to create a dynamic delegate, which
expands when selected.
+ \depends helper/qmlapplicationviewer
+
+
\table
\row
\o \image qml-listview-expandingdelegates-example.png
@@ -397,6 +439,8 @@
\brief This example shows how to highlight one item
inside a ListView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-listview-highlight-example.png
@@ -411,6 +455,8 @@
\brief This example shows how to highlight ranges within a
ListView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-listview-highlightranges-example.png
@@ -424,6 +470,8 @@
\brief This example shows how to use the ListView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-listview-sections-example.png
@@ -438,6 +486,8 @@
\brief This example shows how to use the PathView element.
+ \depends helper/qmlapplicationviewer
+
\image qml-pathview-example.png
*/
@@ -447,6 +497,8 @@
\brief This example shows how to use a QList<QObject*> as a model in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-objectlistmodel-example.png
*/
@@ -456,6 +508,8 @@
\brief This example shows how to use the \l Package element.
+ \depends helper/qmlapplicationviewer
+
\image qml-package-example.png
*/
@@ -465,6 +519,8 @@
\brief This example shows how to combine and switch between views.
+ \depends helper/qmlapplicationviewer
+
\image qml-parallax-example.png
*/
@@ -474,6 +530,8 @@
\brief This example shows how to use a QStringList as a model in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-stringlistmodel-example.png
*/
@@ -483,6 +541,8 @@
\brief This example shows how to use the VisualItemModel element.
+ \depends helper/qmlapplicationviewer
+
\image qml-visualitemmodel-example.png
*/
@@ -492,6 +552,8 @@
\brief These examples show how to use the WebView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-webview-alert-example.png
@@ -505,6 +567,8 @@
\brief These examples show how to use the WebView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-webview-autosize-example.png
@@ -518,6 +582,8 @@
\brief These examples show how to use the WebView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-webview-googlemaps-example.png
@@ -531,6 +597,8 @@
\brief These examples show how to use the WebView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-webview-inlinehtml-example.png
@@ -544,6 +612,8 @@
\brief These examples show how to use the WebView element.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-webview-newwindows-example.png
@@ -558,6 +628,8 @@
\example declarative/screenorientation
\brief This example shows how to implement screen orientation support for your application.
+
+ \depends helper/qmlapplicationviewer
*/
/*!
@@ -565,6 +637,8 @@
\example declarative/sqllocalstorage
\brief This example shows how to use the SQL Local Storage API in QML.
+
+ \depends helper/qmlapplicationviewer
*/
/*!
@@ -573,6 +647,8 @@
\brief These examples show how to discover available fonts from QML.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-fonts-availableFonts-example.png
@@ -586,6 +662,8 @@
\brief These example shows how to manipulate text in various ways.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-fonts-banner-example.png
@@ -599,6 +677,8 @@
\brief These examples shows how to display a text with multiple fonts.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-fonts-fonts-example.png
@@ -612,6 +692,8 @@
\brief This example shows how to manipulate text in various ways.
+ \depends helper/qmlapplicationviewer
+
\table
\row
\o \image qml-fonts-hello-example.png
@@ -627,6 +709,8 @@
\brief This example shows how text selection, copy and paste operations
can be implemented on top of the TextEdit element.
+ \depends helper/qmlapplicationviewer
+
\image qml-textselection-example.png
*/
@@ -636,6 +720,8 @@
\brief This example shows how to use a ListModel from multiple threads using
WorkerScript.
+
+ \depends helper/qmlapplicationviewer
*/
/*!
@@ -643,6 +729,8 @@
\example declarative/threading/workerscript
\brief This example shows how to use the WorkerScript element for threading in QML.
+
+ \depends helper/qmlapplicationviewer
*/
/*!
@@ -650,6 +738,8 @@
\example declarative/toys/clocks
\brief This example displays a set of clocks with different times for different cities.
+
+ \depends helper/qmlapplicationviewer
Each clock is created by combining \l Image elements with \l Rotation transforms
and \l SpringAnimation behaviors.
@@ -665,6 +755,8 @@
through a combination of elements like \l ListModel, \l Repeater and \l TextEdit
together with rotation and scaling transforms, animation and mouse interaction.
+ \depends helper/qmlapplicationviewer
+
\image qml-corkboards-example.png
*/
@@ -676,6 +768,8 @@
how to use QML's \l{Dynamic Object Creation} support to dynamically create and
destroy objects.
+ \depends helper/qmlapplicationviewer
+
\image qml-dynamicscene-example.png
*/
@@ -685,6 +779,8 @@
\brief This example presents a simple implementation of Tic Tac Toe.
+ \depends helper/qmlapplicationviewer
+
\image qml-tic-tac-toe-example.png
*/
@@ -695,6 +791,8 @@
\brief This example shows how to use animation components such as \l SpringAnimation,
\l SequentialAnimation and \l PropertyAction to create a game of TV tennis.
+ \depends helper/qmlapplicationviewer
+
\image qml-tvtennis-example.png
*/
@@ -703,6 +801,8 @@
\example declarative/touchinteraction/gestures
\brief This example shows how to use the GestureArea element.
+ \depends helper/qmlapplicationviewer
+
*/
/*!
@@ -712,6 +812,8 @@
\brief This example shows how to use the MouseArea element to access information
about mouse input.
+ \depends helper/qmlapplicationviewer
+
\image qml-mousearea-example.png
*/
@@ -723,6 +825,8 @@
\l Image elements with \l Rotation transforms and \l SpringAnimation behaviors
to produce an interactive speedometer-type dial.
+ \depends helper/qmlapplicationviewer
+
\image qml-dialcontrol-example.png
*/
@@ -730,9 +834,12 @@
/*!
\title UI Components: Flipable Example
\example declarative/ui-components/flipable
+ \depends helper/qmlapplicationviewer
\brief This example shows how to use the \l Flipable element.
+ \depends helper/qmlapplicationviewer
+
\image qml-flipable-example.png
*/
@@ -742,6 +849,8 @@
\brief This example shows how to create a progress bar.
+ \depends helper/qmlapplicationviewer
+
\image qml-progressbar-example.png
*/
@@ -753,6 +862,8 @@
using the \l {Flickable::visibleArea.xPosition}{Flickable::visibleArea}
properties.
+ \depends helper/qmlapplicationviewer
+
\image qml-scrollbar-example.png
*/
@@ -763,6 +874,8 @@
\brief This example shows how to combine TextInput, FocusScope and BorderImage
elements to display multiple text input fields.
+ \depends helper/qmlapplicationviewer
+
\image qml-searchbox-example.png
*/
@@ -772,6 +885,8 @@
\brief This example shows how to create a slide switch control.
+ \depends helper/qmlapplicationviewer
+
\image qml-slideswitch-example.png
*/
@@ -781,6 +896,8 @@
\brief This example shows how to create a spinner-type component using the PathView element.
+ \depends helper/qmlapplicationviewer
+
\image qml-spinner-example.png
*/
@@ -793,6 +910,8 @@
\l {Introduction to the QML Language#Default Properties}{default properties} can be used to collect and
assemble the child items declared within an \l Item.
+ \depends helper/qmlapplicationviewer
+
\image qml-tabwidget-example.png
*/
@@ -802,6 +921,8 @@
\brief This example shows how to use the \l XmlHttpRequest API in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-xmlhttprequest-example.png
*/
@@ -809,7 +930,9 @@
\title Labs: Shader Effects
\example declarative/shadereffects
- This example shows how to create visual effects by using OpenGL shading language together with QML using \l ShaderEffectItem and \l ShaderEffectSource APIs.
+ \brief This example shows how to create visual effects by using OpenGL shading language together with QML using \l ShaderEffectItem and \l ShaderEffectSource APIs.
+
+ \depends helper/qmlapplicationviewer
\image qml-shadereffects-example.png
*/
diff --git a/doc/src/examples/qml-flickr.qdoc b/doc/src/examples/qml-flickr.qdoc
index 65e8e0d..6f59451 100644
--- a/doc/src/examples/qml-flickr.qdoc
+++ b/doc/src/examples/qml-flickr.qdoc
@@ -31,5 +31,7 @@
\brief The Qt Quick Flickr Mobile demo shows how to write a mobile Flickr browser application in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-flickr-demo.png
*/
diff --git a/doc/src/examples/qml-folderlistmodel.qdoc b/doc/src/examples/qml-folderlistmodel.qdoc
index 609be27..2d73db8 100644
--- a/doc/src/examples/qml-folderlistmodel.qdoc
+++ b/doc/src/examples/qml-folderlistmodel.qdoc
@@ -31,6 +31,7 @@
\example src/imports/folderlistmodel
\brief The FolderListModel plugin example shows how to make a C++ model available to QML.
+\depends helper/qmlapplicationviewer
It presents
a simple file list for a single folder (directory) and allows the presented
diff --git a/doc/src/examples/qml-photoviewer.qdoc b/doc/src/examples/qml-photoviewer.qdoc
index 40b6372..65b3774 100644
--- a/doc/src/examples/qml-photoviewer.qdoc
+++ b/doc/src/examples/qml-photoviewer.qdoc
@@ -31,5 +31,7 @@
\brief The Qt Quick Photo Viewer demo shows how to write a Flickr photo viewer application in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-photoviewer-demo.png
*/
diff --git a/doc/src/examples/qml-rssnews.qdoc b/doc/src/examples/qml-rssnews.qdoc
index 76df4e3..8b2691f 100644
--- a/doc/src/examples/qml-rssnews.qdoc
+++ b/doc/src/examples/qml-rssnews.qdoc
@@ -31,5 +31,7 @@
\brief The Qt Quick RSS News demo shows how to write a RSS news reader in QML.
+ \depends helper/qmlapplicationviewer
+
\image qml-rssnews-demo.png
*/
diff --git a/doc/src/examples/qml-samegame.qdoc b/doc/src/examples/qml-samegame.qdoc
index 8b67a49..8c4c75b 100644
--- a/doc/src/examples/qml-samegame.qdoc
+++ b/doc/src/examples/qml-samegame.qdoc
@@ -32,5 +32,7 @@
\brief The Qt Quick Same Game demo shows how to write a 'Same Game' game in QML, using Javascript
for all the game logic.
+ \depends helper/qmlapplicationviewer
+
\image qml-samegame-demo.png
*/
diff --git a/doc/src/examples/qml-twitter.qdoc b/doc/src/examples/qml-twitter.qdoc
index 3334370..50495e9 100644
--- a/doc/src/examples/qml-twitter.qdoc
+++ b/doc/src/examples/qml-twitter.qdoc
@@ -32,5 +32,7 @@
\brief The Qt Quick Twitter Mobile demo shows how to write a mobile Twitter search client in QML. Use it to
see what people think about Qt Quick!
+ \depends helper/qmlapplicationviewer
+
\image qml-twitter-demo.png
*/
diff --git a/doc/src/examples/qml-webbrowser.qdoc b/doc/src/examples/qml-webbrowser.qdoc
index bdead7f..a130dd7 100644
--- a/doc/src/examples/qml-webbrowser.qdoc
+++ b/doc/src/examples/qml-webbrowser.qdoc
@@ -33,6 +33,8 @@
WebView element with other components including scroll bars,
\l Flickable views and TextInput fields.
+ \depends helper/qmlapplicationviewer
+
\image qml-webbrowser-demo.png
*/