##// END OF EJS Templates
Fix for typos on documentation.
Fix for typos on documentation.

File last commit:

r2432:53927f716a3d
r2456:4278a56d8f51
Show More
qvbarmodelmapper.cpp
248 lines | 7.5 KiB | text/x-c | CppLexer
/ src / barchart / qvbarmodelmapper.cpp
Marek Rosa
Added license text to mapper classes
r1355 /****************************************************************************
**
Miikka Heikkinen
Fixed the copyright year 2012 -> 2013
r2432 ** Copyright (C) 2013 Digia Plc
Marek Rosa
Added license text to mapper classes
r1355 ** 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$
**
****************************************************************************/
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 #include "qvbarmodelmapper.h"
QTCOMMERCIALCHART_BEGIN_NAMESPACE
Marek Rosa
Added placeholders for mappers documentation
r1331 /*!
\class QVBarModelMapper
sauimone
better brief descriptions for barcharts
r1502 \brief Vertical model mapper for bar series
Marek Rosa
Added placeholders for mappers documentation
r1331 \mainclass
Marek Rosa
Updated mapper classes descriptions
r1397 Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series.
sauimone
renamed barseries files to abstractbarseries
r1586 Vertical model mapper is used to create a connection between QAbstractBarSeries and QAbstractItemModel derived model object.
Marek Rosa
Updated BarModelMapper docs
r1485 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.
Marek Rosa
Replaced NOTE: with Note: in modelmapper classes and qdatetimeaxis to remove it from QtCreator TODO entries
r2396 Note: used model has to support adding/removing rows/columns and modifying the data of the cells.
Marek Rosa
Added placeholders for mappers documentation
r1331 */
Tero Ahola
Documenting QML bar model mappers
r1492 /*!
\qmlclass VBarModelMapper
\mainclass
VBarModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source
Tero Ahola
QML model mapper documentation for pie and xy
r1516 for any bar series. It is possible to use both QAbstractItemModel and bar series data API to manipulate data.
VBarModelMapper keeps the series and the model in sync.
The following QML example would create a bar series with three bar sets (assuming the
Tero Ahola
QML bar model mapper documentation
r1497 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).
Tero Ahola
Documenting QML bar model mappers
r1492 \code
sauimone
GroupedBarSeries to BarSeries
r1594 BarSeries {
Tero Ahola
Documenting QML bar model mappers
r1492 VBarModelMapper {
Tero Ahola
QML bar model mapper documentation
r1497 model: myCustomModel // QAbstractItemModel derived implementation
Tero Ahola
Documenting QML bar model mappers
r1492 firstBarSetColumn: 1
lastBarSetColumn: 3
Tero Ahola
Updated QML bar model mapper property names
r1496 firstRow: 1
Tero Ahola
Documenting QML bar model mappers
r1492 }
}
\endcode
*/
Marek Rosa
Added placeholders for mappers documentation
r1331
Marek Rosa
BarModelMapper removed from the docs
r1509 /*!
\property QVBarModelMapper::series
\brief Defines the QPieSeries 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)
*/
Tero Ahola
QML bar model mapper documentation
r1497 /*!
sauimone
changed barseries to abstractbarseries in documentation
r1590 \qmlproperty AbstractBarSeries VBarModelMapper::series
Defines the AbstractBarSeries based object that is used by the mapper. All the data in the series is discarded when it is
Tero Ahola
QML bar model mapper documentation
r1497 set to the mapper. When new series is specified the old series is disconnected (it preserves its data).
*/
Marek Rosa
BarModelMapper removed from the docs
r1509 /*!
\property QVBarModelMapper::model
\brief Defines the model that is used by the mapper.
*/
Tero Ahola
QML bar model mapper documentation
r1497 /*!
Tero Ahola
QML model mapper documentation for pie and xy
r1516 \qmlproperty SomeModel VBarModelMapper::model
Tero Ahola
QML bar model mapper documentation
r1497 The QAbstractItemModel based model that is used by the mapper. You need to implement the model and expose it to
Marek Rosa
Replaced NOTE: with Note: in modelmapper classes and qdatetimeaxis to remove it from QtCreator TODO entries
r2396 QML as shown in \l {QML Custom Model} demo application. Note: the model has to support adding/removing rows/columns
Tero Ahola
QML bar model mapper documentation
r1497 and modifying the data of the cells.
*/
Marek Rosa
Added documentation for BarModelMapper classes
r1348 /*!
\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)
*/
Tero Ahola
Documenting QML bar model mappers
r1492 /*!
\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).
*/
Marek Rosa
Added documentation for BarModelMapper classes
r1348
/*!
\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)
*/
Tero Ahola
Documenting QML bar model mappers
r1492 /*!
\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).
*/
Marek Rosa
Added documentation for BarModelMapper classes
r1348
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 /*!
\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
*/
/*!
Tero Ahola
QML bar model mapper documentation
r1497 \qmlproperty int VBarModelMapper::firstRow
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 Defines which row of the model contains the first values of the QBarSets in the series.
The default value is 0.
*/
/*!
\property QVBarModelMapper::rowCount
sauimone
renamed barseries files to abstractbarseries
r1586 \brief Defines the number of rows of the model that are mapped as the data for QAbstractBarSeries
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 Minimal and default value is: -1 (count limited by the number of rows in the model)
*/
/*!
Tero Ahola
QML bar model mapper documentation
r1497 \qmlproperty int VBarModelMapper::rowCount
sauimone
renamed barseries files to abstractbarseries
r1586 Defines the number of rows of the model that are mapped as the data for QAbstractBarSeries. The default value is
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 -1 (count limited by the number of rows in the model)
*/
Marek Rosa
BarModelMapper removed from the docs
r1509 /*!
\fn void QVBarModelMapper::seriesReplaced()
Emitted when the series to which mapper is connected to has changed.
*/
/*!
\fn void QVBarModelMapper::modelReplaced()
Emitted when the model to which mapper is connected to has changed.
*/
Marek Rosa
Added NOTIFY to BarModelMapper properties
r1478 /*!
\fn void QVBarModelMapper::firstBarSetColumnChanged()
Emitted when the firstBarSetColumn has changed.
*/
/*!
\fn void QVBarModelMapper::lastBarSetColumnChanged()
Emitted when the lastBarSetColumn has changed.
*/
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 /*!
\fn void QVBarModelMapper::firstRowChanged()
Emitted when the firstRow has changed.
*/
/*!
\fn void QVBarModelMapper::rowCountChanged()
Emitted when the rowCount has changed.
*/
Marek Rosa
ModelMappers dosc update
r1347 /*!
Constructs a mapper object which is a child of \a parent.
*/
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 QVBarModelMapper::QVBarModelMapper(QObject *parent) :
QBarModelMapper(parent)
{
Marek Rosa
Minor fix to barModelMapper
r1311 QBarModelMapper::setOrientation(Qt::Vertical);
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 }
Jani Honkonen
more coding style fixes for src-folder...
r2104 QAbstractItemModel *QVBarModelMapper::model() const
Marek Rosa
BarModelMapper removed from the docs
r1509 {
return QBarModelMapper::model();
}
void QVBarModelMapper::setModel(QAbstractItemModel *model)
{
if (model != QBarModelMapper::model()) {
QBarModelMapper::setModel(model);
emit modelReplaced();
}
}
Jani Honkonen
more coding style fixes for src-folder...
r2104 QAbstractBarSeries *QVBarModelMapper::series() const
Marek Rosa
BarModelMapper removed from the docs
r1509 {
return QBarModelMapper::series();
}
sauimone
QBarSeries to QAbstractBarSeries
r1584 void QVBarModelMapper::setSeries(QAbstractBarSeries *series)
Marek Rosa
BarModelMapper removed from the docs
r1509 {
if (series != QBarModelMapper::series()) {
QBarModelMapper::setSeries(series);
emit seriesReplaced();
}
}
Marek Rosa
Replaced 'Bar' with 'BarSet' in BarModelMapper functions and member variables
r1312 int QVBarModelMapper::firstBarSetColumn() const
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 {
Marek Rosa
Replaced 'Bar' with 'BarSet' in BarModelMapper functions and member variables
r1312 return QBarModelMapper::firstBarSetSection();
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 }
Marek Rosa
Replaced 'Bar' with 'BarSet' in BarModelMapper functions and member variables
r1312 void QVBarModelMapper::setFirstBarSetColumn(int firstBarSetColumn)
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 {
Marek Rosa
Added NOTIFY to BarModelMapper properties
r1478 if (firstBarSetColumn != firstBarSetSection()) {
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 QBarModelMapper::setFirstBarSetSection(firstBarSetColumn);
Marek Rosa
Added NOTIFY to BarModelMapper properties
r1478 emit firstBarSetColumnChanged();
}
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 }
Marek Rosa
Replaced 'Bar' with 'BarSet' in BarModelMapper functions and member variables
r1312 int QVBarModelMapper::lastBarSetColumn() const
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 {
Marek Rosa
Replaced 'Bar' with 'BarSet' in BarModelMapper functions and member variables
r1312 return QBarModelMapper::lastBarSetSection();
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 }
Marek Rosa
Replaced 'Bar' with 'BarSet' in BarModelMapper functions and member variables
r1312 void QVBarModelMapper::setLastBarSetColumn(int lastBarSetColumn)
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 {
Marek Rosa
Added NOTIFY to BarModelMapper properties
r1478 if (lastBarSetColumn != lastBarSetSection()) {
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 QBarModelMapper::setLastBarSetSection(lastBarSetColumn);
Marek Rosa
Added NOTIFY to BarModelMapper properties
r1478 emit lastBarSetColumnChanged();
}
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 }
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 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);
Marek Rosa
Fix: wrong signal emitted in pie and bar model mappers
r1923 emit rowCountChanged();
Marek Rosa
BarModel mapper properties first, count moved to Vertical and Horizontal mappers with more descriptive names
r1495 }
}
Marek Rosa
Added Vertical and Horizontal BarModelMappers
r1294 #include "moc_qvbarmodelmapper.cpp"
QTCOMMERCIALCHART_END_NAMESPACE