HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1516:267764825d23

QML model mapper documentation for pie and xy

Tero Ahola -

r1516:267764825d23

parent child

Context file:

r1516:267764825d23

Collapse all files

src/barchart/qhbarmodelmapper.cpp +7 -6

             /****************************************************************************
             **
             ** 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 "qhbarmodelmapper.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QHBarModelMapper
                 \brief Horizontal model mapper for bar series
                 \mainclass
                 Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series.
                 Horizontal 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 HBarModelMapper QHBarModelMapper
-                \mainclass
                 HBarModelMapper allows you to use your own QAbstractItemModel derived model with data in rows 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
+                for any bar series. It is possible to use both QAbstractItemModel and bar series data API to manipulate data.
-                added to the same series. The following QML example would create a bar series with three bar sets (assuming the
+                HBarModelMapper keeps the series and the model in sync.
-                model has at least four rows). Each bar set would contain data starting from column 1. The name of a set would be
-                defined by the vertical header (of the row).
+                The following QML example would create a bar series with three bar sets (assuming the model has
+                at least four rows). Each bar set would contain data starting from column 1. The name of a set would be defined by
+                the vertical header (of the row).
                 \code
                     BarSeries {
                         HBarModelMapper {
                             model: myCustomModel // QAbstractItemModel derived implementation
                             firstBarSetRow: 1
                             lastBarSetRow: 3
                             firstColumn: 1
                         }
                     }
                 \endcode
             */
             /*!
                 \property QHBarModelMapper::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)
             */
             /*!
                 \qmlproperty BarSeries HBarModelMapper::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).
             */
             /*!
                 \property QHBarModelMapper::model
                 \brief Defines the model that is used by the mapper.
             */
             /*!
-                \qmlproperty Model HBarModelMapper::model
+                \qmlproperty SomeModel HBarModelMapper::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 QHBarModelMapper::firstBarSetRow
                 \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 HBarModelMapper::firstBarSetRow
                 Defines which column of the model is used as the data source for the first bar set. The default value is -1
                 (invalid mapping).
             */
             /*!
                 \property QHBarModelMapper::lastBarSetRow
                 \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 HBarModelMapper::lastBarSetRow
                 Defines which column of the model is used as the data source for the last bar set. The default value is -1
                 (invalid mapping).
             */
             /*!
                 \property QHBarModelMapper::firstColumn
                 \brief Defines which column of the model contains the first values of the QBarSets in the series.
                 Minimal and default value is: 0
             */
             /*!
                 \qmlproperty int HBarModelMapper::firstColumn
                 Defines which column of the model contains the first values of the QBarSets in the series.
                 The default value is 0.
             */
             /*!
                 \property QHBarModelMapper::columnCount
                 \brief Defines the number of columns of the model that are mapped as the data for QBarSeries
                 Minimal and default value is: -1 (count limited by the number of columns in the model)
             */
             /*!
                 \qmlproperty int HBarModelMapper::columnCount
                 Defines the number of columns of the model that are mapped as the data for QBarSeries. The default value is
                 -1 (count limited by the number of columns in the model)
             */
             /*!
                 \fn void QHBarModelMapper::seriesReplaced()
                 Emitted when the series to which mapper is connected to has changed.
             */
             /*!
                 \fn void QHBarModelMapper::modelReplaced()
                 Emitted when the model to which mapper is connected to has changed.
             */
             /*!
                 \fn void QHBarModelMapper::firstBarSetRowChanged()
                 Emitted when the firstBarSetRow has changed.
             */
             /*!
                 \fn void QHBarModelMapper::lastBarSetRowChanged()
                 Emitted when the lastBarSetRow has changed.
             */
             /*!
                 \fn void QHBarModelMapper::firstColumnChanged()
                 Emitted when the firstColumn has changed.
             */
             /*!
                 \fn void QHBarModelMapper::columnCountChanged()
                 Emitted when the columnCount has changed.
             */
             /*!
                 Constructs a mapper object which is a child of \a parent.
             */
             QHBarModelMapper::QHBarModelMapper(QObject *parent) :
                 QBarModelMapper(parent)
             {
                 QBarModelMapper::setOrientation(Qt::Horizontal);
             }
             QAbstractItemModel* QHBarModelMapper::model() const
             {
                 return QBarModelMapper::model();
             }
             void QHBarModelMapper::setModel(QAbstractItemModel *model)
             {
                 if (model != QBarModelMapper::model()) {
                     QBarModelMapper::setModel(model);
                     emit modelReplaced();
                 }
             }
             QBarSeries* QHBarModelMapper::series() const
             {
                 return QBarModelMapper::series();
             }
             void QHBarModelMapper::setSeries(QBarSeries *series)
             {
                 if (series != QBarModelMapper::series()) {
                     QBarModelMapper::setSeries(series);
                     emit seriesReplaced();
                 }
             }
             int QHBarModelMapper::firstBarSetRow() const
             {
                 return QBarModelMapper::firstBarSetSection();
             }
             void QHBarModelMapper::setFirstBarSetRow(int firstBarSetRow)
             {
                 if (firstBarSetRow != firstBarSetSection()) {
                     QBarModelMapper::setFirstBarSetSection(firstBarSetRow);
                     emit firstBarSetRowChanged();
                 }
             }
             int QHBarModelMapper::lastBarSetRow() const
             {
                 return QBarModelMapper::lastBarSetSection();
             }
             void QHBarModelMapper::setLastBarSetRow(int lastBarSetRow)
             {
                 if (lastBarSetRow != lastBarSetSection()) {
                     QBarModelMapper::setLastBarSetSection(lastBarSetRow);
                     emit lastBarSetRowChanged();
                 }
             }
             int QHBarModelMapper::firstColumn() const
             {
                 return QBarModelMapper::first();
             }
             void QHBarModelMapper::setFirstColumn(int firstColumn)
             {
                 if (firstColumn != first()) {
                     QBarModelMapper::setFirst(firstColumn);
                     emit firstColumnChanged();
                 }
             }
             int QHBarModelMapper::columnCount() const
             {
                 return QBarModelMapper::count();
             }
             void QHBarModelMapper::setColumnCount(int columnCount)
             {
                 if (columnCount != count()) {
                     QBarModelMapper::setCount(columnCount);
                     emit firstColumnChanged();
                 }
             }
             #include "moc_qhbarmodelmapper.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/barchart/qvbarmodelmapper.cpp +5 -3

             /****************************************************************************
             **
             ** 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 Vertical model mapper for bar series
                 \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
+                for any bar series. It is possible to use both QAbstractItemModel and bar series data API to manipulate data.
-                added to the same series. The following QML example would create a bar series with three bar sets (assuming the
+                VBarModelMapper keeps the series and the model in sync.
+                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
             */
             /*!
                 \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)
             */
             /*!
                 \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).
             */
             /*!
                 \property QVBarModelMapper::model
                 \brief Defines the model that is used by the mapper.
             */
             /*!
-                \qmlproperty Model VBarModelMapper::model
+                \qmlproperty SomeModel 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::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.
             */
             /*!
                 \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);
             }
             QAbstractItemModel* QVBarModelMapper::model() const
             {
                 return QBarModelMapper::model();
             }
             void QVBarModelMapper::setModel(QAbstractItemModel *model)
             {
                 if (model != QBarModelMapper::model()) {
                     QBarModelMapper::setModel(model);
                     emit modelReplaced();
                 }
             }
             QBarSeries* QVBarModelMapper::series() const
             {
                 return QBarModelMapper::series();
             }
             void QVBarModelMapper::setSeries(QBarSeries *series)
             {
                 if (series != QBarModelMapper::series()) {
                     QBarModelMapper::setSeries(series);
                     emit seriesReplaced();
                 }
             }
             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

src/piechart/qhpiemodelmapper.cpp +44 -8

             /****************************************************************************
             **
             ** 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 "qhpiemodelmapper.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QHPieModelMapper
                 \mainclass
                 Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series.
                 Horizontal model mapper is used to create a connection between QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in rows.
                 It is possible to use both QAbstractItemModel and QPieSeries model API. QHPieModelMapper makes sure that Pie and the model are kept in sync.
                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
+            /*!
+                \qmlclass HPieModelMapper QHPieModelMapper
+                HPieModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source
+                for a pie series. It is possible to use both QAbstractItemModel and PieSeries data API to manipulate data.
+                HPieModelMapper keeps the Pie and the model in sync.
+                The following QML example would create a pie series with four slices (assuming the model has
+                at least five columns). Each slice would contain a label from row 1 and a value from row 2.
+                \code
+                    HPieModelMapper {
+                        series: pieSeries
+                        model: customModel
+                        labelsRow: 1
+                        valuesRow: 2
+                        firstColumn: 1
+                        columnCount: 4
+                    }
+                \endcode
+            */
             /*!
                 \property QHPieModelMapper::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)
             */
