HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r320:832b68ef6fc6

More documentation for pie

Jani Honkonen -

r320:832b68ef6fc6

parent child

Context file:

r320:832b68ef6fc6

Collapse all files

src/piechart/qpieseries.cpp +42 -13

             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
-                \enum QPieSeries::PiePosition
+                \class QPieSeries::ChangeSet
+                \brief Defines the changes in the series.
-                This enum describes pie position within its bounding rectangle
+                Contains the changes that have occurred in the series. Lists of added, changed and removed slices.
-                \value PiePositionMaximized
+                \sa QPieSeries::changed()
-                \value PiePositionTopLeft
-                \value PiePositionTopRight
-                \value PiePositionBottomLeft
-                \value PiePositionBottomRight
             */
             /*!
-                \class QPieSeries
+                \internal
-                \brief QtCommercial charts pie series API.
             */
             void QPieSeries::ChangeSet::appendAdded(QPieSlice* slice)
             {
                 if (!m_added.contains(slice))
                     m_added << slice;
             }
+            /*!
+                \internal
+            */
             void QPieSeries::ChangeSet::appendAdded(QList<QPieSlice*> slices)
             {
                 foreach (QPieSlice* s, slices)
                     appendAdded(s);
             }
+            /*!
+                \internal
+            */
             void QPieSeries::ChangeSet::appendChanged(QPieSlice* slice)
             {
                 if (!m_changed.contains(slice))
                     m_changed << slice;
             }
+            /*!
+                \internal
+            */
             void QPieSeries::ChangeSet::appendRemoved(QPieSlice* slice)
             {
                 if (!m_removed.contains(slice))
             }
             /*!
+                \enum QPieSeries::PiePosition
+                This enum describes pie position within its bounding rectangle
+                \value PiePositionMaximized
+                \value PiePositionTopLeft
+                \value PiePositionTopRight
+                \value PiePositionBottomLeft
+                \value PiePositionBottomRight
+            */
+            /*!
+                \class QPieSeries
+                \brief Pie series API for QtCommercial Charts
+                The pie series defines a pie chart which consists of pie slices which are QPieSlice objects.
+                The slices can have any values as the QPieSeries will calculate its relative value to the sum of all slices.
+                The actual slice size (span) is determined by that relative value.
+                By default the pie is defined as full but it can be a partial pie.
+                This can be done by setting a starting angle and angle span to the series.
+            */
+            /*!
                 Constructs a series object which is a child of \a parent.
             */
             QPieSeries::QPieSeries(QObject *parent) :
             }
             /*!
-                Returns the type of the series which is always QChartSeries::SeriesTypePie.
+                Returns QChartSeries::SeriesTypePie.
             */
             QChartSeries::QChartSeriesType QPieSeries::type() const
             {
             /*!
                 Removes a single \a slice from the series and deletes the slice.
                 Do not reference this pointer after this call.
             */
             void QPieSeries::remove(QPieSlice* slice)
             /*!
                 Sets the \a startAngle and \a angleSpan of this series.
-                \sa
+                Full pie is 360 degrees where 0 degrees is at 12 a'clock.
             */
             void QPieSeries::setSpan(qreal startAngle, qreal angleSpan)
             {

src/piechart/qpieslice.cpp +15 -1

             /*!
                 \class QPieSlice
-                \brief QtCommercial charts pie series API.
+                \brief Defines a slice a pie series.
+                Holds all the data of a single slice in a QPieSeries and provides the means
+                to modify slice data and customize the visual appearance of the slice.
+                It also provides the means to customize user interaction with the slice by
+                providing signals for clicking and hover events.
             */
             /*!
             /*!
                 Constructs an empty slice with a \a parent.
                 Note that QPieSeries takes ownership of the slice when it is set/added.
                 \sa QPieSeries::set(), QPieSeries::add()
             */
             QPieSlice::QPieSlice(QObject *parent)
             /*!
                 Returns the percentage of this slice compared to all slices in the same series.
                 Updated internally after the slice is added to the series.
             */
             qreal QPieSlice::percentage() const
             /*!
                 Returns the starting angle of this slice in the series it belongs to.
+                Full pie is 360 degrees where 0 degrees is at 12 a'clock.
                 Updated internally after the slice is added to the series.
             */
             qreal QPieSlice::angle() const
             /*!
                 Returns the angle span of this slice in the series it belongs to.
+                Full pie is 360 degrees where 0 degrees is at 12 a'clock.
                 Updated internally after the slice is added to the series.
             */
             qreal QPieSlice::angleSpan() const

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