HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1348:da176c513ee6

Added documentation for BarModelMapper classes

Marek Rosa -

r1348:da176c513ee6

parent child

Context file:

r1348:da176c513ee6

Collapse all files

src/barchart/qbarmodelmapper.cpp +74 0

             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
+                \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.
+                When new series is specified the old series is disconnected (it preserves its data)
+            */
+            /*!
+                \property QBarModelMapper::model
+                \brief Defines the model that is used by the mapper.
+            */
+            /*!
+                \property QBarModelMapper::first
+                \brief Defines which item of the model's row/column should be mapped as the value of the first QBarSet in the series.
+                Minimal and default value is: 0
+            */
+            /*!
+                \property QBarModelMapper::count
+                \brief Defines the number of rows/columns of the model that are mapped as the data for QBarSeries
+                Minimal and default value is: -1 (count limited by the number of rows/columns in the model)
+            */
+            /*!
+                \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) :
                 d->initializeBarFromModel();
             }
+            /*!
+                Returns the orientation that is used when QBarModelMapper accesses the model.
+                This mean whether the consecutive values of the bar set are read from row (Qt::Horizontal)
+                or from columns (Qt::Vertical)
+            */
             Qt::Orientation QBarModelMapper::orientation() const
             {
                 Q_D(const QBarModelMapper);
                 return d->m_orientation;
             }
+            /*!
+                Returns the \a orientation that is used when QBarModelMapper accesses the model.
+                This mean whether the consecutive values of the pie are read from row (Qt::Horizontal)
+                or from columns (Qt::Vertical)
+            */
             void QBarModelMapper::setOrientation(Qt::Orientation orientation)
             {
                 Q_D(QBarModelMapper);
                 d->initializeBarFromModel();
             }
+            /*!
+                Returns which section of the model is used as the data source for the first bar set
+            */
             int QBarModelMapper::firstBarSetSection() const
             {
                 Q_D(const QBarModelMapper);
                 return d->m_firstBarSetSection;
             }
+            /*!
+                Sets the model section that is used as the data source for the first bar set
+                Parameter \a firstBarSetSection specifies the section of the model.
+            */
             void QBarModelMapper::setFirstBarSetSection(int firstBarSetSection)
             {
                 Q_D(QBarModelMapper);
                 d->initializeBarFromModel();
             }
+            /*!
+                Returns which section of the model is used as the data source for the last bar set
+            */
             int QBarModelMapper::lastBarSetSection() const
             {
                 Q_D(const QBarModelMapper);
                 return d->m_lastBarSetSection;
             }
+            /*!
+                Sets the model section that is used as the data source for the last bar set
+                Parameter \a lastBarSetSection specifies the section of the model.
+            */
             void QBarModelMapper::setLastBarSetSection(int lastBarSetSection)
             {
                 Q_D(QBarModelMapper);
                 d->initializeBarFromModel();
             }
+            /*!
+                Returns which section of the model is used as the data source for the x axis categories.
+            */
             int QBarModelMapper::categoriesSection() const
             {
                 Q_D(const QBarModelMapper);
                 return d->m_categoriesSection;
             }
+            /*!
+                Sets the model section that is used as the data source for the x axis categories.
+                Parameter \a categoriesSection specifies the section of the model.
+            */
             void QBarModelMapper::setCategoriesSection(int categoriesSection)
             {
                 Q_D(QBarModelMapper);
                 d->initializeBarFromModel();
             }
+            /*!
+                Resets the QBarModelMapper to the default state.
+                first: 0; count: -1; firstBarSetSection: -1; lastBarSetSection: -1; categoriesSection: -1
+            */
             void QBarModelMapper::reset()
             {
                 Q_D(QBarModelMapper);

src/barchart/qbarmodelmapper.h 0 -3

                 Qt::Orientation orientation() const;
                 void setOrientation(Qt::Orientation orientation);
-            Q_SIGNALS:
-                void updated();
             protected:
                 QBarModelMapperPrivate * const d_ptr;
                 Q_DECLARE_PRIVATE(QBarModelMapper)

src/barchart/qhbarmodelmapper.cpp +21 0

@@ -11,6 +11,27 QTCOMMERCIALCHART_BEGIN_NAMESPACE
11	*/	11	*/
12		12
13	/*!	13	/*!
		14	\property QHBarModelMapper::firstBarSetRow
		15	\brief Defines which column of the model is used as the data source for the first bar set
		16
		17	Default value is: -1 (invalid mapping)
		18	*/
		19
		20	/*!
		21	\property QHBarModelMapper::lastBarSetRow
		22	\brief Defines which column of the model is used as the data source for the last bar set
		23
		24	Default value is: -1 (invalid mapping)
		25	*/
		26
		27	/*!
		28	\property QHBarModelMapper::categoriesRow
		29	\brief Defines which row of the model is used as the data source for the x axis categories
		30
		31	Default value is: -1 (invalid mapping)
		32	*/
		33
		34	/*!
14	Constructs a mapper object which is a child of \a parent.	35	Constructs a mapper object which is a child of \a parent.
15	*/	36	*/
16	QHBarModelMapper::QHBarModelMapper(QObject *parent) :	37	QHBarModelMapper::QHBarModelMapper(QObject *parent) :

src/barchart/qvbarmodelmapper.cpp +21 0

@@ -11,6 +11,27 QTCOMMERCIALCHART_BEGIN_NAMESPACE
11	*/	11	*/
12		12
13	/*!	13	/*!
		14	\property QVBarModelMapper::firstBarSetColumn
		15	\brief Defines which column of the model is used as the data source for the first bar set
		16
		17	Default value is: -1 (invalid mapping)
		18	*/
		19
		20	/*!
		21	\property QVBarModelMapper::lastBarSetColumn
		22	\brief Defines which column of the model is used as the data source for the last bar set
		23
		24	Default value is: -1 (invalid mapping)
		25	*/
		26
		27	/*!
		28	\property QVBarModelMapper::categoriesColumn
		29	\brief Defines which column of the model is used as the data source for the x axis categories
		30
		31	Default value is: -1 (invalid mapping)
		32	*/
		33
		34	/*!
14	Constructs a mapper object which is a child of \a parent.	35	Constructs a mapper object which is a child of \a parent.
15	*/	36	*/
16	QVBarModelMapper::QVBarModelMapper(QObject *parent) :	37	QVBarModelMapper::QVBarModelMapper(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