Expound on canvas example documentation
[profile/ivi/qtdeclarative.git] / examples / quick / canvas / canvas.qml
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the examples of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:BSD$
9 ** You may use this file under the terms of the BSD license as follows:
10 **
11 ** "Redistribution and use in source and binary forms, with or without
12 ** modification, are permitted provided that the following conditions are
13 ** met:
14 **   * Redistributions of source code must retain the above copyright
15 **     notice, this list of conditions and the following disclaimer.
16 **   * Redistributions in binary form must reproduce the above copyright
17 **     notice, this list of conditions and the following disclaimer in
18 **     the documentation and/or other materials provided with the
19 **     distribution.
20 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
21 **     the names of its contributors may be used to endorse or promote
22 **     products derived from this software without specific prior written
23 **     permission.
24 **
25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
36 **
37 ** $QT_END_LICENSE$
38 **
39 ****************************************************************************/
40
41 import QtQuick 2.0
42 import "../../shared" as Examples
43
44 /*!
45     \title QtQuick Examples - Canvas
46     \example quick/canvas
47     \brief This is a collection of QML Canvas examples.
48     \image qml-canvas-example.png
49
50     This is a collection of small QML examples relating to Canvas item. Each example is
51     a small QML file emphasizing a particular element or feature.
52
53     Red heart demonstrates using a bezierCurve API to stroke and fill a red heart.
54     \snippet examples/quick/canvas/bezierCurve/bezierCurve.qml 0
55
56     Talk bubble demonstrates using a quadraticCurveTo API to stroke and fill a customized talk bubble:
57     \snippet examples/quick/canvas/quadraticCurveTo/quadraticCurveTo.qml 0
58     This example also demonstrates the fillText API:
59     \snippet examples/quick/canvas/quadraticCurveTo/quadraticCurveTo.qml 1
60
61     Squircle demonstrates using a collection of simple moveTo/lineTo path APIs to draw a smooth squircle.
62
63     Rounded rectangle demonstrates using a collection if lineTo/arcTo path APIs to draw a rounded rectangle.
64
65     Smile face demonstrates using several complex path APIs to draw an fill a smile face.
66
67     Clip demonstrates using clip API to clip a given image.
68     \snippet examples/quick/canvas/clip/clip.qml 0
69
70     Tiger demonstrates using SVG path API to draw a tiger with a collection of SVG path strings.
71     \snippet examples/quick/canvas/tiger/tiger.qml 0
72
73 */
74
75 Item {
76     height: 480
77     width: 320
78     Examples.LauncherList {
79         id: ll
80         anchors.fill: parent
81         Component.onCompleted: {
82             addExample("Red heart", "Draws a red heart with bezier curves",  Qt.resolvedUrl("bezierCurve/bezierCurve.qml"));
83             addExample("Talk bubble", "Draws a talk bubble with quadratic curves",  Qt.resolvedUrl("quadraticCurveTo/quadraticCurveTo.qml"));
84             addExample("Squircle", "Draws a smooth squircle with simple lines",  Qt.resolvedUrl("squircle/squircle.qml"));
85             addExample("Rounded rectangle", "Draws a rounded rectangle with lines and arcs",  Qt.resolvedUrl("roundedrect/roundedrect.qml"));
86             addExample("Smile face", "Draws a smile face with complex paths",  Qt.resolvedUrl("smile/smile.qml"));
87             addExample("Clip", "Shows the canvas clip feature",  Qt.resolvedUrl("clip/clip.qml"));
88             addExample("Tiger", "Draw a tiger with a collection of SVG paths",  Qt.resolvedUrl("tiger/tiger.qml"));
89         }
90     }
91 }