HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r952:d52db4287d96

Pie doc updates

Jani Honkonen -

r952:d52db4287d96

parent child

Context file:

r952:d52db4287d96

Collapse all files

src/piechart/piesliceitem.cpp +2 -2

             void PieSliceItem::hoverEnterEvent(QGraphicsSceneHoverEvent* /*event*/)
             {
-                emit hoverEnter();
+                emit hoverEnter(); // TODO: refactor emit hover(somebooleanvalue)
             }
             void PieSliceItem::hoverLeaveEvent(QGraphicsSceneHoverEvent* /*event*/)
             {
-                emit hoverLeave();
+                emit hoverLeave(); // TODO: refactor emit hover(somebooleanvalue)
             }
             void PieSliceItem::mousePressEvent(QGraphicsSceneMouseEvent *event)

src/piechart/qpieseries.cpp +8 -4

                 \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 pie series defines a pie chart which consists of pie slices which are defined as 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 is determined by that relative value.
-                By default the pie is defined as a full pie but it can be a partial pie.
+                Pie size and position on the chart is controlled by using relative values which range from 0.0 to 1.0
+                These relate to the actual chart rectangle.
+                By default the pie is defined as a full pie but it can also be a partial pie.
                 This can be done by setting a starting angle and angle span to the series.
+                Full pie is 360 degrees where 0 is at 12 a'clock.
             */
             /*!
             /*!
                 Removes a single \a slice from the series and deletes the slice.
-                Do not reference this pointer after this call.
+                Do not reference the pointer after this call.
             */
             void QPieSeries::remove(QPieSlice* slice)
             {
             /*!
                 Returns the sum of all slice values in this series.
-                \sa QPieSlice::value(), QPieSlice::setValue()
+                \sa QPieSlice::value(), QPieSlice::setValue(), QPieSlice::percentage()
             */
             qreal QPieSeries::sum() const
             {

src/piechart/qpieslice.cpp +35 -19

                 \class QPieSlice
                 \brief Defines a slice in pie series.
-                Holds all the data of a single slice in a QPieSeries and provides the means
+                This object defines the properties of a single slice in a QPieSeries.
-                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
+                In addition to the obvious value and label properties the user can also control
-                providing signals for clicking and hover events.
+                the visual appearance of a slice. By modifying the visual appearance also means that
+                the user is overriding the default appearance set by the theme. Even if the theme is
+                changed users settings will persist.
+                To enable user interaction customization with the slices some basic signals
+                are provided about clicking and hovering.
             */
             /*!
                 \property QPieSlice::value
                 Value of the slice.
+                \sa percentage(), QPieSeries::sum()
             */
             /*!
                 Constructs an empty slice with a \a parent.
-                Note that QPieSeries takes ownership of the slice when it is set/added.
+                \sa QPieSeries::append(), QPieSeries::insert(), QPieSeries::replace()
-                \sa QPieSeries::replace(), QPieSeries::append()
             */
             QPieSlice::QPieSlice(QObject *parent)
                 :QObject(parent),
             /*!
                 Constructs an empty slice with given \a value, \a label and a \a parent.
-                Note that QPieSeries takes ownership of the slice when it is set/added.
+                \sa QPieSeries::append(), QPieSeries::insert(), QPieSeries::replace()
-                \sa QPieSeries::replace(), QPieSeries::append()
             */
             QPieSlice::QPieSlice(qreal value, QString label, QObject *parent)
                 :QObject(parent),
             /*!
                 Returns true if slice is exloded from the pie.
-                \sa setExploded(), setExplodeDistanceFactor()
+                \sa setExploded(), explodeDistanceFactor(), setExplodeDistanceFactor()
             */
             bool QPieSlice::isExploded() const
             {
                 Default value is 0.15.
-                \sa setExplodeDistanceFactor()
+                \sa setExplodeDistanceFactor(), isExploded(), setExploded()
             */
             qreal QPieSlice::explodeDistanceFactor() const
             {
             }
             /*!
-                Returns the percentage of this slice compared to all slices in the same series.
+                Returns the percentage of this slice compared to the sum of all slices in the same series.
                 The returned value ranges from 0 to 1.0.
                 Updated internally after the slice is added to the series.
+                \sa QPieSeries::sum()
             */
             qreal QPieSlice::percentage() const
             {
             }
             /*!
-                Sets this slice \a exploded.
+                Sets this slices \a exploded state.
-                \sa isExploded(), explodeDistanceFactor()
+                If the slice is exploded it is moved away from the pie center. The distance is defined by the explode distance factor.
+                \sa isExploded(), explodeDistanceFactor(), setExplodeDistanceFactor()
             */
             void QPieSlice::setExploded(bool exploded)
             {
                 Default value is 0.15
-                \sa explodeDistanceFactor()
+                \sa explodeDistanceFactor(), isExploded(), setExploded()
             */
             void QPieSlice::setExplodeDistanceFactor(qreal factor)
             {
             /*!
                 Sets the \a pen used to draw this slice.
-                Note that applying a theme will override this.
+                Overrides the pen set by the theme.
                 \sa pen()
             */
             void QPieSlice::setPen(const QPen &pen)
             /*!
                 Sets the \a brush used to draw this slice.
-                Note that applying a theme will override this.
+                Overrides the brush set by the theme.
                 \sa brush()
             */
             void QPieSlice::setBrush(const QBrush &brush)
             /*!
                 Sets the \a pen used to draw the label in this slice.
-                Note that applying a theme will override this.
+                Overrides the pen set by the theme.
                 \sa labelPen()
             */
             void QPieSlice::setLabelPen(const QPen &pen)
             /*!
                 Sets the \a font used to draw the label in this slice.
-                Note that applying a theme will override this.
+                Overrides the font set by the theme.
                 \sa labelFont()
             */
             void QPieSlice::setLabelFont(const QFont &font)

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