aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/imageelements
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-05-28 16:19:08 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-06-05 12:02:01 +0200
commit5f99a6388abf87c34e052f3d7e266c48852a52dd (patch)
treeb88dc0b9dc36c477d6716edf932eb328d413ad68 /examples/quick/imageelements
parentc9553ad7d8041c7b0fd769dc8cd0f5335d9408a3 (diff)
Doc: Updated "Qt Quick Examples" pages.
-added instructions about running the example (using \include) -used the example names as sections in the collection pages -general editing and documentation polishing -updated copyright information Change-Id: I044f29fcc1921a541040505d5821acb06dc4cb35 Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/quick/imageelements')
-rw-r--r--examples/quick/imageelements/doc/src/imageelements.qdoc44
1 files changed, 29 insertions, 15 deletions
diff --git a/examples/quick/imageelements/doc/src/imageelements.qdoc b/examples/quick/imageelements/doc/src/imageelements.qdoc
index d88201faf9..07c09a02db 100644
--- a/examples/quick/imageelements/doc/src/imageelements.qdoc
+++ b/examples/quick/imageelements/doc/src/imageelements.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
@@ -31,29 +31,43 @@
\image qml-imageelements-example.png
\ingroup qtquickexamples
- This is a collection of small QML examples relating to image types.
+ \e{Image Elements} is a collection of small QML examples relating to image
+ types. For more information, visit \l{Use Case - Visual Elements In QML}.
- 'BorderImage' shows off the various scaling modes of the BorderImage item
- by setting its horizontalTileMode and verticalTileMode properties.
+ \include examples-run.qdocinc
- 'Image' shows off the various fill modes of the Image item.
+ \section1 BorderImage
- 'Shadows' shows how to create a drop shadow effect for a rectangular item
- using a BorderImage:
+ \e BorderImage shows off the various scaling modes of the \l BorderImage
+ type by setting its horizontalTileMode and verticalTileMode properties.
+
+ \section1 Image
+
+ \e Image shows off the various fill modes of the \l Image type.
+
+ \section1 Shadows
+
+ \e Shadows shows how to create a drop shadow effect for a rectangular item
+ using a \l BorderImage:
\snippet imageelements/content/ShadowRectangle.qml shadow
- 'AnimatedSprite' shows how to display a simple animation using an
- AnimatedSprite object:
+ \section1 AnimatedSprite
+
+ \e AnimatedSprite shows how to display a simple animation using an
+ \l AnimatedSprite object:
\snippet imageelements/animatedsprite.qml sprite
- The sprite animation will loop 3 times.
+ The sprite animation will loop three times.
+
+ \section1 SpriteSequence
- 'SpriteSequence' demonstrates using a sprite sequence to draw an animated
- and interactive bear.
- The SpriteSequence defines 5 different sprites. The bear is initially in
- a 'still' state:
+ \e SpriteSequence demonstrates using a sprite sequence to draw an animated
+ and interactive bear. The \l SpriteSequence object defines five different
+ sprites. The bear is initially in a \e still state:
\snippet imageelements/spritesequence.qml still
+
When the scene is clicked, an animation sets the sprite sequence to the
- 'falling' states and animates the bear's y property.
+ \e falling states and animates the bear's y property.
\snippet imageelements/spritesequence.qml animation
+
At the end of the animation the bear is set back to its initial state.
*/