+            /*!
+                \qmlproperty PieSeries HPieModelMapper::series
+                Defines the PieSeries object that is used by the mapper. If you define the mapper element as a child for a
+                PieSeries, leave this property undefined. 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).
+            */
             /*!
                 \property QHPieModelMapper::model
                 \brief Defines the model that is used by the mapper.
             */
+            /*!
+                \qmlproperty SomeModel HPieModelMapper::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 QHPieModelMapper::valuesRow
                 \brief Defines which row of the model is kept in sync with the values of the pie's slices
                 Default value is: -1 (invalid mapping)
             */
+            /*!
+                \qmlproperty int HPieModelMapper::valuesRow
+                Defines which row of the model is kept in sync with the values of the pie's slices. Default value is: -1 (invalid
+                mapping).
+            */
             /*!
                 \property QHPieModelMapper::labelsRow
                 \brief Defines which row of the model is kept in sync with the labels of the pie's slices
+                Default value is: -1 (invalid mapping)
+            */
+            /*!
+                \qmlproperty int HPieModelMapper::labelsRow
+                Defines which row of the model is kept in sync with the labels of the pie's slices
                 Default value is: -1 (invalid mapping)
             */
             /*!
                 \property QHPieModelMapper::firstColumn
                 \brief Defines which column of the model contains the first slice value.
                 Minimal and default value is: 0
             */
             /*!
-                \qmlproperty int QHPieModelMapper::firstColumn
+                \qmlproperty int HPieModelMapper::firstColumn
                 Defines which column of the model contains the first slice value.
                 The default value is 0.
             */
             /*!
                 \property QHPieModelMapper::columnCount
                 \brief Defines the number of columns of the model that are mapped as the data for QPieSeries
                 Minimal and default value is: -1 (count limited by the number of columns in the model)
             */
             /*!
-                \qmlproperty int QHPieModelMapper::columnCount
+                \qmlproperty int HPieModelMapper::columnCount
                 Defines the number of columns of the model that are mapped as the data for QPieSeries. The default value is
                 -1 (count limited by the number of columns in the model)
             */
             /*!
                 \fn void QHPieModelMapper::seriesReplaced()
                 Emitted when the series to which mapper is connected to has changed.
             */
             /*!
                 \fn void QHPieModelMapper::modelReplaced()
                 Emitted when the model to which mapper is connected to has changed.
             */
             /*!
                 \fn void QHPieModelMapper::valuesRowChanged()
                 Emitted when the valuesRow has changed.
             */
             /*!
                 \fn void QHPieModelMapper::labelsRowChanged()
                 Emitted when the labelsRow has changed.
             */
             /*!
                 \fn void QHPieModelMapper::firstColumnChanged()
                 Emitted when the firstColumn has changed.
             */
             /*!
                 \fn void QHPieModelMapper::columnCountChanged()
                 Emitted when the columnCount has changed.
             */
             /*!
                 Constructs a mapper object which is a child of \a parent.
             */
             QHPieModelMapper::QHPieModelMapper(QObject *parent) :
                 QPieModelMapper(parent)
             {
                 setOrientation(Qt::Horizontal);
             }
             QAbstractItemModel* QHPieModelMapper::model() const
             {
                 return QPieModelMapper::model();
             }
             void QHPieModelMapper::setModel(QAbstractItemModel *model)
             {
                 if (model != QPieModelMapper::model()) {
                     QPieModelMapper::setModel(model);
                     emit modelReplaced();
                 }
             }
             QPieSeries* QHPieModelMapper::series() const
             {
                 return QPieModelMapper::series();
             }
             void QHPieModelMapper::setSeries(QPieSeries *series)
             {
                 if (series != QPieModelMapper::series()) {
                     QPieModelMapper::setSeries(series);
                     emit seriesReplaced();
                 }
             }
             /*!
                 Returns which row of the model is kept in sync with the values of the pie's slices
             */
             int QHPieModelMapper::valuesRow() const
             {
                 return valuesSection();
             }
             /*!
                 Sets the model row that is kept in sync with the pie slices values.
                 Parameter \a valuesRow specifies the row of the model.
             */
             void QHPieModelMapper::setValuesRow(int valuesRow)
             {
                 if (valuesRow != valuesSection()) {
                     setValuesSection(valuesRow);
                     emit valuesRowChanged();
                 }
             }
             /*!
                 Returns which row of the model is kept in sync with the labels of the pie's slices
             */
             int QHPieModelMapper::labelsRow() const
             {
                 return labelsSection();
             }
             /*!
                 Sets the model row that is kept in sync with the pie's slices labels.
                 Parameter \a labelsRow specifies the row of the model.
             */
             void QHPieModelMapper::setLabelsRow(int labelsRow)
             {
                 if (labelsRow != labelsSection()) {
                     setLabelsSection(labelsRow);
                     emit labelsRowChanged();
                 }
             }
             int QHPieModelMapper::firstColumn() const
             {
                 return first();
             }
             void QHPieModelMapper::setFirstColumn(int firstColumn)
             {
                 if (firstColumn != first()) {
                     setFirst(firstColumn);
                     emit firstColumnChanged();
                 }
             }
             int QHPieModelMapper::columnCount() const
             {
                 return count();
             }
             void QHPieModelMapper::setColumnCount(int columnCount)
             {
                 if (columnCount != count()) {
                     setCount(columnCount);
                     emit firstColumnChanged();
                 }
             }
             #include "moc_qhpiemodelmapper.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/piechart/qvpiemodelmapper.cpp +44 -5

             /****************************************************************************
             **
             ** 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 "qvpiemodelmapper.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QVPieModelMapper
                 \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 QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in columns.
                 It is possible to use both QAbstractItemModel and QPieSeries model API. QVPieModelMapper makes sure that Pie and the model are kept in sync.
                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
+            /*!
+                \qmlclass VPieModelMapper QVPieModelMapper
+                VPieModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source
+                for a pie series. It is possible to use both QAbstractItemModel and PieSeries data API to manipulate data.
+                VPieModelMapper keeps the Pie and the model in sync.
+                The following QML example would create a pie series with four slices (assuming the model has at least five rows).
+                Each slice would contain a label from column 1 and a value from column 2.
+                \code
+                    VPieModelMapper {
+                        series: pieSeries
+                        model: customModel
+                        labelsColumn: 1
+                        valuesColumn: 2
+                        firstRow: 1
+                        rowCount: 4
+                    }
+                \endcode
+            */
             /*!
                 \property QVPieModelMapper::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)
             */
