examples/quick/threading/doc/src/threading.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** GNU Free Documentation License
  10 ** Alternatively, this file may be used under the terms of the GNU Free
  11 ** Documentation License version 1.3 as published by the Free Software
  12 ** Foundation and appearing in the file included in the packaging of
  13 ** this file.
  14 **
  15 ** Other Usage
  16 ** Alternatively, this file may be used in accordance with the terms
  17 ** and conditions contained in a signed written agreement between you
  18 ** and Nokia.
  19 **
  20 **
  21 **
  22 **
  23 **
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27 /*!
  28     \title QtQuick Examples - Threading
  29     \example quick/threading
  30     \brief This is a collection of QML Multithreading examples.
  31     \image qml-threading-example.png
  32
  33     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.
  34     A timer requests updates from the worker thread periodically:
  35     \snippet examples/threading/threadedlistmodel/timedisplay.qml 0
  36
  37     Inside the worker thread, the ListModel is synchronized once the data is finished loading:
  38     \snippet examples/threading/threadedlistmodel/dataloader.js 0
  39
  40     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.
  41
  42     When the UI needs another value, a request is sent to the WorkerScript:
  43     \snippet examples/threading/workerscript/workerscript.qml 0
  44     The workerscript then is free to take a really long time to calculate it:
  45     \snippet examples/threading/workerscript/workerscript.js 0
  46     When it's done, the result returns to the main scene via the WorkerScript element:
  47     \snippet examples/threading/workerscript/workerscript.qml 1
  48 */