HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1378:cb1c9eed2618

Model mappers docs updated

Marek Rosa -

r1378:cb1c9eed2618

parent child

Context file:

r1378:cb1c9eed2618

Collapse all files

src/barchart/qbarmodelmapper.cpp +13 -13

              QTCOMMERCIALCHART_BEGIN_NAMESPACE
              /*!
+                 \class QBarModelMapper
+                 \brief part of QtCommercial chart API.
+                 \mainclass
+                 The instance of this class cannot be created directly. QHBarModelMapper of QVBarModelMapper should be used instead. This class is used to create a connection between QBarSeries and QAbstractItemModel derived model object.
+                 Curently it is NOT possible to use both QAbstractItemModel and QBarSeries model API.
+                 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
+                 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
+                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
+             */
+             /*!
                  \property QBarModelMapper::series
                  \brief Defines the QPieSeries object that is used by the mapper.
-                 All the data in the series in the series is discarded when it is set to 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)
              */
              */
              /*!
-                 \class QBarModelMapper
-                 \brief part of QtCommercial chart API.
-                 \mainclass
-                 The instance of this class cannot be created directly. QHBarModelMapper of QVBarModelMapper should be used instead. This class is used to create a connection between QBarSeries and QAbstractItemModel derived model object.
-                 Curently it is NOT possible to use both QAbstractItemModel and QXYSeries model API.
-                 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
-                 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
-                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
-             */
-             /*!
                  Constructs a mapper object which is a child of \a parent.
              */
              QBarModelMapper::QBarModelMapper(QObject *parent) :

src/barchart/qhbarmodelmapper.cpp +5 -1

                  \brief part of QtCommercial chart API.
                  \mainclass
-                 Nothing here yet
+                 Horizontal model mapper is used to create a connection between QBarSeries and QAbstractItemModel derived model object.
+                 Curently it is NOT possible to use both QAbstractItemModel and QBarSeries model API.
+                 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
+                 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
+                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
              */
              /*!

src/barchart/qvbarmodelmapper.cpp +5 -1

                  \brief part of QtCommercial chart API.
                  \mainclass
-                 Nothing here yet
+                 Vertical model mapper is used to create a connection between QBarSeries and QAbstractItemModel derived model object.
+                 Curently it is NOT possible to use both QAbstractItemModel and QBarSeries model API.
+                 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
+                 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
+                 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
              */
              /*!

src/piechart/qhpiemodelmapper.cpp +1 -1

                  \brief part of QtCommercial chart API.
                  \mainclass
-                 This class is used to create a connection between QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in rows.
+                 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.
              */

src/piechart/qpiemodelmapper.cpp +1 -1

                  \property QPieModelMapper::series
                  \brief Defines the QPieSeries object that is used by the mapper.
-                 All the data in the series in the series is discarded when it is set to 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)
              */

src/piechart/qvpiemodelmapper.cpp +1 -1

                  \brief part of QtCommercial chart API.
                  \mainclass
-                 This class is used to create a connection between QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in columns.
+                 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.
              */

src/xychart/qhxymodelmapper.cpp +3 -1

                  \brief part of QtCommercial chart API.
                  \mainclass
-                 Nothing here yet
+                 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.
              */
              /*!

src/xychart/qxymodelmapper.cpp +11 -11

              QTCOMMERCIALCHART_BEGIN_NAMESPACE
              /*!
+                 \class QXYModelMapper
+                 \brief part of QtCommercial chart API.
+                 \mainclass
+                 The instance of this class cannot be created directly. QHXYModelMapper of QVXYModelMapper should be used instead. This class 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.
+             */
+             /*!
                  \property QXYModelMapper::series
                  \brief Defines the QPieSeries object that is used by the mapper.
-                 All the data in the series in the series is discarded when it is set to 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)
              */
              */
              /*!
-                 \class QXYModelMapper
-                 \brief part of QtCommercial chart API.
-                 \mainclass
-                 The instance of this class cannot be created directly. QHXYModelMapper of QVXYModelMapper should be used instead. This class 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.
-             */
-             /*!
                  Constructs a mapper object which is a child of \a parent.
              */
              QXYModelMapper::QXYModelMapper(QObject *parent):

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