| /**************************************************************************** |
| ** |
| ** 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 QtCharts |
| \brief The QVCandlestickModelMapper class is a vertical model mapper for a candlestick series. |
| |
| Model mappers enable using a data model derived from the QAbstractItemModel class |
| as a data source for a chart. A vertical model mapper is used to create a connection |
| between a data model and QCandlestickSeries, so that each column in the data model defines a |
| candlestick item and each row maps to the open, high, low, close, and timestamp values |
| of the candlestick item. |
| |
| Both model and candlestick series properties can be used to manipulate the data. The model |
| mapper keeps the candlestick series and the data model in sync. |
| |
| The model mapper ensures that all the candlestick items in the candlestick series have equal |
| sizes. Therefore, adding or removing a value from a candlestick item causes the same change to |
| be made in all the candlestick items in the candlestick series. |
| |
| \sa QCandlestickSeries, QCandlestickSet, QHCandlestickModelMapper |
| */ |
| |
| /*! |
| \qmltype VCandlestickModelMapper |
| \since QtCharts 2.2 |
| \instantiates QVCandlestickModelMapper |
| \inqmlmodule QtCharts |
| \brief Vertical model mapper for a candlestick series. |
| |
| Model mappers enable using a data model derived from the QAbstractItemModel class |
| as a data source for a chart. A vertical model mapper is used to create a connection |
| between a data model and CandlestickSeries, so that each column in the data model defines a |
| candlestick item and each row maps to the open, high, low, close, and timestamp values |
| of the candlestick item. |
| |
| Both model and candlestick series properties can be used to manipulate the data. The model |
| mapper keeps the candlestick series and the data model in sync. |
| |
| The model mapper ensures that all the candlestick items in the candlestick series have equal |
| sizes. Therefore, adding or removing a value from a candlestick item causes the same change to |
| be made in all the candlestick items in the candlestick series. |
| |
| The following QML example creates a candlestick series with three candlestick items (assuming |
| the model has at least four columns). Each candlestick item contains data defined by the |
| timestamp, open, high, low, and close rows. The name of an item is 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 |
| firstSetColumn: 1 |
| lastSetColumn: 3 |
| } |
| } |
| \endqml |
| |
| \sa CandlestickSeries, CandlestickSet, HCandlestickModelMapper |
| */ |
| |
| /*! |
| \qmlproperty QAbstractItemModel VCandlestickModelMapper::model |
| 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 or columns and modifying the data of |
| the cells. |
| */ |
| |
| /*! |
| \qmlproperty CandlestickSeries VCandlestickModelMapper::series |
| 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 (but it preserves its data). |
| */ |
| |
| /*! |
| \property QVCandlestickModelMapper::timestampRow |
| \brief The row of the model that contains the timestamp values of the |
| candlestick items in the series. |
| |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \qmlproperty int VCandlestickModelMapper::timestampRow |
| The row of the model that contains the timestamp values of the |
| candlestick items in the series. The default value is -1 |
| (invalid mapping). |
| */ |
| |
| /*! |
| \property QVCandlestickModelMapper::openRow |
| \brief The row of the model that contains the open values of the |
| candlestick items in the series. |
| |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \qmlproperty int VCandlestickModelMapper::openRow |
| The row of the model that contains the open values of the |
| candlestick items in the series. The default value is -1 |
| (invalid mapping). |
| */ |
| |
| /*! |
| \property QVCandlestickModelMapper::highRow |
| \brief The row of the model that contains the high values of the |
| candlestick items in the series. |
| |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \qmlproperty int VCandlestickModelMapper::highRow |
| The row of the model that contains the high values of the |
| candlestick items in the series. The default value is -1 |
| (invalid mapping). |
| */ |
| |
| /*! |
| \property QVCandlestickModelMapper::lowRow |
| \brief The row of the model that contains the low values of the |
| candlestick items in the series. |
| |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \qmlproperty int VCandlestickModelMapper::lowRow |
| The row of the model that contains the low values of the |
| candlestick items in the series. The default value is -1 |
| (invalid mapping). |
| */ |
| |
| /*! |
| \property QVCandlestickModelMapper::closeRow |
| \brief The row of the model that contains the close values of the |
| candlestick items in the series. |
| |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \qmlproperty int VCandlestickModelMapper::closeRow |
| The row of the model that contains the close values of the |
| candlestick items in the series. The default value is -1 |
| (invalid mapping). |
| */ |
| |
| /*! |
| \property QVCandlestickModelMapper::firstSetColumn |
| \brief The column of the model that is used as the data source for the first item. |
| |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \qmlproperty int VCandlestickModelMapper::firstSetColumn |
| The column of the model that is used as the data source for the first item. |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \property QVCandlestickModelMapper::lastSetColumn |
| \brief The column of the model that is used as the data source for the last item. |
| |
| The default value is -1 (invalid mapping). |
| */ |
| |
| /*! |
| \qmlproperty int VCandlestickModelMapper::lastSetColumn |
| The column of the model that is used as the data source for the last item. |
| The 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::firstSetColumnChanged() |
| \brief Emitted when the column of the model that contains the data of the first item is changed. |
| \sa firstSetColumn |
| */ |
| |
| /*! |
| \fn void QVCandlestickModelMapper::lastSetColumnChanged() |
| \brief Emitted when the column of the model that contains the data of the last item is changed. |
| \sa lastSetColumn |
| */ |
| |
| /*! |
| 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(firstSetSectionChanged()), this, SIGNAL(firstSetColumnChanged())); |
| connect(d_ptr, SIGNAL(lastSetSectionChanged()), this, SIGNAL(lastSetColumnChanged())); |
| } |
| |
| /*! |
| Returns Qt::Vertical. This means that values of the item 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::setFirstSetColumn(int firstSetColumn) |
| { |
| QCandlestickModelMapper::setFirstSetSection(firstSetColumn); |
| } |
| |
| int QVCandlestickModelMapper::firstSetColumn() const |
| { |
| return QCandlestickModelMapper::firstSetSection(); |
| } |
| |
| void QVCandlestickModelMapper::setLastSetColumn(int lastSetColumn) |
| { |
| QCandlestickModelMapper::setLastSetSection(lastSetColumn); |
| } |
| |
| int QVCandlestickModelMapper::lastSetColumn() const |
| { |
| return QCandlestickModelMapper::lastSetSection(); |
| } |
| |
| QT_CHARTS_END_NAMESPACE |
| |
| #include "moc_qvcandlestickmodelmapper.cpp" |