aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/mousearea
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/mousearea
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/mousearea')
-rw-r--r--examples/quick/mousearea/doc/src/mousearea.qdoc25
1 files changed, 16 insertions, 9 deletions
diff --git a/examples/quick/mousearea/doc/src/mousearea.qdoc b/examples/quick/mousearea/doc/src/mousearea.qdoc
index 091be69e5d..827e5497ee 100644
--- a/examples/quick/mousearea/doc/src/mousearea.qdoc
+++ b/examples/quick/mousearea/doc/src/mousearea.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.
@@ -27,20 +27,27 @@
/*!
\title Qt Quick Examples - MouseArea
\example mousearea
- \brief This is an example of the MouseArea type in QML
+ \brief This is an example of the MouseArea type in QML.
\image qml-mousearea-example.png
\ingroup qtquickexamples
- This example shows you how to respond to clicks and drags with a MouseArea.
+ \e MouseArea example shows how to respond to clicks and drags with a
+ \l MouseArea. For more information, visit
+ \l{Important Concepts In Qt Quick - User Input}.
- When you click inside the red square, the Text type will list several properties
- of that click which are available to QML.
+ \include examples-run.qdocinc
- Signals are emitted by the MouseArea when clicks or other discrete operations occur within it
+ \section1 MouseArea Behavior
+
+ When you click inside the red square, the \l Text type will list several
+ properties of that click which are available to QML.
+
+ Signals are emitted by the MouseArea when clicks or other discrete
+ operations occur within it.
\snippet mousearea/mousearea.qml clicks
- The MouseArea can also be used to drag items around. By setting the parameters of the drag property,
- the target item will be dragged around if the user starts to drag within the MouseArea.
+ \l MouseArea can also be used to drag items around. By setting the
+ parameters of the drag property, the target item will be dragged around if
+ the user starts to drag within the mouse area boundary.
\snippet mousearea/mousearea.qml drag
-
*/