Doc: simulating gestures and NFC

Reviewed-by: owolff
Reviewed-by: Rainer Keller

6 files changed, 181 insertions, 0 deletions

diff --git a/doc/images/qt-simlator-pan.png b/doc/images/qt-simlator-pan.png
new file mode 100644
index 0000000..34792c3
--- /dev/null
+++ b/doc/images/qt-simlator-pan.png
diff --git a/doc/images/qt-simulator-nfc.png b/doc/images/qt-simulator-nfc.png
new file mode 100644
index 0000000..59c36ee
--- /dev/null
+++ b/doc/images/qt-simulator-nfc.png
diff --git a/doc/images/qt-simulator-pinch.png b/doc/images/qt-simulator-pinch.png
new file mode 100644
index 0000000..f129d13
--- /dev/null
+++ b/doc/images/qt-simulator-pinch.png
diff --git a/doc/images/qt-simulator-swipe.png b/doc/images/qt-simulator-swipe.png
new file mode 100644
index 0000000..0b987ad
--- /dev/null
+++ b/doc/images/qt-simulator-swipe.png
diff --git a/doc/images/qt-simulator-touch.png b/doc/images/qt-simulator-touch.png
new file mode 100644
index 0000000..874163c
--- /dev/null
+++ b/doc/images/qt-simulator-touch.png
diff --git a/doc/simulator.qdoc b/doc/simulator.qdoc
index 605e66c..5beb17c 100644
--- a/doc/simulator.qdoc
+++ b/doc/simulator.qdoc
@@ -754,6 +754,11 @@
     \o \l{http://doc.qt.nokia.com/qtmobility/versit.html}{Versit}
     \endlist
 
+    In addition, you can use Qt Simulator to test several types of gestures
+    that are implemented by using the classes in the
+    \l{http://doc.qt.nokia.com/4.7/gestures-overview.html}
+    {Qt gestures framework}.
+
     \note Qt Simulator does not have support for catching memory leaks in applications.
     Memory leaks occur when memory that has been allocated is not freed. To catch memory
     leaks, use the dynamic analysis tools available for the platform. For example, you can
@@ -1382,3 +1387,179 @@
 
     \endcode
 
+*/
+
+
+/*!
+    \contentspage index.html
+    \previouspage simulator-nfc.html
+    \page simulator-touch.html
+    \nextpage simulator-scripting.html
+
+    \title Simulating Touch
+
+    Touch screens allow users to interact with devices by touching the screen
+    with one or more fingers. When designing applications for touch screen, try
+    to minimise user input. Using a touch screen increases the risk of errors
+    during data input, when compared with using a keypad.
+
+    Touch screens consume most power during touch operations. Avoid unnecessary
+    user interaction also to increase power efficiency. Specifically, with
+    resistive touch screens, avoid excessively long touch and drag actions. The
+    continuous touch event flow keeps the CPU busy. The screen lock turns off
+    the touch completely.
+
+    To prevent user errors, design user interaction so that navigation and
+    controls are clear and meaningful. Meaningful controls are easy to learn
+    and remember. For example, strokes along the touch screen should produce
+    a logical outcome.
+
+    Qt includes a framework for
+    \l{http://doc.qt.nokia.com/4.7/gestures-overview.html}{gesture programming}
+    that forms gestures from a series of events, independently of the input
+    methods used. A gesture can be a particular movement of a mouse, a touch
+    screen action, or a series of events from some other source. The nature of
+    the input, the interpretation of the gesture and the action taken are the
+    choice of the developer.
+
+    You can use Qt Simulator to test several types of gestures that you can
+    implement by using the classes in the the Qt gestures framework:
+
+    \list
+
+        \o  \l{http://doc.qt.nokia.com/4.7/qtapgesture.html}{Tap}
+
+        \o  \l{http://doc.qt.nokia.com/4.7/qpinchgesture.html}{Pinch}
+
+        \o  \l{http://doc.qt.nokia.com/4.7/qpangesture.html}{Pan}
+
+        \o  \l{http://doc.qt.nokia.com/4.7/qswipegesture.html}{Swipe}
+
+    \endlist
+
+    \section1 Testing Touch Events
+
+    \image qt-simulator-touch.png "Touch view"
+
+    In the \gui {Multipoint-touch} view, select the type of touch event to
+    simulate:
+
+    \list
+
+        \o  \gui {Default mode (Alt+1)} simulates tapping the screen with a
+            finger.
+
+        \o  \gui {Pinch mode (Alt+2)} simulates a two-finger stroke that is
+            typically used to change the scale factor, zoom, or level of detail
+            of the user interface. To pinch open, users place two fingers close
+            together on the screen and move them apart without lifting them
+            from the screen. Similarly, to pinch close, users move the fingers
+            toward each other.
+
+        \o  \gui {Pan mode (Alt+3)} simulates using a finger to drag content on
+             the screen, instead of using a scroll bar for movement.
+
+        \o  \gui {Swipe mode (Alt+4)} simulates sliding 3 fingers quickly left
+            or right on the screen. Swipe may be used, for example, when
+            viewing images: an image is swiped left or right to view the next
+            or previous image, respectively.
+
+        \o  \gui {Free mode (Alt+5)} allows you to select scripts that simulate
+            touch events.
+
+    \endlist
+
+    \section1 Pinch Mode
+
+    To simulate a pinch gesture, click on the screen to set the reference
+    point, and then click and drag the mouse to move the touch points that
+    represent the user's fingers.
+
+    \image qt-simulator-pinch.png "Pinch mode
+
+    \section1 Pan Mode
+
+    To simulate a pan event, click on the screen, and then click again and drag
+    the mouse to move the content on the screen.
+
+    \image qt-simlator-pan.png "Pan mode"
+
+    \section1 Swipe Mode
+
+    To simulate a swipe gesture, click on the screen twice to set two touch
+    points, and then click again and drag the mouse left or right to move to
+    the previous or next item, for example.
+
+    \image qt-simulator-swipe.png "Swipe mode"
+
+    \note Swipe gestures require 3 touch points to be recognized, and
+    therefore, they only work on devices that have 3 touch points. For
+    example, the Nokia N8 only has 2 touch points and does not support swipe
+    gestures.
+
+    \section1 Free Mode
+
+    To run scripts that simulate touch events, click \gui Browse to locate the
+    script on the development PC. Click on the screen to run the script.
+
+    In the scripts, you can either use screen cordinates to indicate touch
+    points, or specify them as relative to the position of the mouse on the
+    screen. For example, see the touch script examples in
+    \tt{scripts/examples/}.
+
+*/
+
+
+/*!
+    \contentspage index.html
+    \previouspage simulator-camera.html
+    \page simulator-nfc.html
+    \nextpage simulator-touch.html
+
+    \title Simulating Near Field Communication
+
+    Near field communication (NFC) is a wireless communication technology that
+    enables users to exchange information between devices that are located near
+    each other. NFC has an extremely short range (approximately 1 centimeter)
+    and a maximum transfer rate of 424 kbit/s. NFC is ideal for transferring
+    small packets of data between two devices that touch each other.
+    The short transmission range makes NFC an inherently secure communication
+    technology. However, the data transfer itself is unencrypted, so any
+    security measures must be implemented in the NFC application.
+
+    NFC-based communication between two devices is possible when one device
+    acts as a reader/writer and the other as a tag. The tag is a thin simple
+    device containing antenna and small amount of memory. It is a passive
+    device, powered by magnetic field.
+
+    The reader is an active device, which generates radio signals to communicate
+    with the tags. The reader powers the passive device in case of passive mode
+    of communication.
+
+    The NFC tags can be used within applications such as posters, where small
+    amounts of data can be stored and transferred to active NFC devices. The
+    data stored on the NFC tag may contain any form of data such as URL, phone
+    number, or calendar information.
+
+    To ensure interoperability between different NFC tag providers and NFC
+    device manufacturers, the NFC Forum has defined a set of
+    \l{http://www.nfc-forum.org/specs/spec_list/}{NCF Forum Tags}.
+
+    \section1 Testing Tag Access
+
+    You can use Qt Simulator to test applications that use the
+    \l{http://doc.qt.nokia.com/qtmobility-1.2/connectivity-api.html#nfc}
+    {NCF API} for interacting with NFC Forum Tags. You can test target
+    detection and loss, as well as tag access.
+
+    \image qt-simulator-nfc.png "NFC view"
+
+    To test target detection and tag access, double-click a tag in the \gui NCF
+    view to specify that the target is in the proximity of the simulated
+    device. Double-click the target again to toggle the proximity status, and
+    thus simulate target loss.
+
+    To reset the selected target to factory defaults, click \gui {Reset
+    Target}.
+
+*/