summaryrefslogtreecommitdiffstats
path: root/examples/quick/imageelements/doc/src/imageelements.qdoc
blob: 2c6490fb2c6641a18086f0312fcfa357cca63a36 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** 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. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
    \title Qt Quick Examples - Image Elements
    \example imageelements
    \brief This is a collection of QML examples relating to image types.
    \image qml-imageelements-example.png
    \ingroup qtquickexamples

    \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}.

    \include examples-run.qdocinc

    \section1 Scaling with BorderImage

    \e BorderImage shows off the various scaling modes of the \l BorderImage
    type by setting its horizontalTileMode and verticalTileMode properties.

    \section1 Image Fill

    \e Image shows off the various fill modes of the \l Image type.

    \section1 Shadow Effects

    \e Shadows shows how to create a drop shadow effect for a rectangular item
    using a \l BorderImage:
    \snippet imageelements/content/ShadowRectangle.qml shadow

    \section1 Sprite Animations with 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 three times.

    \section1 Sprite Animations with SpriteSequence

    \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
    \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.
*/