##// END OF EJS Templates
Model mappers docs updated
Marek Rosa -
r1378:cb1c9eed2618
parent child
Show More
@@ -28,10 +28,22
28 QTCOMMERCIALCHART_BEGIN_NAMESPACE
28 QTCOMMERCIALCHART_BEGIN_NAMESPACE
29
29
30 /*!
30 /*!
31 \class QBarModelMapper
32 \brief part of QtCommercial chart API.
33 \mainclass
34
35 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.
36 Curently it is NOT possible to use both QAbstractItemModel and QBarSeries model API.
37 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
38 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
39 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
40 */
41
42 /*!
31 \property QBarModelMapper::series
43 \property QBarModelMapper::series
32 \brief Defines the QPieSeries object that is used by the mapper.
44 \brief Defines the QPieSeries object that is used by the mapper.
33
45
34 All the data in the series in the series is discarded when it is set to the mapper.
46 All the data in the series is discarded when it is set to the mapper.
35 When new series is specified the old series is disconnected (it preserves its data)
47 When new series is specified the old series is disconnected (it preserves its data)
36 */
48 */
37
49
@@ -55,18 +67,6 QTCOMMERCIALCHART_BEGIN_NAMESPACE
55 */
67 */
56
68
57 /*!
69 /*!
58 \class QBarModelMapper
59 \brief part of QtCommercial chart API.
60 \mainclass
61
62 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.
63 Curently it is NOT possible to use both QAbstractItemModel and QXYSeries model API.
64 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
65 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
66 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
67 */
68
69 /*!
70 Constructs a mapper object which is a child of \a parent.
70 Constructs a mapper object which is a child of \a parent.
71 */
71 */
72 QBarModelMapper::QBarModelMapper(QObject *parent) :
72 QBarModelMapper::QBarModelMapper(QObject *parent) :
@@ -27,7 +27,11 QTCOMMERCIALCHART_BEGIN_NAMESPACE
27 \brief part of QtCommercial chart API.
27 \brief part of QtCommercial chart API.
28 \mainclass
28 \mainclass
29
29
30 Nothing here yet
30 Horizontal model mapper is used to create a connection between QBarSeries and QAbstractItemModel derived model object.
31 Curently it is NOT possible to use both QAbstractItemModel and QBarSeries model API.
32 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
33 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
34 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
31 */
35 */
32
36
33 /*!
37 /*!
@@ -27,7 +27,11 QTCOMMERCIALCHART_BEGIN_NAMESPACE
27 \brief part of QtCommercial chart API.
27 \brief part of QtCommercial chart API.
28 \mainclass
28 \mainclass
29
29
30 Nothing here yet
30 Vertical model mapper is used to create a connection between QBarSeries and QAbstractItemModel derived model object.
31 Curently it is NOT possible to use both QAbstractItemModel and QBarSeries model API.
32 When the series is set to the mapper the QBarSeries and QBarSet API that affect the data (append, setValue, remove) should not be used.
33 The model and the QBarSeries won't be kept in sync. Model API should be used to insert,remove,modify BarSets.
34 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
31 */
35 */
32
36
33 /*!
37 /*!
@@ -27,7 +27,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
27 \brief part of QtCommercial chart API.
27 \brief part of QtCommercial chart API.
28 \mainclass
28 \mainclass
29
29
30 This class is used to create a connection between QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in rows.
30 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.
31 It is possible to use both QAbstractItemModel and QPieSeries model API. QHPieModelMapper makes sure that Pie and the model are kept in sync.
31 It is possible to use both QAbstractItemModel and QPieSeries model API. QHPieModelMapper makes sure that Pie and the model are kept in sync.
32 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
32 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
33 */
33 */
@@ -30,7 +30,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
30 \property QPieModelMapper::series
30 \property QPieModelMapper::series
31 \brief Defines the QPieSeries object that is used by the mapper.
31 \brief Defines the QPieSeries object that is used by the mapper.
32
32
33 All the data in the series in the series is discarded when it is set to the mapper.
33 All the data in the series is discarded when it is set to the mapper.
34 When new series is specified the old series is disconnected (it preserves its data)
34 When new series is specified the old series is disconnected (it preserves its data)
35 */
35 */
36
36
@@ -27,7 +27,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
27 \brief part of QtCommercial chart API.
27 \brief part of QtCommercial chart API.
28 \mainclass
28 \mainclass
29
29
30 This class is used to create a connection between QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in columns.
30 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.
31 It is possible to use both QAbstractItemModel and QPieSeries model API. QVPieModelMapper makes sure that Pie and the model are kept in sync.
31 It is possible to use both QAbstractItemModel and QPieSeries model API. QVPieModelMapper makes sure that Pie and the model are kept in sync.
32 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
32 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
33 */
33 */
@@ -27,7 +27,9 QTCOMMERCIALCHART_BEGIN_NAMESPACE
27 \brief part of QtCommercial chart API.
27 \brief part of QtCommercial chart API.
28 \mainclass
28 \mainclass
29
29
30 Nothing here yet
30 Horizontal model mapper is used to create a connection between QXYSeries and QAbstractItemModel derived model object.
31 It is possible to use both QAbstractItemModel and QXYSeries model API. QXYModelMapper makes sure that QXYSeries and the model are kept in sync.
32 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
31 */
33 */
32
34
33 /*!
35 /*!
@@ -26,10 +26,20
26 QTCOMMERCIALCHART_BEGIN_NAMESPACE
26 QTCOMMERCIALCHART_BEGIN_NAMESPACE
27
27
28 /*!
28 /*!
29 \class QXYModelMapper
30 \brief part of QtCommercial chart API.
31 \mainclass
32
33 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.
34 It is possible to use both QAbstractItemModel and QXYSeries model API. QXYModelMapper makes sure that QXYSeries and the model are kept in sync.
35 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
36 */
37
38 /*!
29 \property QXYModelMapper::series
39 \property QXYModelMapper::series
30 \brief Defines the QPieSeries object that is used by the mapper.
40 \brief Defines the QPieSeries object that is used by the mapper.
31
41
32 All the data in the series in the series is discarded when it is set to the mapper.
42 All the data in the series is discarded when it is set to the mapper.
33 When new series is specified the old series is disconnected (it preserves its data)
43 When new series is specified the old series is disconnected (it preserves its data)
34 */
44 */
35
45
@@ -53,16 +63,6 QTCOMMERCIALCHART_BEGIN_NAMESPACE
53 */
63 */
54
64
55 /*!
65 /*!
56 \class QXYModelMapper
57 \brief part of QtCommercial chart API.
58 \mainclass
59
60 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.
61 It is possible to use both QAbstractItemModel and QXYSeries model API. QXYModelMapper makes sure that QXYSeries and the model are kept in sync.
62 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
63 */
64
65 /*!
66 Constructs a mapper object which is a child of \a parent.
66 Constructs a mapper object which is a child of \a parent.
67 */
67 */
68 QXYModelMapper::QXYModelMapper(QObject *parent):
68 QXYModelMapper::QXYModelMapper(QObject *parent):
General Comments 0
You need to be logged in to leave comments. Login now