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

File last commit:

r2432:53927f716a3d
r2456:4278a56d8f51
Show More
qvxymodelmapper.cpp
232 lines | 6.5 KiB | text/x-c | CppLexer
/ src / xychart / qvxymodelmapper.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 QXYModelMapper
r1252 #include "qvxymodelmapper.h"
QTCOMMERCIALCHART_BEGIN_NAMESPACE
Marek Rosa
Added placeholders for mappers documentation
r1331 /*!
\class QVXYModelMapper
\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.
Marek Rosa
Removed commented out code and unnecessary lines from model mapper classes
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
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
QML model mapper documentation for pie and xy
r1516 /*!
\qmlclass VXYModelMapper QHXYModelMapper
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.
VYModelMapper keeps the series and the model in sync.
*/
Marek Rosa
Added placeholders for mappers documentation
r1331
Marek Rosa
QXYModelMapper removed from the docs
r1507 /*!
\property QVXYModelMapper::series
\brief Defines the QXYSeries 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 model mapper documentation for pie and xy
r1516 /*!
\qmlproperty XYSeries VXYModelMapper::series
Tero Ahola
Minor doc fix in model mappers
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
QML model mapper documentation for pie and xy
r1516 the mapper. When new series is specified the old series is disconnected (it preserves its data).
*/
Marek Rosa
QXYModelMapper removed from the docs
r1507
/*!
\property QVXYModelMapper::model
\brief Defines the model that is used by the mapper.
*/
Tero Ahola
QML model mapper documentation for pie and xy
r1516 /*!
\qmlproperty SomeModel VXYModelMapper::model
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 model mapper documentation for pie and xy
r1516 and modifying the data of the cells.
*/
Marek Rosa
QXYModelMapper removed from the docs
r1507
Marek Rosa
Added documentation for XYModelMapper classes
r1344 /*!
\property QVXYModelMapper::xColumn
\brief Defines which column of the model is kept in sync with the x values of QXYSeries
Default value is: -1 (invalid mapping)
*/
Tero Ahola
QML model mapper documentation for pie and xy
r1516 /*!
\qmlproperty int VXYModelMapper::xColumn
Tero Ahola
Minor doc fix in model mappers
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
QML model mapper documentation for pie and xy
r1516 mapping).
*/
Marek Rosa
Added documentation for XYModelMapper classes
r1344
/*!
\property QVXYModelMapper::yColumn
\brief Defines which column of the model is kept in sync with the y values of QXYSeries
Default value is: -1 (invalid mapping)
*/
Tero Ahola
QML model mapper documentation for pie and xy
r1516 /*!
\qmlproperty int VXYModelMapper::yColumn
Tero Ahola
Minor doc fix in model mappers
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
QML model mapper documentation for pie and xy
r1516 mapping).
*/
Marek Rosa
Added documentation for XYModelMapper classes
r1344
Marek Rosa
QXYModelMapper removed from the docs
r1507 /*!
\property QVXYModelMapper::firstRow
\brief Defines which row of the model contains the data for the first point of the series.
Minimal and default value is: 0
*/
/*!
Tero Ahola
QML model mapper documentation for pie and xy
r1516 \qmlproperty int VXYModelMapper::firstRow
Marek Rosa
QXYModelMapper removed from the docs
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
\brief Defines the number of rows of the model that are mapped as the data for series
Minimal and default value is: -1 (count limited by the number of rows in the model)
*/
/*!
Tero Ahola
QML model mapper documentation for pie and xy
r1516 \qmlproperty int VXYModelMapper::columnCount
Marek Rosa
QXYModelMapper removed from the docs
r1507 Defines the number of rows of the model that are mapped as the data for series. The default value is
Tero Ahola
QML model mapper documentation for pie and xy
r1516 -1 (count limited by the number of rows in the model).
Marek Rosa
QXYModelMapper removed from the docs
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
Added NOTIFY to XYModelMapper properties
r1477 /*!
\fn void QVXYModelMapper::xColumnChanged()
Emitted when the xColumn has changed.
*/
/*!
\fn void QVXYModelMapper::yColumnChanged()
Emitted when the yColumn has changed.
*/
Marek Rosa
QXYModelMapper removed from the docs
r1507 /*!
\fn void QVXYModelMapper::firstRowChanged()
Emitted when the firstRow has changed.
*/
/*!
\fn void QVXYModelMapper::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 QXYModelMapper
r1252 QVXYModelMapper::QVXYModelMapper(QObject *parent) :
QXYModelMapper(parent)
{
Marek Rosa
Minor fix to QXYModelMapper
r1310 QXYModelMapper::setOrientation(Qt::Vertical);
Marek Rosa
Added Vertical and Horizontal QXYModelMapper
r1252 }
Jani Honkonen
more coding style fixes for src-folder...
r2104 QAbstractItemModel *QVXYModelMapper::model() const
Marek Rosa
QXYModelMapper removed from the docs
r1507 {
return QXYModelMapper::model();
}
void QVXYModelMapper::setModel(QAbstractItemModel *model)
{
if (model != QXYModelMapper::model()) {
QXYModelMapper::setModel(model);
emit modelReplaced();
}
}
Jani Honkonen
more coding style fixes for src-folder...
r2104 QXYSeries *QVXYModelMapper::series() const
Marek Rosa
QXYModelMapper removed from the docs
r1507 {
return QXYModelMapper::series();
}
void QVXYModelMapper::setSeries(QXYSeries *series)
{
if (series != QXYModelMapper::series()) {
QXYModelMapper::setSeries(series);
emit seriesReplaced();
}
}
Marek Rosa
Added Vertical and Horizontal QXYModelMapper
r1252 int QVXYModelMapper::xColumn() const
{
return QXYModelMapper::xSection();
}
void QVXYModelMapper::setXColumn(int xColumn)
{
Marek Rosa
Added NOTIFY to XYModelMapper properties
r1477 if (xColumn != xSection()) {
Marek Rosa
XY model mappers: removed wrongly placed return statements
r1920 QXYModelMapper::setXSection(xColumn);
Marek Rosa
Added NOTIFY to XYModelMapper properties
r1477 emit xColumnChanged();
}
Marek Rosa
Added Vertical and Horizontal QXYModelMapper
r1252 }
int QVXYModelMapper::yColumn() const
{
return QXYModelMapper::ySection();
}
void QVXYModelMapper::setYColumn(int yColumn)
{
Marek Rosa
Added NOTIFY to XYModelMapper properties
r1477 if (yColumn != ySection()) {
Marek Rosa
XY model mappers: removed wrongly placed return statements
r1920 QXYModelMapper::setYSection(yColumn);
Marek Rosa
Added NOTIFY to XYModelMapper properties
r1477 emit yColumnChanged();
}
Marek Rosa
Added Vertical and Horizontal QXYModelMapper
r1252 }
Marek Rosa
QXYModelMapper removed from the docs
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
Added signals test cases to xymodelmapper plus fix to xymodelmapper
r1922 emit rowCountChanged();
Marek Rosa
QXYModelMapper removed from the docs
r1507 }
}
Marek Rosa
Added Vertical and Horizontal QXYModelMapper
r1252 #include "moc_qvxymodelmapper.cpp"
QTCOMMERCIALCHART_END_NAMESPACE