qvxymodelmapper.cpp
251 lines
| 7.1 KiB
| text/x-c
|
CppLexer
Miikka Heikkinen
|
r2854 | /**************************************************************************** | ||
Marek Rosa
|
r1355 | ** | ||
|
Miikka Heikkinen
|
r2854 | ** Copyright (C) 2016 The Qt Company Ltd. | ||
| ** Contact: https://www.qt.io/licensing/ | ||||
|
Marek Rosa
|
r1355 | ** | ||
|
Miikka Heikkinen
|
r2854 | ** This file is part of the Qt Charts module of the Qt Toolkit. | ||
|
Marek Rosa
|
r1355 | ** | ||
|
Miikka Heikkinen
|
r2854 | ** $QT_BEGIN_LICENSE:GPL$ | ||
Titta Heikkala
|
r2845 | ** 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 | ||||
|
Miikka Heikkinen
|
r2854 | ** 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. | ||||
|
Marek Rosa
|
r1355 | ** | ||
|
Titta Heikkala
|
r2845 | ** $QT_END_LICENSE$ | ||
| ** | ||||
|
Miikka Heikkinen
|
r2854 | ****************************************************************************/ | ||
|
Marek Rosa
|
r1355 | |||
|
Titta Heikkala
|
r2714 | #include <QtCharts/QVXYModelMapper> | ||
|
Marek Rosa
|
r1252 | |||
Titta Heikkala
|
r2712 | QT_CHARTS_BEGIN_NAMESPACE | ||
|
Marek Rosa
|
r1252 | |||
|
Marek Rosa
|
r1331 | /*! | ||
| \class QVXYModelMapper | ||||
|
Titta Heikkala
|
r2639 | \inmodule Qt Charts | ||
|
Titta Heikkala
|
r2712 | \brief Vertical model mapper for QXYSeries. | ||
|
Marek Rosa
|
r1331 | |||
|
Marek Rosa
|
r1397 | Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. | ||
|
Marek Rosa
|
r1379 | Vertical model mapper is used to create a connection between QXYSeries and QAbstractItemModel derived model object. | ||
| It is possible to use both QAbstractItemModel and QXYSeries model API. QXYModelMapper makes sure that QXYSeries and the model are kept in sync. | ||||
|
Marek Rosa
|
r2396 | Note: used model has to support adding/removing rows/columns and modifying the data of the cells. | ||
|
Marek Rosa
|
r1331 | */ | ||
Tero Ahola
|
r1516 | /*! | ||
|
Titta Heikkala
|
r2639 | \qmltype VXYModelMapper | ||
| \instantiates QVXYModelMapper | ||||
|
Titta Heikkala
|
r2712 | \inqmlmodule QtCharts | ||
|
Tero Ahola
|
r1516 | |||
|
Titta Heikkala
|
r2712 | \brief Vertical model mapper for QXYSeries. | ||
|
Titta Heikkala
|
r2639 | |||
|
Titta Heikkala
|
r2712 | VXYModelMapper allows you to use your own QAbstractItemModel derived model with data in columns | ||
| as a data source for XYSeries based series. It is possible to use both QAbstractItemModel and | ||||
| XYSeries data API to manipulate data. VXYModelMapper keeps the series and the model in sync. | ||||
|
Titta Heikkala
|
r2639 | */ | ||
|
Marek Rosa
|
r1331 | |||
|
Marek Rosa
|
r1507 | /*! | ||
| \property QVXYModelMapper::series | ||||
| \brief Defines the QXYSeries object that is used by the mapper. | ||||
Miikka Heikkinen
|
r2520 | |||
|
Marek Rosa
|
r1507 | All the data in the series is discarded when it is set to the mapper. | ||
| When new series is specified the old series is disconnected (it preserves its data) | ||||
| */ | ||||
|
Tero Ahola
|
r1516 | /*! | ||
| \qmlproperty XYSeries VXYModelMapper::series | ||||
|
Tero Ahola
|
r1519 | Defines the XYSeries object that is used by the mapper. All the data in the series is discarded when it is set to | ||
|
Tero Ahola
|
r1516 | the mapper. When new series is specified the old series is disconnected (it preserves its data). | ||
| */ | ||||
|
Marek Rosa
|
r1507 | |||
| /*! | ||||
| \property QVXYModelMapper::model | ||||
| \brief Defines the model that is used by the mapper. | ||||
| */ | ||||
|
Tero Ahola
|
r1516 | /*! | ||
| \qmlproperty SomeModel VXYModelMapper::model | ||||
|
Titta Heikkala
|
r2618 | The QAbstractItemModel based model that is used by the mapper. You need to implement the model | ||
| and expose it to QML. Note: the model has to support adding/removing rows/columns and modifying | ||||
| the data of the cells. | ||||
|
Tero Ahola
|
r1516 | */ | ||
|
Marek Rosa
|
r1507 | |||
|
Marek Rosa
|
r1344 | /*! | ||
| \property QVXYModelMapper::xColumn | ||||
|
Miikka Heikkinen
|
r2520 | \brief Defines which column of the model is kept in sync with the x values of QXYSeries. | ||
|
Marek Rosa
|
r1344 | Default value is: -1 (invalid mapping) | ||
| */ | ||||
|
Tero Ahola
|
r1516 | /*! | ||
| \qmlproperty int VXYModelMapper::xColumn | ||||
|
Tero Ahola
|
r1519 | Defines which column of the model is kept in sync with the x values of the series. Default value is -1 (invalid | ||
|
Tero Ahola
|
r1516 | mapping). | ||
| */ | ||||
|
Marek Rosa
|
r1344 | |||
| /*! | ||||
| \property QVXYModelMapper::yColumn | ||||
|
Miikka Heikkinen
|
r2520 | \brief Defines which column of the model is kept in sync with the y values of QXYSeries. | ||
|
Marek Rosa
|
r1344 | Default value is: -1 (invalid mapping) | ||
| */ | ||||
|
Tero Ahola
|
r1516 | /*! | ||
| \qmlproperty int VXYModelMapper::yColumn | ||||
|
Tero Ahola
|
r1519 | Defines which column of the model is kept in sync with the y values of the series. Default value is -1 (invalid | ||
|
Tero Ahola
|
r1516 | mapping). | ||
| */ | ||||
|
Marek Rosa
|
r1344 | |||
|
Marek Rosa
|
r1507 | /*! | ||
| \property QVXYModelMapper::firstRow | ||||
| \brief Defines which row of the model contains the data for the first point of the series. | ||||
|
Miikka Heikkinen
|
r2520 | |||
|
Marek Rosa
|
r1507 | Minimal and default value is: 0 | ||
| */ | ||||
| /*! | ||||
|
Tero Ahola
|
r1516 | \qmlproperty int VXYModelMapper::firstRow | ||
|
Marek Rosa
|
r1507 | Defines which row of the model contains the data for the first point of the series. | ||
| The default value is 0. | ||||
| */ | ||||
| /*! | ||||
| \property QVXYModelMapper::rowCount | ||||
|
Miikka Heikkinen
|
r2520 | \brief Defines the number of rows of the model that are mapped as the data for series. | ||
|
Marek Rosa
|
r1507 | Minimal and default value is: -1 (count limited by the number of rows in the model) | ||
| */ | ||||
| /*! | ||||
|
Tero Ahola
|
r1516 | \qmlproperty int VXYModelMapper::columnCount | ||
|
Marek Rosa
|
r1507 | Defines the number of rows of the model that are mapped as the data for series. The default value is | ||
|
Tero Ahola
|
r1516 | -1 (count limited by the number of rows in the model). | ||
|
Marek Rosa
|
r1507 | */ | ||
| /*! | ||||
| \fn void QVXYModelMapper::seriesReplaced() | ||||
| Emitted when the series to which mapper is connected to has changed. | ||||
| */ | ||||
| /*! | ||||
| \fn void QVXYModelMapper::modelReplaced() | ||||
| Emitted when the model to which mapper is connected to has changed. | ||||
| */ | ||||
|
Marek Rosa
|
r1477 | /*! | ||
| \fn void QVXYModelMapper::xColumnChanged() | ||||
| Emitted when the xColumn has changed. | ||||
| */ | ||||
| /*! | ||||
| \fn void QVXYModelMapper::yColumnChanged() | ||||
| Emitted when the yColumn has changed. | ||||
| */ | ||||
|
Marek Rosa
|
r1507 | /*! | ||
| \fn void QVXYModelMapper::firstRowChanged() | ||||
| Emitted when the firstRow has changed. | ||||
| */ | ||||
| /*! | ||||
| \fn void QVXYModelMapper::rowCountChanged() | ||||
| Emitted when the rowCount has changed. | ||||
| */ | ||||
|
Marek Rosa
|
r1347 | /*! | ||
| Constructs a mapper object which is a child of \a parent. | ||||
| */ | ||||
|
Marek Rosa
|
r1252 | QVXYModelMapper::QVXYModelMapper(QObject *parent) : | ||
| QXYModelMapper(parent) | ||||
| { | ||||
|
Marek Rosa
|
r1310 | QXYModelMapper::setOrientation(Qt::Vertical); | ||
|
Marek Rosa
|
r1252 | } | ||
Jani Honkonen
|
r2104 | QAbstractItemModel *QVXYModelMapper::model() const | ||
|
Marek Rosa
|
r1507 | { | ||
| return QXYModelMapper::model(); | ||||
| } | ||||
| void QVXYModelMapper::setModel(QAbstractItemModel *model) | ||||
| { | ||||
| if (model != QXYModelMapper::model()) { | ||||
| QXYModelMapper::setModel(model); | ||||
| emit modelReplaced(); | ||||
| } | ||||
| } | ||||
|
Jani Honkonen
|
r2104 | QXYSeries *QVXYModelMapper::series() const | ||
|
Marek Rosa
|
r1507 | { | ||
| return QXYModelMapper::series(); | ||||
| } | ||||
| void QVXYModelMapper::setSeries(QXYSeries *series) | ||||
| { | ||||
| if (series != QXYModelMapper::series()) { | ||||
| QXYModelMapper::setSeries(series); | ||||
| emit seriesReplaced(); | ||||
| } | ||||
| } | ||||
|
Marek Rosa
|
r1252 | int QVXYModelMapper::xColumn() const | ||
| { | ||||
| return QXYModelMapper::xSection(); | ||||
| } | ||||
| void QVXYModelMapper::setXColumn(int xColumn) | ||||
| { | ||||
|
Marek Rosa
|
r1477 | if (xColumn != xSection()) { | ||
|
Marek Rosa
|
r1920 | QXYModelMapper::setXSection(xColumn); | ||
|
Marek Rosa
|
r1477 | emit xColumnChanged(); | ||
| } | ||||
|
Marek Rosa
|
r1252 | } | ||
| int QVXYModelMapper::yColumn() const | ||||
| { | ||||
| return QXYModelMapper::ySection(); | ||||
| } | ||||
| void QVXYModelMapper::setYColumn(int yColumn) | ||||
| { | ||||
|
Marek Rosa
|
r1477 | if (yColumn != ySection()) { | ||
|
Marek Rosa
|
r1920 | QXYModelMapper::setYSection(yColumn); | ||
|
Marek Rosa
|
r1477 | emit yColumnChanged(); | ||
| } | ||||
|
Marek Rosa
|
r1252 | } | ||
|
Marek Rosa
|
r1507 | int QVXYModelMapper::firstRow() const | ||
| { | ||||
| return first(); | ||||
| } | ||||
| void QVXYModelMapper::setFirstRow(int firstRow) | ||||
| { | ||||
| if (firstRow != first()) { | ||||
| setFirst(firstRow); | ||||
| emit firstRowChanged(); | ||||
| } | ||||
| } | ||||
| int QVXYModelMapper::rowCount() const | ||||
| { | ||||
| return count(); | ||||
| } | ||||
| void QVXYModelMapper::setRowCount(int rowCount) | ||||
| { | ||||
| if (rowCount != count()) { | ||||
| setCount(rowCount); | ||||
|
Marek Rosa
|
r1922 | emit rowCountChanged(); | ||
|
Marek Rosa
|
r1507 | } | ||
| } | ||||
|
Marek Rosa
|
r1252 | #include "moc_qvxymodelmapper.cpp" | ||
|
Titta Heikkala
|
r2712 | QT_CHARTS_END_NAMESPACE | ||