summaryrefslogtreecommitdiffstats
path: root/src/charts/candlestickchart/qvcandlestickmodelmapper.cpp
blob: 990c438ce38d4fdce5a909c4d67eea6e60abd186 (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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Charts module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include <QtCharts/QVCandlestickModelMapper>
#include <private/qcandlestickmodelmapper_p.h>

QT_CHARTS_BEGIN_NAMESPACE

/*!
    \class QVCandlestickModelMapper
    \since 5.8
    \inmodule Qt Charts
    \brief Vertical model mapper for a candlestick series.

    Model mappers allow the use of a QAbstractItemModel-derived model as a data source for a chart
    series, creating a connection between a QCandlestickSeries and the model object. A vertical
    model mapper maintains an equal size across all \l {QCandlestickSet} {QCandlestickSets}, and
    reads the values of the set from the model's columns.

    \note The model used must support adding and removing rows/columns and modifying the data of the
    cells.
*/

/*!
    \qmltype VCandlestickModelMapper
    \since 2.2
    \instantiates QVCandlestickModelMapper
    \inqmlmodule QtCharts
    \brief Vertical model mapper for a candlestick series.

    VCandlestickModelMapper allows the use of a QAbstractItemModel-derived model with data in
    columns as a data source for a candlestick series. It's possible to manipulate the data either
    through QAbstractItemModel or QCandlestickSeries.

    The following QML example creates a candlestick series with three candlestick sets (assuming the
    model has at least four columns). Each candlestick set would contain data defined by timestamp,
    open, high, low and close rows. The name of a set would be defined by the horizontal header of
    the column.
    \qml
        CandlestickSeries {
            VCandlestickModelMapper {
                model: myCustomModel // QAbstractItemModel derived implementation
                timestampRow: 1
                openRow: 2
                highRow: 3
                lowRow: 4
                closeRow: 5
                firstCandlestickSetColumn: 1
                lastCandlestickSetColumn: 3
            }
        }
    \endqml

    \note VCandlestickModelMapper keeps the series and the model in sync.
*/

/*!
    \qmlproperty QAbstractItemModel VCandlestickModelMapper::model
    \brief The QAbstractItemModel-based model that is used by the mapper. The model must be
    implemented and exposed to QML.

    \note The model used must support adding and removing rows/columns and modifying the data of the
    cells.
*/

/*!
    \qmlproperty CandlestickSeries VCandlestickModelMapper::series
    \brief Defines the CandlestickSeries based object that is used by the mapper.

    All the data in the series is discarded when it is set to the mapper. When a new series is
    specified, the old series is disconnected (preserving its data).
*/

/*!
    \property QVCandlestickModelMapper::timestampRow
    \brief Defines the row of the model that contains the timestamp values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \qmlproperty int VCandlestickModelMapper::timestampRow
    \brief Defines the row of the model that contains the timestamp values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \property QVCandlestickModelMapper::openRow
    \brief Defines the row of the model that contains the open values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \qmlproperty int VCandlestickModelMapper::openRow
    \brief Defines the row of the model that contains the open values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \property QVCandlestickModelMapper::highRow
    \brief Defines the row of the model that contains the high values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \qmlproperty int VCandlestickModelMapper::highRow
    \brief Defines the row of the model that contains the high values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \property QVCandlestickModelMapper::lowRow
    \brief Defines the row of the model that contains the low values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \qmlproperty int VCandlestickModelMapper::lowRow
    \brief Defines the row of the model that contains the low values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \property QVCandlestickModelMapper::closeRow
    \brief Defines the row of the model that contains the close values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \qmlproperty int VCandlestickModelMapper::closeRow
    \brief Defines the row of the model that contains the close values of the
    \l {QCandlestickSet} {QCandlestickSets} in the series. Default value is -1 (invalid mapping).
*/

/*!
    \property QVCandlestickModelMapper::firstCandlestickSetColumn
    \brief Defines the column of the model that is used as the data source for the first set.
    Default value is -1 (invalid mapping).
*/

/*!
    \qmlproperty int VCandlestickModelMapper::firstCandlestickSetColumn
    \brief Defines the column of the model that is used as the data source for the first set.
    Default value is -1 (invalid mapping).
*/

/*!
    \property QVCandlestickModelMapper::lastCandlestickSetColumn
    \brief Defines the column of the model that is used as the data source for the last set. Default
    value is -1 (invalid mapping).
*/

/*!
    \qmlproperty int VCandlestickModelMapper::lastCandlestickSetColumn
    \brief Defines the column of the model that is used as the data source for the last set. Default
    value is -1 (invalid mapping).
*/

/*!
    \fn void QVCandlestickModelMapper::timestampRowChanged()
    \brief Emitted when the row of the model that contains timestamp values is changed.
    \sa timestampRow
*/

/*!
    \fn void QVCandlestickModelMapper::openRowChanged()
    \brief Emitted when the row of the model that contains open values is changed.
    \sa openRow
*/

/*!
    \fn void QVCandlestickModelMapper::highRowChanged()
    \brief Emitted when the row of the model that contains high values is changed.
    \sa highRow
*/

/*!
    \fn void QVCandlestickModelMapper::lowRowChanged()
    \brief Emitted when the row of the model that contains low values is changed.
    \sa lowRow
*/

/*!
    \fn void QVCandlestickModelMapper::closeRowChanged()
    \brief Emitted when the row of the model that contains close values is changed.
    \sa closeRow
*/

/*!
    \fn void QVCandlestickModelMapper::firstCandlestickSetColumnChanged()
    \brief Emitted when the column of the model that contains the data of the first set is changed.
    \sa firstCandlestickSetColumn
*/

/*!
    \fn void QVCandlestickModelMapper::lastCandlestickSetColumnChanged()
    \brief Emitted when the column of the model that contains the data of the last set is changed.
    \sa lastCandlestickSetColumn
*/

/*!
    Constructs a vertical model mapper object which is a child of \a parent.
*/
QVCandlestickModelMapper::QVCandlestickModelMapper(QObject *parent)
    : QCandlestickModelMapper(parent)
{
    connect(d_ptr, SIGNAL(timestampChanged()), this, SIGNAL(timestampRowChanged()));
    connect(d_ptr, SIGNAL(openChanged()), this, SIGNAL(openRowChanged()));
    connect(d_ptr, SIGNAL(highChanged()), this, SIGNAL(highRowChanged()));
    connect(d_ptr, SIGNAL(lowChanged()), this, SIGNAL(lowRowChanged()));
    connect(d_ptr, SIGNAL(closeChanged()), this, SIGNAL(closeRowChanged()));
    connect(d_ptr, SIGNAL(firstCandlestickSetSectionChanged()),
            this, SIGNAL(firstCandlestickSetColumnChanged()));
    connect(d_ptr, SIGNAL(lastCandlestickSetSectionChanged()),
            this, SIGNAL(lastCandlestickSetColumnChanged()));
}

/*!
    Returns Qt::Vertical. This means that values of the set are read from columns.
*/
Qt::Orientation QVCandlestickModelMapper::orientation() const
{
    return Qt::Vertical;
}

void QVCandlestickModelMapper::setTimestampRow(int timestampRow)
{
    QCandlestickModelMapper::setTimestamp(timestampRow);
}

int QVCandlestickModelMapper::timestampRow() const
{
    return QCandlestickModelMapper::timestamp();
}

void QVCandlestickModelMapper::setOpenRow(int openRow)
{
    QCandlestickModelMapper::setOpen(openRow);
}

int QVCandlestickModelMapper::openRow() const
{
    return QCandlestickModelMapper::open();
}

void QVCandlestickModelMapper::setHighRow(int highRow)
{
    QCandlestickModelMapper::setHigh(highRow);
}

int QVCandlestickModelMapper::highRow() const
{
    return QCandlestickModelMapper::high();
}

void QVCandlestickModelMapper::setLowRow(int lowRow)
{
    QCandlestickModelMapper::setLow(lowRow);
}

int QVCandlestickModelMapper::lowRow() const
{
    return QCandlestickModelMapper::low();
}

void QVCandlestickModelMapper::setCloseRow(int closeRow)
{
    QCandlestickModelMapper::setClose(closeRow);
}

int QVCandlestickModelMapper::closeRow() const
{
    return QCandlestickModelMapper::close();
}

void QVCandlestickModelMapper::setFirstCandlestickSetColumn(int firstCandlestickSetColumn)
{
    QCandlestickModelMapper::setFirstCandlestickSetSection(firstCandlestickSetColumn);
}

int QVCandlestickModelMapper::firstCandlestickSetColumn() const
{
    return QCandlestickModelMapper::firstCandlestickSetSection();
}

void QVCandlestickModelMapper::setLastCandlestickSetColumn(int lastCandlestickSetColumn)
{
    QCandlestickModelMapper::setLastCandlestickSetSection(lastCandlestickSetColumn);
}

int QVCandlestickModelMapper::lastCandlestickSetColumn() const
{
    return QCandlestickModelMapper::lastCandlestickSetSection();
}

#include "moc_qvcandlestickmodelmapper.cpp"

QT_CHARTS_END_NAMESPACE