##// END OF EJS Templates
QML bar model mapper documentation
QML bar model mapper documentation

File last commit:

r1497:c1097d2a6ae8
r1497:c1097d2a6ae8
Show More
qvbarmodelmapper.cpp
197 lines | 6.2 KiB | text/x-c | CppLexer
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc
** All rights reserved.
** For any questions to Digia, please use contact form at http://qt.digia.com
**
** This file is part of the Qt Commercial Charts Add-on.
**
** $QT_BEGIN_LICENSE$
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** contact form at http://qt.digia.com
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qvbarmodelmapper.h"
QTCOMMERCIALCHART_BEGIN_NAMESPACE
/*!
\class QVBarModelMapper
\brief part of QtCommercial chart API.
\mainclass
Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series.
Vertical model mapper is used to create a connection between QBarSeries and QAbstractItemModel derived model object.
Model mapper maintains equal size of all the BarSets.
Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
*/
/*!
\qmlclass VBarModelMapper
\mainclass
VBarModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source
for any bar series. Adding/removing value from the BarSet causes the the same change in the rest of the BarSets
added to the same series. The following QML example would create a bar series with three bar sets (assuming the
model has at least four columns). Each bar set would contain data starting from row 1. The name of a set would be
defined by the horizontal header (of the column).
\code
GroupedBarSeries {
VBarModelMapper {
model: myCustomModel // QAbstractItemModel derived implementation
firstBarSetColumn: 1
lastBarSetColumn: 3
firstRow: 1
}
}
\endcode
*/
/*!
\qmlproperty BarSeries VBarModelMapper::series
Defines the BarSeries based object that is used by the mapper. 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).
*/
/*!
\qmlproperty Model VBarModelMapper::model
The QAbstractItemModel based model that is used by the mapper. You need to implement the model and expose it to
QML as shown in \l {QML Custom Model} demo application. NOTE: the model has to support adding/removing rows/columns
and modifying the data of the cells.
*/
/*!
\property QVBarModelMapper::firstBarSetColumn
\brief Defines which column of the model is used as the data source for the first bar set
Default value is: -1 (invalid mapping)
*/
/*!
\qmlproperty int VBarModelMapper::firstBarSetColumn
Defines which column of the model is used as the data source for the first bar set. Default value
is: -1 (invalid mapping).
*/
/*!
\property QVBarModelMapper::lastBarSetColumn
\brief Defines which column of the model is used as the data source for the last bar set
Default value is: -1 (invalid mapping)
*/
/*!
\qmlproperty int VBarModelMapper::lastBarSetColumn
Defines which column of the model is used as the data source for the last bar set. Default
value is: -1 (invalid mapping).
*/
/*!
\property QVBarModelMapper::firstRow
\brief Defines which row of the model contains the first values of the QBarSets in the series.
Minimal and default value is: 0
*/
/*!
\qmlproperty int VBarModelMapper::firstRow
Defines which row of the model contains the first values of the QBarSets in the series.
The default value is 0.
*/
/*!
\property QVBarModelMapper::rowCount
\brief Defines the number of rows of the model that are mapped as the data for QBarSeries
Minimal and default value is: -1 (count limited by the number of rows in the model)
*/
/*!
\qmlproperty int VBarModelMapper::rowCount
Defines the number of rows of the model that are mapped as the data for QBarSeries. The default value is
-1 (count limited by the number of rows in the model)
*/
/*!
\fn void QVBarModelMapper::firstBarSetColumnChanged()
Emitted when the firstBarSetColumn has changed.
*/
/*!
\fn void QVBarModelMapper::lastBarSetColumnChanged()
Emitted when the lastBarSetColumn has changed.
*/
/*!
\fn void QVBarModelMapper::firstRowChanged()
Emitted when the firstRow has changed.
*/
/*!
\fn void QVBarModelMapper::rowCountChanged()
Emitted when the rowCount has changed.
*/
/*!
Constructs a mapper object which is a child of \a parent.
*/
QVBarModelMapper::QVBarModelMapper(QObject *parent) :
QBarModelMapper(parent)
{
QBarModelMapper::setOrientation(Qt::Vertical);
}
int QVBarModelMapper::firstBarSetColumn() const
{
return QBarModelMapper::firstBarSetSection();
}
void QVBarModelMapper::setFirstBarSetColumn(int firstBarSetColumn)
{
if (firstBarSetColumn != firstBarSetSection()) {
QBarModelMapper::setFirstBarSetSection(firstBarSetColumn);
emit firstBarSetColumnChanged();
}
}
int QVBarModelMapper::lastBarSetColumn() const
{
return QBarModelMapper::lastBarSetSection();
}
void QVBarModelMapper::setLastBarSetColumn(int lastBarSetColumn)
{
if (lastBarSetColumn != lastBarSetSection()) {
QBarModelMapper::setLastBarSetSection(lastBarSetColumn);
emit lastBarSetColumnChanged();
}
}
int QVBarModelMapper::firstRow() const
{
return QBarModelMapper::first();
}
void QVBarModelMapper::setFirstRow(int firstRow)
{
if (firstRow != first()) {
QBarModelMapper::setFirst(firstRow);
emit firstRowChanged();
}
}
int QVBarModelMapper::rowCount() const
{
return QBarModelMapper::count();
}
void QVBarModelMapper::setRowCount(int rowCount)
{
if (rowCount != count()) {
QBarModelMapper::setCount(rowCount);
emit firstRowChanged();
}
}
#include "moc_qvbarmodelmapper.cpp"
QTCOMMERCIALCHART_END_NAMESPACE