aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/demos/stocqt/doc/src/stocqt.qdoc
blob: 800bba570c183fd55ed192ab8718adb5e6e44d6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \title Qt Quick Demo - StocQt
    \ingroup qtquickdemos
    \example demos/stocqt
    \brief A configurable stock chart for the NASDAQ-100.
    \image qtquick-demo-stocqt.png

    The \e{StocQt} application presents a trend chart for the first stock in
    the list of NASDAQ-100 stocks maintained by it. It allows the user to
    choose another stock from the list, and fetches the required data for
    the selected stock by sending an \c XMLHttpRequest to
    http://finance.yahoo.com.

    The application uses several custom types such as Button, CheckBox,
    StockChart, StockInfo, StockView, and so on. These types are used to
    present the stock data in a readable form and also let the user customize
    the trend chart. For example, the user can choose to view the yearly,
    monthly, or daily trends in the stock price.

    The application uses the ObjectModel type to access the two visual data
    models that it depends on.

    \quotefromfile demos/stocqt/stocqt.qml
    \skipto ListView
    \printuntil id
    \dots 8
    \skipto model
    \printuntil StockView
    \printuntil }
    \printuntil }
    \printuntil }

    The StockListView model is a static data model listing the
    NASDAQ-100 stocks with basic information such as stockId, name, value,
    change, and so on. This data model is used by the application if the
    user wants to choose another stock from the list.

    StockView is a complex data model that presents a trend chart for the
    selected stock. It uses another custom type, StockChart, which presents
    the graphical trend of the stock price using a Canvas. This data model
    is used for most of the time during the lifetime of the application.

    \quotefromfile demos/stocqt/content/StockChart.qml
    \skipto Rectangle
    \printuntil id
    \dots
    \skipto Canvas
    \printuntil id
    \dots 8
    \skipto onPaint
    \printuntil /^\}$/

    To understand the application better, browse through its code using
    Qt Creator.

    \include examples-run.qdocinc

    \sa {QML Applications}
*/