+            /*!
+                \qmlproperty PieSeries VPieModelMapper::series
+                Defines the PieSeries object that is used by the mapper. If you define the mapper element as a child for a
+                PieSeries, leave this property undefined. 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).
+            */
             /*!
                 \property QVPieModelMapper::model
                 \brief Defines the model that is used by the mapper.
             */
+            /*!
+                \qmlproperty SomeModel VPieModelMapper::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 QVPieModelMapper::valuesColumn
                 \brief Defines which column of the model is kept in sync with the values of the pie's slices
                 Default value is: -1 (invalid mapping)
             */
+            /*!
+                \qmlproperty int VPieModelMapper::valuesColumn
+                Defines which column of the model is kept in sync with the values of the pie's slices. Default value is -1 (invalid
+                mapping).
+            */
             /*!
                 \property QVPieModelMapper::labelsColumn
                 \brief Defines which column of the model is kept in sync with the labels of the pie's slices
                 Default value is: -1 (invalid mapping)
             */
+            /*!
+                \qmlproperty int VPieModelMapper::labelsColumn
+                Defines which column of the model is kept in sync with the labels of the pie's slices. Default value is -1 (invalid
+                mapping).
+            */
             /*!
                 \property QVPieModelMapper::firstRow
                 \brief Defines which row of the model contains the first slice value.
                 Minimal and default value is: 0
             */
             /*!
-                \qmlproperty int QVPieModelMapper::firstRow
+                \qmlproperty int VPieModelMapper::firstRow
                 Defines which row of the model contains the first slice value.
                 The default value is 0.
             */
             /*!
                 \property QVPieModelMapper::rowCount
                 \brief Defines the number of rows of the model that are mapped as the data for QPieSeries
                 Minimal and default value is: -1 (count limited by the number of rows in the model)
             */
             /*!
-                \qmlproperty int QVPieModelMapper::columnCount
+                \qmlproperty int VPieModelMapper::columnCount
                 Defines the number of rows of the model that are mapped as the data for QPieSeries. The default value is
                 -1 (count limited by the number of rows in the model)
             */
             /*!
                 \fn void QVPieModelMapper::seriesReplaced()
                 Emitted when the series to which mapper is connected to has changed.
             */
             /*!
                 \fn void QVPieModelMapper::modelReplaced()
                 Emitted when the model to which mapper is connected to has changed.
             */
             /*!
                 \fn void QVPieModelMapper::valuesColumnChanged()
                 Emitted when the valuesColumn has changed.
             */
             /*!
                 \fn void QVPieModelMapper::labelsColumnChanged()
                 Emitted when the labelsColumn has changed.
             */
             /*!
                 \fn void QVPieModelMapper::firstRowChanged()
                 Emitted when the firstRow has changed.
             */
             /*!
                 \fn void QVPieModelMapper::rowCountChanged()
                 Emitted when the rowCount has changed.
             */
             /*!
                 Constructs a mapper object which is a child of \a parent.
             */
             QVPieModelMapper::QVPieModelMapper(QObject *parent) :
                 QPieModelMapper(parent)
             {
                 QPieModelMapper::setOrientation(Qt::Vertical);
             }
             QAbstractItemModel* QVPieModelMapper::model() const
             {
                 return QPieModelMapper::model();
             }
             void QVPieModelMapper::setModel(QAbstractItemModel *model)
             {
                 if (model != QPieModelMapper::model()) {
                     QPieModelMapper::setModel(model);
                     emit modelReplaced();
                 }
             }
             QPieSeries* QVPieModelMapper::series() const
             {
                 return QPieModelMapper::series();
             }
             void QVPieModelMapper::setSeries(QPieSeries *series)
             {
                 if (series != QPieModelMapper::series()) {
                     QPieModelMapper::setSeries(series);
                     emit seriesReplaced();
                 }
             }
             /*!
                 Returns which column of the model is kept in sync with the values of the pie's slices
             */
             int QVPieModelMapper::valuesColumn() const
             {
                 return QPieModelMapper::valuesSection();
             }
             /*!
                 Sets the model column that is kept in sync with the pie slices values.
                 Parameter \a valuesColumn specifies the row of the model.
             */
             void QVPieModelMapper::setValuesColumn(int valuesColumn)
             {
                 if (valuesColumn != valuesSection()) {
                     QPieModelMapper::setValuesSection(valuesColumn);
                     emit valuesColumnChanged();
                 }
             }
             /*!
                 Returns which column of the model is kept in sync with the labels of the pie's slices
             */
             int QVPieModelMapper::labelsColumn() const
             {
                 return QPieModelMapper::labelsSection();
             }
             /*!
                 Sets the model column that is kept in sync with the pie's slices labels.
                 Parameter \a labelsColumn specifies the row of the model.
             */
             void QVPieModelMapper::setLabelsColumn(int labelsColumn)
             {
                 if (labelsColumn != labelsSection()) {
                     QPieModelMapper::setLabelsSection(labelsColumn);
                     emit labelsColumnChanged();
                 }
             }
             int QVPieModelMapper::firstRow() const
             {
                 return first();
             }
             void QVPieModelMapper::setFirstRow(int firstRow)
             {
                 if (firstRow != first()) {
                     setFirst(firstRow);
                     emit firstRowChanged();
                 }
             }
             int QVPieModelMapper::rowCount() const
             {
                 return count();
             }
             void QVPieModelMapper::setRowCount(int rowCount)
             {
                 if (rowCount != count()) {
                     setCount(rowCount);
                     emit firstRowChanged();
                 }
             }
             #include "moc_qvpiemodelmapper.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/xychart/qhxymodelmapper.cpp +30 -4

             /****************************************************************************
             **
             ** 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 "qhxymodelmapper.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QHXYModelMapper
                 \mainclass
                 Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series.
                 Horizontal 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.
                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
+            /*!
+                \qmlclass HXYModelMapper QHXYModelMapper
+                HXYModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source
+                for XYSeries based series. It is possible to use both QAbstractItemModel and XYSeries data API to manipulate data.
+                HXYModelMapper keeps the series and the model in sync.
+            */
             /*!
                 \property QHXYModelMapper::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)
             */
