summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTero Ahola <tero.ahola@digia.com>2012-08-23 14:34:06 +0300
committerTero Ahola <tero.ahola@digia.com>2012-08-23 15:36:20 +0300
commit3f96a0e4b9513ec08e56880f360ef0a3079e7cb3 (patch)
treefbbc84feb13d11c397f8a0f8e520a92c237d15c5 /doc
parent4fa1dedc5aa74db198ea97e460a5f86e2fa0c5ab (diff)
Documented QML oscilloscope
Diffstat (limited to 'doc')
-rw-r--r--doc/images/demos_qmloscilloscope.pngbin0 -> 36648 bytes
-rw-r--r--doc/src/demos-qmloscilloscope.qdoc27
-rw-r--r--doc/src/demos.qdoc1
3 files changed, 28 insertions, 0 deletions
diff --git a/doc/images/demos_qmloscilloscope.png b/doc/images/demos_qmloscilloscope.png
new file mode 100644
index 00000000..38077bc2
--- /dev/null
+++ b/doc/images/demos_qmloscilloscope.png
Binary files differ
diff --git a/doc/src/demos-qmloscilloscope.qdoc b/doc/src/demos-qmloscilloscope.qdoc
new file mode 100644
index 00000000..dd202746
--- /dev/null
+++ b/doc/src/demos-qmloscilloscope.qdoc
@@ -0,0 +1,27 @@
+/*!
+ \example demos/qmloscilloscope
+ \title Oscilloscope
+
+ \image demos_qmloscilloscope.png
+
+ Oscilloscope application demonstrates how to use QtCommercial Charts QML api to implement an
+ application with strict performance requirements. The application uses generated data with
+ configurable characteristics to mimic a simple oscilloscope user interface. To find out the
+ actual screen refresh performance of the application, you can set QML_SHOW_FRAMERATE = 1 to
+ your run environment settings to get the framerate shown in the application output console.
+ I.e. go to Projects - Run - Run environment in Qt Creator and select Add. Then you can
+ experiment with the different configurable options of the demo application to find the
+ configuration that gives you the best performance in your environment.
+
+ The application window is shared by control and scope views:
+ \snippet ../demos/qmloscilloscope/qml/qmloscilloscope/main.qml 1
+ \snippet ../demos/qmloscilloscope/qml/qmloscilloscope/main.qml 2
+
+ ControlView implements the buttons used for configuring. ScopeView uses a ChartView to show
+ a chart with two line series:
+ \snippet ../demos/qmloscilloscope/qml/qmloscilloscope/ScopeView.qml 1
+
+ The data of the line series is updated with a QML timer. In a real life application the
+ updating could triggered with a signal from Qt C++ code.
+ \snippet ../demos/qmloscilloscope/qml/qmloscilloscope/ScopeView.qml 2
+*/
diff --git a/doc/src/demos.qdoc b/doc/src/demos.qdoc
index 0e85bf9e..9723b0af 100644
--- a/doc/src/demos.qdoc
+++ b/doc/src/demos.qdoc
@@ -21,6 +21,7 @@
<li><a href="demos-qmlweather.html">Qml Weather</a></li>
<li><a href="demos-qmlf1legends.html">Qml F1 Legends</a></li>
<li><a href="demos-qmlcustommodel.html">Qml Custom Model</a></li>
+ <li><a href="demos-qmloscilloscope.html">Qml Oscilloscope</a></li>
</ul>
</td>
</tr>