aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/threading
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/threading
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/threading')
-rw-r--r--examples/quick/threading/doc/src/threading.qdoc33
1 files changed, 26 insertions, 7 deletions
diff --git a/examples/quick/threading/doc/src/threading.qdoc b/examples/quick/threading/doc/src/threading.qdoc
index 1cced3b9d3..1695a2da6f 100644
--- a/examples/quick/threading/doc/src/threading.qdoc
+++ b/examples/quick/threading/doc/src/threading.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,23 +27,42 @@
/*!
\title Qt Quick Examples - Threading
\example threading
- \brief This is a collection of QML Multithreading examples.
+ \brief This is a collection of QML multithreading examples.
\image qml-threading-example.png
\ingroup qtquickexamples
- Threaded ListModel contains a ListView and a ListModel. The ListModel is updated asynchronusly in another thread, and the results propagate back to the main thread.
- A timer requests updates from the worker thread periodically:
+ \e Threading is a collection of QML multithreading examples.
+
+ \include examples-run.qdocinc
+
+ \section1 Threaded ListModel
+
+ \e{Threaded ListModel} contains a \l ListView and a \l ListModel.
+ The ListModel object is updated asynchronously in another thread, and the
+ results propagate back to the main thread. A timer requests updates from the
+ worker thread periodically:
\snippet threading/threadedlistmodel/timedisplay.qml 0
- Inside the worker thread, the ListModel is synchronized once the data is finished loading:
+ Inside the worker thread, the ListModel is synchronized once the data is
+ finished loading:
\snippet threading/threadedlistmodel/dataloader.js 0
- WorkerScript contains an example of using a WorkerScript to offload expensive calculations into another thread. This keeps the UI from being blocked. This example calculates numbers in Pascal's Triangle, and not in a very optimal way, so it will often take several seconds to complete the calculation. By doing this in a WorkerScript in another thread, the UI is not blocked during this time.
+ \section1 WorkerScript
+
+ \e WorkerScript contains an example of using a \l WorkerScript to offload
+ expensive calculations into another thread. This keeps the UI from being
+ blocked. This example calculates numbers in Pascal's Triangle, and not in a
+ very optimal way, so it will often take several seconds to complete the
+ calculation. By doing this in a WorkerScript in another thread, the UI is
+ not blocked during this time.
When the UI needs another value, a request is sent to the WorkerScript:
\snippet threading/workerscript/workerscript.qml 0
+
The workerscript then is free to take a really long time to calculate it:
\snippet threading/workerscript/workerscript.js 0
- When it's done, the result returns to the main scene via the WorkerScript type:
+
+ When it's done, the result returns to the main scene via the WorkerScript
+ type:
\snippet threading/workerscript/workerscript.qml 1
*/