+            /*!
+                \qmlproperty XYSeries HXYModelMapper::series
+                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).
+            */
             /*!
                 \property QHXYModelMapper::model
                 \brief Defines the model that is used by the mapper.
             */
+            /*!
+                \qmlproperty SomeModel HXYModelMapper::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 QHXYModelMapper::xRow
                 \brief Defines which row of the model is kept in sync with the x values of the QXYSeries
                 Default value is: -1 (invalid mapping)
             */
+            /*!
+                \qmlproperty int HXYModelMapper::xRow
+                Defines which row of the model is kept in sync with the x values of the QXYSeries. Default value is -1 (invalid
+                mapping).
+            */
             /*!
                 \property QHXYModelMapper::yRow
                 \brief Defines which row of the model is kept in sync with the  y values of the QXYSeries
                 Default value is: -1 (invalid mapping)
             */
+            /*!
+                \qmlproperty int HXYModelMapper::yRow
+                Defines which row of the model is kept in sync with the  y values of the QXYSeries. Default value is -1
+                (invalid mapping).
+            */
             /*!
                 \property QHXYModelMapper::firstColumn
                 \brief Defines which column of the model contains the data for the first point of the series.
                 Minimal and default value is: 0
             */
             /*!
-                \qmlproperty int QHXYModelMapper::firstColumn
+                \qmlproperty int HXYModelMapper::firstColumn
                 Defines which column of the model contains the data for the first point of the series.
                 The default value is 0.
             */
             /*!
                 \property QHXYModelMapper::columnCount
                 \brief Defines the number of columns of the model that are mapped as the data for series
                 Minimal and default value is: -1 (count limited by the number of columns in the model)
             */
             /*!
-                \qmlproperty int QHXYModelMapper::columnCount
+                \qmlproperty int HXYModelMapper::columnCount
                 Defines the number of columns of the model that are mapped as the data for series. The default value is
                 -1 (count limited by the number of columns in the model)
             */
             /*!
                 \fn void QHXYModelMapper::seriesReplaced()
                 Emitted when the series to which mapper is connected to has changed.
             */
             /*!
                 \fn void QHXYModelMapper::modelReplaced()
                 Emitted when the model to which mapper is connected to has changed.
             */
             /*!
                 \fn void QHXYModelMapper::xRowChanged()
                 Emitted when the xRow has changed.
             */
             /*!
                 \fn void QHXYModelMapper::yRowChanged()
                 Emitted when the yRow has changed.
             */
             /*!
                 \fn void QHXYModelMapper::firstColumnChanged()
                 Emitted when the firstColumn has changed.
             */
             /*!
                 \fn void QHXYModelMapper::columnCountChanged()
                 Emitted when the columnCount has changed.
             */
             /*!
                 Constructs a mapper object which is a child of \a parent.
             */
             QHXYModelMapper::QHXYModelMapper(QObject *parent) :
                 QXYModelMapper(parent)
             {
                 QXYModelMapper::setOrientation(Qt::Horizontal);
             }
             QAbstractItemModel* QHXYModelMapper::model() const
             {
                 return QXYModelMapper::model();
             }
             void QHXYModelMapper::setModel(QAbstractItemModel *model)
             {
                 if (model != QXYModelMapper::model()) {
                     QXYModelMapper::setModel(model);
                     emit modelReplaced();
                 }
             }
             QXYSeries* QHXYModelMapper::series() const
             {
                 return QXYModelMapper::series();
             }
             void QHXYModelMapper::setSeries(QXYSeries *series)
             {
                 if (series != QXYModelMapper::series()) {
                     QXYModelMapper::setSeries(series);
                     emit seriesReplaced();
                 }
             }
             int QHXYModelMapper::xRow() const
             {
                 return QXYModelMapper::xSection();
             }
             void QHXYModelMapper::setXRow(int xRow)
             {
                 if (xRow != xSection()) {
                     return QXYModelMapper::setXSection(xRow);
                     emit xRowChanged();
                 }
             }
             int QHXYModelMapper::yRow() const
             {
                 return QXYModelMapper::ySection();
             }
             void QHXYModelMapper::setYRow(int yRow)
             {
                 if (yRow != ySection()) {
                     return QXYModelMapper::setYSection(yRow);
                     emit yRowChanged();
                 }
             }
             int QHXYModelMapper::firstColumn() const
             {
                 return first();
             }
             void QHXYModelMapper::setFirstColumn(int firstColumn)
             {
                 if (firstColumn != first()) {
                     setFirst(firstColumn);
                     emit firstColumnChanged();
                 }
             }
             int QHXYModelMapper::columnCount() const
             {
                 return count();
             }
             void QHXYModelMapper::setColumnCount(int columnCount)
             {
                 if (columnCount != count()) {
                     setCount(columnCount);
                     emit firstColumnChanged();
                 }
             }
             #include "moc_qhxymodelmapper.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/xychart/qvxymodelmapper.cpp +31 -6

             /****************************************************************************
             **
             ** 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 "qvxymodelmapper.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QVXYModelMapper
                 \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 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.
                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
+            /*!
+                \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.
+            */
             /*!
                 \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)
             */
