summaryrefslogtreecommitdiffstats
path: root/examples/quick/customitems/painteditem/doc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2016-02-25 15:02:46 +0100
committerVenugopal Shivashankar <venugopal.shivashankar@digia.com>2016-02-26 12:07:15 +0000
commit384b6f76242d1872feb1c7483f0526ecc9dd3c2e (patch)
tree3c4abb28d8ff067babed3c3facb168c914acf90a /examples/quick/customitems/painteditem/doc
parente01bed44bca9bd0919f70dfc14f8297415d61bd9 (diff)
Doc: Move documentation for painteditem example
Makes no sense to maintain the documentation in a separate directory outside the example source tree. Task-number: QTBUG-50405 Change-Id: I660ea712603aed5e7cbbd7b060ca064480de4e11 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com> Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'examples/quick/customitems/painteditem/doc')
-rw-r--r--examples/quick/customitems/painteditem/doc/images/declarative-textballoons_example.pngbin0 -> 29663 bytes
-rw-r--r--examples/quick/customitems/painteditem/doc/src/textballoons.qdoc105
2 files changed, 105 insertions, 0 deletions
diff --git a/examples/quick/customitems/painteditem/doc/images/declarative-textballoons_example.png b/examples/quick/customitems/painteditem/doc/images/declarative-textballoons_example.png
new file mode 100644
index 0000000000..d572de597c
--- /dev/null
+++ b/examples/quick/customitems/painteditem/doc/images/declarative-textballoons_example.png
Binary files differ
diff --git a/examples/quick/customitems/painteditem/doc/src/textballoons.qdoc b/examples/quick/customitems/painteditem/doc/src/textballoons.qdoc
new file mode 100644
index 0000000000..3dc361e4a9
--- /dev/null
+++ b/examples/quick/customitems/painteditem/doc/src/textballoons.qdoc
@@ -0,0 +1,105 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+/*!
+ \title Scene Graph - Painted Item
+ \brief Shows how to implement QPainter-based custom scenegraph items.
+ \example customitems/painteditem
+ \ingroup qtquickexamples
+
+ The Painted Item example shows how to use the QML Scene Graph framework to
+ implement custom scenegraph items using QPainter.
+
+ \image declarative-textballoons_example.png
+
+ The QQuickPaintedItem class is a class derived from QQuickItem for implementing
+ custom QML Scene Graph items using the QPainter interfaces.
+
+ The example consists of an item class, a plugin class and a QML file
+ to use this plugin. The \c TextBalloon class represents the individual
+ text balloons extending QQuickPaintedItem, the \c TextBalloonPlugin class
+ represents the skeleton code for a \l {Qt Quick} plugin and the
+ \c textballoons.qml file is used to load the plugin and display the text
+ balloons.
+
+ We will focus on the \c TextBalloon class first and continue with the
+ \c textballoons.qml file. For an example on how to implement a \l {Qt Quick}
+ plugin please look at \l{Chapter 6: Writing an Extension Plugin}
+ {Writing an Extension Plugin}
+
+ \section1 TextBalloon Class Declaration
+
+ The \c TextBalloon class inherits from QQuickPaintedItem. QQuickPaintedItem
+ is the base class for all QPainter based items in the QML Scene Graph
+ framework.
+
+ \snippet customitems/painteditem/textballoon.h 0
+
+ To implement a QQuickPaintedItem you must implement QQuickPaintedIem's pure
+ virtual function \l {QQuickPaintedItem::}{paint()} which implements the
+ painting of the type.
+
+ \section1 TextBalloon Class Definition
+
+ We have to be sure to initialize the rightAligned property for a
+ TextBalloon item.
+
+ \snippet customitems/painteditem/textballoon.cpp 0
+
+ Then we implement the \c paint() function which is automatically called by
+ the Scene Graph framework to paint the contents of the item. The function
+ paints the item in local coordinates.
+
+ \snippet customitems/painteditem/textballoon.cpp 1
+
+ We start with setting the pen and brush on the item to define the look of
+ the item. After that we start drawing. Note that the \l {QQuickPaintedItem::}{contentsBoundingRect()}
+ item is called to draw depending on the size of the item. The rectangle
+ returned by the \l {QQuickPaintedItem::}{contentsBoundingRect()} function is the size
+ of the item as defined in the QML file.
+
+ \section1 Textballoons.qml File
+
+ The Interface consists of two main parts. The scrollable area with the
+ textballoons and the controls button to add new balloons.
+
+ \section2 BalloonView
+
+ \snippet customitems/painteditem/textballoons.qml 0
+
+ The balloonModel contains two types at application start which will be
+ displayed by the balloonView. The balloonView alernates the TextBalloon
+ delegate items between left-aligned and right-aligned.
+
+ \section2 Controls
+
+ \snippet customitems/painteditem/textballoons.qml 1
+
+ The controls part of the UI contains a rectangle with a MouseArea which
+ changes color when the mouse hovers over it. This control 'button' adds
+ a new object to the end of the model with a random width.
+
+ */