HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1731:d59786143197

Docs update

Marek Rosa -

r1731:d59786143197

parent child

Context file:

r1731:d59786143197

Collapse all files

src/axis/datetimeaxis/qdatetimeaxis.cpp +15 -15

             */
             /*!
-              \fn void QDateTimeAxis::minChanged(qreal min)
+              \fn void QDateTimeAxis::minChanged(QDateTime min)
               Axis emits signal when \a min of axis has changed.
             */
             /*!
-              \qmlsignal ValuesAxis::onMinChanged(real min)
+              \qmlsignal ValuesAxis::onMinChanged(QDateTime min)
               Axis emits signal when \a min of axis has changed.
             */
             /*!
-              \fn void QDateTimeAxis::maxChanged(qreal max)
+              \fn void QDateTimeAxis::maxChanged(QDateTime max)
               Axis emits signal when \a max of axis has changed.
             */
             /*!
-              \qmlsignal ValuesAxis::onMaxChanged(real max)
+              \qmlsignal ValuesAxis::onMaxChanged(QDateTime max)
               Axis emits signal when \a max of axis has changed.
             */
             /*!
-              \fn void QDateTimeAxis::rangeChanged(qreal min, qreal max)
+              \fn void QDateTimeAxis::rangeChanged(QDateTime min, QDateTime max)
               Axis emits signal when \a min or \a max of axis has changed.
             */
             */
             /*!
-              \property QDateTimeAxis::niceNumbersEnabled
-              Whether the nice numbers algorithm is enabled or not for the axis.
-            */
-            /*!
-              \qmlproperty bool ValuesAxis::niceNumbersEnabled
-              Whether the nice numbers algorithm is enabled or not for the axis.
-            */
-            /*!
                 Constructs an axis object which is a child of \a parent.
             */
             QDateTimeAxis::QDateTimeAxis(QObject *parent) :
                 }
             }
+            /*!
+              Sets \a format string that is used when creating label for the axis out of the QDateTime object.
+              Check QDateTime documentation for information on how the string should be defined.
+              \sa formatString()
+            */
             void QDateTimeAxis::setFormatString(QString format)
             {
                 Q_D(QDateTimeAxis);
                 d->m_format = format;
             }
+            /*!
+              Returns the format string that is used when creating label for the axis out of the QDateTime object.
+              Check QDateTime documentation for information on how the string should be defined.
+              \sa setFormatString()
+            */
             QString QDateTimeAxis::formatString() const
             {
                 Q_D(const QDateTimeAxis);

src/axis/intervalsaxis/qintervalsaxis.cpp +12 -3

             }
             /*!
-                Appends \a category to axis
+                Appends new interval to the axis with an \a intervalLabel.
+                Parameter \a interval specifies the high end limit of the interval.
             */
             void QIntervalsAxis::append(const QString& intervalLabel, qreal interval)
             {
                 }
             }
+            /*!
+                Sets to \a min the low end limit of the first interval on the axis.
+            */
             void QIntervalsAxis::setFisrtIntervalMinimum(qreal min)
             {
                 Q_D(QIntervalsAxis);
                 }else{
                     Range range = d->m_intervalsMap.value(d->m_intervals.first());
                     d->m_intervalsMap.insert(d->m_intervals.first(), Range(min, range.second));
-            //        setRange(min, d->m_min);
                 }
             }
+            /*!
+                Returns the low end limit of the interval specified by an \a intervalLabel
+            */
             qreal QIntervalsAxis::intervalMin(const QString& intervalLabel) const
             {
                 Q_D(const QIntervalsAxis);
                 return d->m_intervalsMap.value(intervalLabel).first;
             }
+            /*!
+                Returns the high end limit of the interval specified by an \a intervalLabel
+            */
             qreal QIntervalsAxis::intervalMax(const QString& intervalLabel) const
             {
                 Q_D(const QIntervalsAxis);
             }
             /*!
-                Removes \a category from axis
+                Removes \a interval from axis
             */
             void QIntervalsAxis::remove(const QString &intervalLabel)
             {

src/piechart/qpieseries.cpp +33 -2

@@ -151,6 +151,37 QTCOMMERCIALCHART_BEGIN_NAMESPACE
151	*/	151	*/
152		152
153	/*!	153	/*!
		154	\property QPieSeries::donutInnerSize
		155	\brief Defines the donut inner size.
		156
		157	The value is a relative value to the chart rectangle where:
		158
		159	\list
		160	\o 0.0 is the minimum size (pie not drawn).
		161	\o 1.0 is the maximum size that can fit the chart. (donut has no width)
		162	\endlist
		163
		164	The value is never greater then size property.
		165	Default value is 0.5.
		166	*/
		167
		168	/*!
		169	\qmlproperty real PieSeries::donutInnerSize
		170
		171	Defines the donut inner size.
		172
		173	The value is a relative value to the chart rectangle where:
		174
		175	\list
		176	\o 0.0 is the minimum size (donut is a pie).
		177	\o 1.0 is the maximum size that can fit the chart. (donut has no width)
		178	\endlist
		179
		180	The value is never greater then size property.
		181	Default value is 0.5.
		182	*/
		183
		184	/*!
154	\property QPieSeries::startAngle	185	\property QPieSeries::startAngle
155	\brief Defines the starting angle of the pie.	186	\brief Defines the starting angle of the pie.
156		187
@@ -542,8 +573,8 void QPieSeries::setDonutInnerSize(qreal innerSize)
542		573
543	if (innerSize < 0.0)	574	if (innerSize < 0.0)
544	innerSize = 0.0;	575	innerSize = 0.0;
545	if (innerSize > ~~1.0~~)	576	if (innerSize > d->m_pieRelativeSize)
546	innerSize = ~~1.0~~;	577	innerSize = d->m_pieRelativeSize;
547		578
548	d->m_donutRelativeInnerSize = innerSize;	579	d->m_donutRelativeInnerSize = innerSize;
549	d->updateDerivativeData();	580	d->updateDerivativeData();

src/piechart/qpieseries.h +2 0

                 Q_PROPERTY(qreal endAngle READ pieEndAngle WRITE setPieEndAngle)
                 Q_PROPERTY(int count READ count NOTIFY countChanged)
                 Q_PROPERTY(qreal sum READ sum NOTIFY sumChanged)
+                Q_PROPERTY(qreal donutInnerSize READ donutInnerSize WRITE setDonutInnerSize)
+                Q_PROPERTY(bool donut READ donut WRITE setDonut)
             public:
                 explicit QPieSeries(QObject *parent = 0);

src/piechart/qpieslice.cpp +2 -1

              \value LabelOutside Label is outside the slice with an arm.
              \value LabelInside Label is centered inside the slice.
+             \value LabelInsideTangential Label is centered inside the slice and rotated to be parallel to the tangential of the slice's arc
+             \value LabelInsideNormal Label is centered inside the slice rotated to be parallel to the normal of the slice's arc.
              */
             /*!

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