From 5f99a6388abf87c34e052f3d7e266c48852a52dd Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 28 May 2014 16:19:08 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- .../touchinteraction/doc/src/touchinteraction.qdoc | 50 ++++++++++++++++------ 1 file changed, 37 insertions(+), 13 deletions(-) (limited to 'examples/quick/touchinteraction') diff --git a/examples/quick/touchinteraction/doc/src/touchinteraction.qdoc b/examples/quick/touchinteraction/doc/src/touchinteraction.qdoc index 09a5f51105..245cd00592 100644 --- a/examples/quick/touchinteraction/doc/src/touchinteraction.qdoc +++ b/examples/quick/touchinteraction/doc/src/touchinteraction.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,29 +27,53 @@ /*! \title Qt Quick Examples - Touch Interaction \example touchinteraction - \brief This is a collection of QML Touch Interaction examples. + \brief A collection of QML Touch Interaction examples. \image qml-touchinteraction-example.png - This is a collection of small QML examples relating to touch interaction methods. + \e{Touch Interaction} is a collection of small QML examples relating to + touch interaction methods. For more information, visit + \l{Important Concepts In Qt Quick - User Input}. + + \include examples-run.qdocinc + + \section1 Multipoint Flames + + \e{Multipoint Flames} demonstrates distinguishing different fingers in a + \l MultiPointTouchArea, by assigning a different colored flame to each touch + point. - Multipoint Flames demonstrates distinguishing different fingers in a MultiPointTouchArea, by assigning a different colored flame to each touch point. The MultipointTouchArea sets up multiple touch points: \snippet touchinteraction/multipointtouch/multiflame.qml 0 - The flames are then simply bound to the coordiates of the touch point, and whether it is currently pressed, like so: + + The flames are then simply bound to the coordinates of the touch point, and + whether it is currently pressed, as follows: \snippet touchinteraction/multipointtouch/multiflame.qml 1 - Bear-Whack demonstrates using a MultiPointTouchArea to add multiple finger support to a simple game. The interaction with the game - is done through a SpriteGoal that follows the TouchPoint. The TouchPoints added to the MultiPointTouchArea are a component with all - this logic embedded into it: + \section1 Bear-Whack + + \e{Bear-Whack} demonstrates using \l MultiPointTouchArea to add multiple + finger support to a simple game. The interaction with the game + is done through a SpriteGoal that follows the TouchPoint. The TouchPoints + added to the MultiPointTouchArea are a component with the relevant logic + embedded into it: \snippet touchinteraction/multipointtouch/content/AugmentedTouchPoint.qml 0 - Flick Resize uses a PinchArea to allow Pinch-to-Resize behavior. This is easily achieved just by listening to the PinchArea signals and responding - to user input. + \section1 Flick Resize + + \e{Flick Resize} uses a \l PinchArea to implement a \e{pinch-to-resize} + behavior. This is easily achieved by listening to the PinchArea signals and + responding to user input. \snippet touchinteraction/pincharea/flickresize.qml 0 - Flickable is a simple example demonstrating the Flickable type. The object inside the flickable is very big, but the flickable itself is very small: + \section1 Flickable + + \e Flickable is a simple example demonstrating the \l Flickable type. \snippet touchinteraction/flickable/basic-flickable.qml 0 - Corkboards shows a more complex Flickable usecase, with types on the flickable that respond to mouse and keyboard interaction. - This doesn't require special code, the Qt Quick types automatically cooperate with Flickable for accepting the touch events. + \section1 Corkboards + + \e Corkboards shows another use for \l Flickable, with QML types within the + flickable object that respond to mouse and keyboard interaction. This + behavior does not require special code as the Qt Quick types already + cooperate with the Flickable type for accepting touch events. */ -- cgit v1.2.3