HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1344:24b340b0b9d0

Added documentation for XYModelMapper classes

Marek Rosa -

r1344:24b340b0b9d0

parent child

Context file:

r1344:24b340b0b9d0

Collapse all files

src/xychart/qhxymodelmapper.cpp +13 0

@@ -10,6 +10,19 QTCOMMERCIALCHART_BEGIN_NAMESPACE
10	Nothing here yet	10	Nothing here yet
11	*/	11	*/
12		12
		13	/*!
		14	\property QHXYModelMapper::xRow
		15	\brief Defines which row of the model is kept in sync with the x values of the QXYSeries
		16	Default value is: -1 (invalid mapping)
		17	*/
		18
		19	/*!
		20	\property QHXYModelMapper::yRow
		21	\brief Defines which row of the model is kept in sync with the y values of the QXYSeries
		22
		23	Default value is: -1 (invalid mapping)
		24	*/
		25
13	QHXYModelMapper::QHXYModelMapper(QObject *parent) :	26	QHXYModelMapper::QHXYModelMapper(QObject *parent) :
14	QXYModelMapper(parent)	27	QXYModelMapper(parent)
15	{	28	{

src/xychart/qvxymodelmapper.cpp +14 0

@@ -10,6 +10,20 QTCOMMERCIALCHART_BEGIN_NAMESPACE
10	Nothing here yet	10	Nothing here yet
11	*/	11	*/
12		12
		13	/*!
		14	\property QVXYModelMapper::xColumn
		15	\brief Defines which column of the model is kept in sync with the x values of QXYSeries
		16
		17	Default value is: -1 (invalid mapping)
		18	*/
		19
		20	/*!
		21	\property QVXYModelMapper::yColumn
		22	\brief Defines which column of the model is kept in sync with the y values of QXYSeries
		23
		24	Default value is: -1 (invalid mapping)
		25	*/
		26
13	QVXYModelMapper::QVXYModelMapper(QObject *parent) :	27	QVXYModelMapper::QVXYModelMapper(QObject *parent) :
14	QXYModelMapper(parent)	28	QXYModelMapper(parent)
15	{	29	{

src/xychart/qxymodelmapper.cpp +65 -7

             QTCOMMERCIALCHART_BEGIN_NAMESPACE
+            /*!
+                \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.
+                When new series is specified the old series is disconnected (it preserves its data)
+            */
+            /*!
+                \property QXYModelMapper::model
+                \brief Defines the model that is used by the mapper.
+            */
+            /*!
+                \property QXYModelMapper::first
+                \brief Defines which item of the model's row/column should be mapped as the first x/y pair
+                Minimal and default value is: 0
+            */
+            /*!
+                \property QXYModelMapper::count
+                \brief Defines the number of rows/columns of the model that are mapped as the data for QXYSeries
+                Minimal and default value is: -1 (count limited by the number of rows/columns in the model)
+            */
+            /*!
+                \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 QPieSeries model API. QPieModelMapper 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.
+            */
             QXYModelMapper::QXYModelMapper(QObject *parent):
                 QObject(parent),
                 d_ptr(new QXYModelMapperPrivate(this))
             {
             }
-            QXYModelMapper::~QXYModelMapper()
-                Q_D(QXYModelMapper);
-                disconnect(d->m_model, 0, d, 0);
-                //    disconnect(d->m_series, 0, d, 0);
             QAbstractItemModel* QXYModelMapper::model() const
             {
                 Q_D(const QXYModelMapper);
                 d->initializeXYFromModel();
             }
+            /*!
+                Returns the orientation that is used when QXYModelMapper accesses the model.
+                This mean whether the consecutive x/y values of the QXYSeries are read from rows (Qt::Horizontal)
+                or from columns (Qt::Vertical)
+            */
             Qt::Orientation QXYModelMapper::orientation() const
             {
                 Q_D(const QXYModelMapper);
                 return d->m_orientation;
             }
+            /*!
+                Returns the \a orientation that is used when QXYModelMapper accesses the model.
+                This mean whether the consecutive x/y values of the QXYSeries are read from rows (Qt::Horizontal)
+                or from columns (Qt::Vertical)
+            */
             void QXYModelMapper::setOrientation(Qt::Orientation orientation)
             {
                 Q_D(QXYModelMapper);
                 d->initializeXYFromModel();
             }
+            /*!
+                Returns which section of the model is kept in sync with the x values of the QXYSeries
+            */
             int QXYModelMapper::xSection() const
             {
                 Q_D(const QXYModelMapper);
                 return d->m_xSection;
             }
+            /*!
+                Sets the model section that is kept in sync with the x values of the QXYSeries.
+                Parameter \a xSection specifies the section of the model.
+            */
             void QXYModelMapper::setXSection(int xSection)
             {
                 Q_D(QXYModelMapper);
                 d->initializeXYFromModel();
             }
+            /*!
+                Returns which section of the model is kept in sync with the y values of the QXYSeries
+            */
             int QXYModelMapper::ySection() const
             {
                 Q_D(const QXYModelMapper);
                 return d->m_ySection;
             }
+            /*!
+                Sets the model section that is kept in sync with the y values of the QXYSeries.
+                Parameter \a ySection specifies the section of the model.
+            */
             void QXYModelMapper::setYSection(int ySection)
             {
                 Q_D(QXYModelMapper);
                 d->initializeXYFromModel();
             }
+            /*!
+                Resets the QXYModelMapper to the default state.
+                first: 0; count: -1; xSection: -1; ySection: -1;
+            */
             void QXYModelMapper::reset()
             {
                 Q_D(QXYModelMapper);

src/xychart/qxymodelmapper.h 0 -1

             protected:
                 explicit QXYModelMapper(QObject *parent = 0);
-                ~QXYModelMapper();
                 Qt::Orientation orientation() const;
                 void setOrientation(Qt::Orientation orientation);

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