+            /*!
+                \qmlproperty XYSeries VXYModelMapper::series
+                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).
+            */
             /*!
                 \property QVXYModelMapper::model
                 \brief Defines the model that is used by the mapper.
             */
+            /*!
+                \qmlproperty SomeModel VXYModelMapper::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 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)
             */
+            /*!
+                \qmlproperty int VXYModelMapper::xColumn
+                Defines which column of the model is kept in sync with the x values of XYSeries. Default value is -1 (invalid
+                mapping).
+            */
             /*!
                 \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)
             */
+            /*!
+                \qmlproperty int VXYModelMapper::yColumn
+                Defines which column of the model is kept in sync with the y values of QXYSeries. Default value is -1 (invalid
+                mapping).
+            */
             /*!
                 \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
             */
             /*!
-                \qmlproperty int QVXYModelMapper::firstRow
+                \qmlproperty int VXYModelMapper::firstRow
                 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)
             */
             /*!
-                \qmlproperty int QVXYModelMapper::columnCount
+                \qmlproperty int VXYModelMapper::columnCount
                 Defines the number of rows of the model that are mapped as the data for series. The default value is
-                -1 (count limited by the number of rows in the model)
+                -1 (count limited by the number of rows in the model).
             */
             /*!
                 \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.
             */
             /*!
                 \fn void QVXYModelMapper::xColumnChanged()
                 Emitted when the xColumn has changed.
             */
             /*!
                 \fn void QVXYModelMapper::yColumnChanged()
                 Emitted when the yColumn has changed.
             */
             /*!
                 \fn void QVXYModelMapper::firstRowChanged()
                 Emitted when the firstRow has changed.
             */
             /*!
                 \fn void QVXYModelMapper::rowCountChanged()
                 Emitted when the rowCount has changed.
             */
             /*!
                 Constructs a mapper object which is a child of \a parent.
             */
             QVXYModelMapper::QVXYModelMapper(QObject *parent) :
                 QXYModelMapper(parent)
             {
                 QXYModelMapper::setOrientation(Qt::Vertical);
             }
             QAbstractItemModel* QVXYModelMapper::model() const
             {
                 return QXYModelMapper::model();
             }
             void QVXYModelMapper::setModel(QAbstractItemModel *model)
             {
                 if (model != QXYModelMapper::model()) {
                     QXYModelMapper::setModel(model);
                     emit modelReplaced();
                 }
             }
             QXYSeries* QVXYModelMapper::series() const
             {
                 return QXYModelMapper::series();
             }
             void QVXYModelMapper::setSeries(QXYSeries *series)
             {
                 if (series != QXYModelMapper::series()) {
                     QXYModelMapper::setSeries(series);
                     emit seriesReplaced();
                 }
             }
             int QVXYModelMapper::xColumn() const
             {
                 return QXYModelMapper::xSection();
             }
             void QVXYModelMapper::setXColumn(int xColumn)
             {
                 if (xColumn != xSection()) {
                     return QXYModelMapper::setXSection(xColumn);
                     emit xColumnChanged();
                 }
             }
             int QVXYModelMapper::yColumn() const
             {
                 return QXYModelMapper::ySection();
             }
             void QVXYModelMapper::setYColumn(int yColumn)
             {
                 if (yColumn != ySection()) {
                     return QXYModelMapper::setYSection(yColumn);
                     emit yColumnChanged();
                 }
             }
             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);
                     emit firstRowChanged();
                 }
             }
             #include "moc_qvxymodelmapper.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages