HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r900:4e59f6549e80

Added documentation for model related funtions

Marek Rosa -

r900:4e59f6549e80

parent child

Context file:

r900:4e59f6549e80

Collapse all files

examples/modeldata/tablewidget.cpp 0 -2

                 // create table view and add model to it
                 QTableView *tableView = new QTableView;
                 tableView->setModel(model);
-            //    tableView->
-            //    tableView->setMinimumWidth(200);
                 tableView->setColumnWidth(0, 56);
                 tableView->setColumnWidth(1, 56);
                 tableView->setColumnWidth(2, 56);

src/barchart/qbarseries.cpp +17 -8

                 }
             }
-            // TODO
+            /*!
+                 \fn bool QBarSeries::setModelMapping(int categories, int bottomBoundry, int topBoundry, Qt::Orientation orientation)
+                 Sets column/row specified by \a categories to be used as a list of bar series categories.
+                 Parameter \a bottomBoundry indicates the column/row where the first bar set is located in the model.
+                 Parameter \a topBoundry indicates the column/row where the last bar set is located in the model.
+                 All the columns/rows inbetween those two values are also used as data for bar sets.
+                 The \a orientation paramater specifies whether the data is in columns or in rows.
+             */
             void QBarSeries::setModelMapping(int categories, int bottomBoundry, int topBoundry, Qt::Orientation orientation)
             {
                 if (!m_model)
                             this, SLOT(modelDataRemoved(QModelIndex,int,int)));
                 }
                 // create the initial bars
                 delete m_internalModel;
                 if (m_mapOrientation == Qt::Vertical) {
                 }
             }
-            void QBarSeries::setModelMappingShift(int first, int count)
+            /*!
+                \internal
-                m_mapFirst = first;
+            */
-                m_mapCount = count;
             void QBarSeries::modelUpdated(QModelIndex topLeft, QModelIndex bottomRight)
             {
                 Q_UNUSED(bottomRight)
                 }
             }
+            /*!
+                \internal
+            */
             void QBarSeries::modelDataAdded(QModelIndex /*parent*/, int start, int /*end*/)
             {
                 if (m_mapOrientation == Qt::Vertical) {
                 emit restructuredBars();
             }
+            /*!
+                \internal
+            */
             void QBarSeries::modelDataRemoved(QModelIndex parent, int start, int end)
             {
                 Q_UNUSED(parent)

src/barchart/qbarseries.h +1 -2

                 void setLabelsVisible(bool visible = true);
                 bool setModel(QAbstractItemModel *model);
                 void setModelMapping(int categories, int bottomBoundry, int topBoundry, Qt::Orientation orientation = Qt::Vertical);
-                void setModelMappingShift(int first, int count);
             public:
                 // TODO: Functions below this are not part of api and will be moved

src/piechart/qpieseries.cpp +7 0

                 }
             }
+            /*!
+                 \fn bool QPieSeries::setModelMapping(int modelValuesLine, int modelLabelsLine, Qt::Orientation orientation)
+                 Sets column/row specified by \a modelValuesLine to be used as a list of pie slice values for the pie.
+                 Parameter \a modelValuesLine indicates the column/row where the values for the pie slices are located in the model.
+                 Parameter \a modelLabelsLine indicates the column/row where the labels for the pie slices are located in the model.
+                 The \a orientation paramater specifies whether the data is in columns or in rows.
+             */
             void QPieSeries::setModelMapping(int modelValuesLine, int modelLabelsLine, Qt::Orientation orientation)
             {
                 Q_D(QPieSeries);

src/splinechart/qsplineseries.cpp +30 -11

@@ -155,19 +155,38 void QSplineSeries::updateControlPoints()
155	}	155	}
156	}	156	}
157		157
158	bool QSplineSeries::setModel(QAbstractItemModel* model)	158	/*!
159	{	159	\fn bool QSplineSeries::setModel(QAbstractItemModel *model)
160	QXYSeries::setModel(model);	160	Sets the \a model to be used as a data source
161	// calculateControlPoints();	161	\sa setModelMapping(), setModelMappingRange()
162	return true;	162	*/
163	}	163	//bool QSplineSeries::setModel(QAbstractItemModel* model)
		164	//{
		165	// QXYSeries::setModel(model);
		166	//// calculateControlPoints();
		167	// return true;
		168	//}
164		169
165	void QSplineSeries::setModelMapping(int modelX, int modelY, Qt::Orientation orientation)	170	/*!
166	{	171	\fn bool QXYSeries::setModelMapping(int modelX, int modelY, Qt::Orientation orientation)
167	QLineSeries::setModelMapping(modelX, modelY, orientation);	172	Sets the \a modelX to be used as a data source for x coordinate and \a modelY to be used
168	// calculateControlPoints();	173	as a data source for y coordinate. The \a orientation paramater specifies whether the data
169	}	174	is in columns or in rows.
		175	*/
		176	//void QSplineSeries::setModelMapping(int modelX, int modelY, Qt::Orientation orientation)
		177	//{
		178	// QLineSeries::setModelMapping(modelX, modelY, orientation);
		179	//// calculateControlPoints();
		180	//}
170		181
		182	/*!
		183	\fn bool QSplineSeries::setModelMappingRange(int first, int count)
		184	Allows limiting the model mapping.
		185	Parameter \a first specifies which element of the model should be used as a first one of the series.
		186	Parameter \a count specifies how many elements should be mapped. If count is not specified (defaults to -1)
		187	then all the items following \a first item in a model are used.
		188	\sa setModel(), setModelMapping()
		189	*/
171	void QSplineSeries::setModelMappingRange(int first, int count)	190	void QSplineSeries::setModelMappingRange(int first, int count)
172	{	191	{
173	QLineSeries::setModelMappingRange(first, count);	192	QLineSeries::setModelMappingRange(first, count);

src/splinechart/qsplineseries.h +2 -2

                 QSeriesType type() const {return QSeries::SeriesTypeSpline;}
                 QPointF controlPoint(int index) const {return m_controlPoints[index];}
-                bool setModel(QAbstractItemModel *model);
+            //    bool setModel(QAbstractItemModel *model);
-                void setModelMapping(int modelX, int modelY, Qt::Orientation orientation = Qt::Vertical);
+            //    void setModelMapping(int modelX, int modelY, Qt::Orientation orientation = Qt::Vertical);
                 void setModelMappingRange(int first, int count);
             private:

src/xychart/qxyseries.cpp +29 0

             */
             /*!
+                \fn int QXYSeries::mapFirst() const
+                Returns the index of the model's item that is used as a first one for the series.
+                \sa mapCount()
+            */
+            /*!
+                \fn int QXYSeries::mapCount() const
+                Returns the number of the items that are taken from the model.
+                If -1 it means all the items of the model following the first one are used.
+                \sa mapFirst()
+            */
+            /*!
                 Constructs empty series object which is a child of \a parent.
                 When series object is added to QChartView or QChart instance ownerships is transfered.
             */
             /*!
                  \fn bool QXYSeries::setModel(QAbstractItemModel *model)
                  Sets the \a model to be used as a data source
+                 \sa setModelMapping(), setModelMappingRange()
              */
             bool QXYSeries::setModel(QAbstractItemModel *model) {
                 }
             }
+            /*!
+                 \fn bool QXYSeries::setModelMapping(int modelX, int modelY, Qt::Orientation orientation)
+                 Sets the \a modelX to be used as a data source for x coordinate and \a modelY to be used
+                 as a data source for y coordinate. The \a orientation paramater specifies whether the data
+                 is in columns or in rows.
+                 \sa setModel(), setModelMappingRange()
+             */
             void QXYSeries::setModelMapping(int modelX, int modelY, Qt::Orientation orientation)
             {
                 if (m_model == 0)
                 }
             }
+            /*!
+                 \fn bool QXYSeries::setModelMappingRange(int first, int count)
+                 Allows limiting the model mapping.
+                 Parameter \a first specifies which element of the model should be used as a first one of the series.
+                 Parameter \a count specifies how many elements should be mapped. If count is not specified (defaults to -1)
+                 then all the items following \a first item in a model are used.
+                 \sa setModel(), setModelMapping()
+             */
             void QXYSeries::setModelMappingRange(int first, int count)
             {
                 m_mapFirst = first;

src/xychart/qxyseries.h +1 0

                 virtual void setModelMapping(int modelX, int modelY, Qt::Orientation orientation = Qt::Vertical);
                 virtual void setModelMappingRange(int first, int count = 0);
                 int mapFirst() const { return m_mapFirst; }
+                int mapCount() const { return m_mapCount; }
             private Q_SLOTS:
                 void modelUpdated(QModelIndex topLeft, QModelIndex bottomRight);

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