HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r314:9957a05c8211

Add documentation to pie

Jani Honkonen -

r314:9957a05c8211

parent child

Context file:

r314:9957a05c8211

Collapse all files

src/piechart/qpieseries.cpp +197 -6

             #include "qpieseries.h"
             #include "qpieslice.h"
             #include "piepresenter.h"
             #include "pieslice.h"
             #include <QFontMetrics>
             #include <QDebug>
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
+            /*!
+                \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 QtCommercial charts pie series API.
+            */
             void QPieSeries::ChangeSet::appendAdded(QPieSlice* slice)
             {
                 if (!m_added.contains(slice))
                     m_added << slice;
             }
             void QPieSeries::ChangeSet::appendAdded(QList<QPieSlice*> slices)
             {
                 foreach (QPieSlice* s, slices)
                     appendAdded(s);
             }
             void QPieSeries::ChangeSet::appendChanged(QPieSlice* slice)
             {
                 if (!m_changed.contains(slice))
                     m_changed << slice;
             }
             void QPieSeries::ChangeSet::appendRemoved(QPieSlice* slice)
             {
                 if (!m_removed.contains(slice))
                     m_removed << slice;
             }
+            /*!
+                Returns a list of slices that have been added to the series.
+                \sa QPieSeries::changed()
+            */
             QList<QPieSlice*> QPieSeries::ChangeSet::added() const
             {
                 return m_added;
             }
+            /*!
+                Returns a list of slices that have been changed in the series.
+                \sa QPieSeries::changed()
+            */
             QList<QPieSlice*> QPieSeries::ChangeSet::changed() const
             {
                 return m_changed;
             }
+            /*!
+                Returns a list of slices that have been removed from the series.
+                \sa QPieSeries::changed()
+            */
             QList<QPieSlice*> QPieSeries::ChangeSet::removed() const
             {
                 return m_removed;
             }
+            /*!
+                Returns true if there are no added/changed or removed slices in the change set.
+            */
             bool QPieSeries::ChangeSet::isEmpty() const
             {
                 if (m_added.count() || m_changed.count() || m_removed.count())
                     return false;
                 return true;
             }
+            /*!
+                Constructs a series object which is a child of \a parent.
+            */
             QPieSeries::QPieSeries(QObject *parent) :
                 QChartSeries(parent),
                 m_sizeFactor(1.0),
                 m_position(PiePositionMaximized),
                 m_pieStartAngle(0),
-                m_pieSpan(360)
+                m_pieAngleSpan(360)
             {
             }
+            /*!
+                Destroys the object. Note that adding series to QChart transfers the ownership to the chart.
+            */
             QPieSeries::~QPieSeries()
             {
             }
+            /*!
+                Returns the type of the series which is always QChartSeries::SeriesTypePie.
+            */
+            QChartSeries::QChartSeriesType QPieSeries::type() const
+            {
+                return QChartSeries::SeriesTypePie;
+            }
+            /*!
+                Sets an array of values to the series.
+                TO BE REMOVED
+            */
             bool QPieSeries::setData(QList<qreal> data)
             {
                 // TODO: remove this function
                 QList<QPieSlice*> slices;
                 foreach (qreal value, data)
                     slices << new QPieSlice(value, QString::number(value));
                 set(slices);
                 return true;
             }
+            /*!
+                Sets an array of \a slices to the series.
+                Slice ownership is passed to the series.
+            */
             void QPieSeries::set(QList<QPieSlice*> slices)
             {
                 clear();
                 add(slices);
             }
+            /*!
+                Adds an array of slices to the series.
+                Slice ownership is passed to the series.
+            */
             void QPieSeries::add(QList<QPieSlice*> slices)
             {
                 ChangeSet changeSet;
                 foreach (QPieSlice* s, slices) {
                     s->setParent(this);
                     m_slices << s;
                     changeSet.appendAdded(s);
                 }
                 updateDerivativeData();
                 foreach (QPieSlice* s, slices) {
                     connect(s, SIGNAL(changed()), this, SLOT(sliceChanged()));
                     connect(s, SIGNAL(clicked()), this, SLOT(sliceClicked()));
                     connect(s, SIGNAL(hoverEnter()), this, SLOT(sliceHoverEnter()));
                     connect(s, SIGNAL(hoverLeave()), this, SLOT(sliceHoverLeave()));
                 }
                 emit changed(changeSet);
             }
+            /*!
+                Adds a single \a slice to the series.
+                Slice ownership is passed to the series.
+            */
             void QPieSeries::add(QPieSlice* slice)
             {
                 add(QList<QPieSlice*>() << slice);
             }
+            /*!
+                Adds a single slice to the series with give \a value and \a name.
+                Slice ownership is passed to the series.
+            */
             QPieSlice* QPieSeries::add(qreal value, QString name)
             {
                 QPieSlice* slice = new QPieSlice(value, name);
                 add(slice);
                 return slice;
             }
+            /*!
+                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)
             {
                 if (!m_slices.removeOne(slice)) {
                     Q_ASSERT(0); // TODO: how should this be reported?
                     return;
                 }
                 ChangeSet changeSet;
                 changeSet.appendRemoved(slice);
                 emit changed(changeSet);
                 delete slice;
                 slice = NULL;
                 updateDerivativeData();
             }
+            /*!
+                Clears all slices from the series.
+            */
             void QPieSeries::clear()
             {
                 if (m_slices.count() == 0)
                     return;
                 ChangeSet changeSet;
                 foreach (QPieSlice* s, m_slices) {
                     changeSet.appendRemoved(s);
                     m_slices.removeOne(s);
                     delete s;
                 }
                 emit changed(changeSet);
                 updateDerivativeData();
             }
+            /*!
+                Counts the number of the slices in this series.
+            */
+            int QPieSeries::count() const
+            {
+                return m_slices.count();
+            }
+            /*!
+                Returns a list of slices that belong to this series.
+            */
+            QList<QPieSlice*> QPieSeries::slices() const
+            {
+                return m_slices;
+            }
+            /*!
+                Sets the size \a factor of the pie. 1.0 is the default value.
+                Note that the pie will not grow beyond its absolute maximum size.
+                In practice its use is to make the pie appear smaller.
+                \sa sizeFactor()
+            */
             void QPieSeries::setSizeFactor(qreal factor)
             {
                 if (factor < 0.0)
                     return;
                 if (m_sizeFactor != factor) {
                     m_sizeFactor = factor;
                     emit sizeFactorChanged();
                 }
             }
+            /*!
+                Gets the size factor of the pie.
+                \sa setSizeFactor()
+            */
+            qreal QPieSeries::sizeFactor() const
+            {
+                return m_sizeFactor;
+            }
+            /*!
+                Sets the \a position of the pie within its bounding rectangle.
+                \sa PiePosition, position()
+            */
             void QPieSeries::setPosition(PiePosition position)
             {
                 if (m_position != position) {
                     m_position = position;
                     emit positionChanged();
                 }
             }
-            void QPieSeries::setSpan(qreal startAngle, qreal span)
+            /*!
+                Gets the position of the pie within its bounding rectangle.
+                \sa PiePosition, setPosition()
+            */
+            QPieSeries::PiePosition QPieSeries::position() const
+            {
+                return m_position;
+            }
+            /*!
+                Sets the \a startAngle and \a angleSpan of this series.
+                \sa
+            */
+            void QPieSeries::setSpan(qreal startAngle, qreal angleSpan)
             {
                 if (startAngle >= 0 && startAngle < 360 &&
-                    span > 0 && span <= 360) {
+                    angleSpan > 0 && angleSpan <= 360) {
                     m_pieStartAngle = startAngle;
-                    m_pieSpan = span;
+                    m_pieAngleSpan = angleSpan;
                     updateDerivativeData();
                 }
             }
+            /*!
+                Sets the all the slice labels \a visible or invisible.
+                \sa QPieSlice::isLabelVisible(), QPieSlice::setLabelVisible()
+            */
             void QPieSeries::setLabelsVisible(bool visible)
             {
                 foreach (QPieSlice* s, m_slices)
                     s->setLabelVisible(visible);
             }
+            /*!
+                Convenience method for exploding a slice when user clicks the pie.
+                \sa QPieSlice::isExploded(), QPieSlice::setExploded()
+            */
             void QPieSeries::enableClickExplodes(bool enable)
             {
                 if (enable)
                     connect(this, SIGNAL(clicked(QPieSlice*)), this, SLOT(toggleExploded(QPieSlice*)));
                 else
                     disconnect(this, SLOT(toggleExploded(QPieSlice*)));
             }
+            /*!
+                Convenience method for highlighting a slice when user hovers over the slice.
+                It changes the slice color to be lighter and shows the label of the slice.
+                \sa QPieSlice::isExploded(), QPieSlice::setExploded()
+            */
             void QPieSeries::enableHoverHighlight(bool enable)
             {
                 if (enable) {
                     connect(this, SIGNAL(hoverEnter(QPieSlice*)), this, SLOT(highlightOn(QPieSlice*)));
                     connect(this, SIGNAL(hoverLeave(QPieSlice*)), this, SLOT(highlightOff(QPieSlice*)));
                 } else {
                     disconnect(this, SLOT(hoverEnter(QPieSlice*)));
                     disconnect(this, SLOT(hoverLeave(QPieSlice*)));
                 }
             }
+            /*!
+                \fn void QPieSeries::changed(const QPieSeries::ChangeSet& changeSet)
+                This signal emitted when something has changed in the series.
+                The \a changeSet contains the details of which slices have been added, changed or removed.
+                \sa QPieSeries::ChangeSet, QPieSlice::changed()
+            */
+            /*!
+                \fn void QPieSeries::clicked(QPieSlice* slice)
+                This signal is emitted when a \a slice has been clicked.
+                \sa QPieSlice::clicked()
+            */
+            /*!
+                \fn void QPieSeries::hoverEnter(QPieSlice* slice)
+                This signal is emitted when user has hovered over a \a slice.
+                \sa QPieSlice::hoverEnter()
+            */
+            /*!
+                \fn void QPieSeries::hoverLeave(QPieSlice* slice)
+                This signal is emitted when user has hovered away from a \a slice.
+                \sa QPieSlice::hoverLeave()
+            */
+            /*!
+                \fn void QPieSeries::sizeFactorChanged()
+                This signal is emitted when size factor has been changed.
+                \sa sizeFactor(), setSizeFactor()
+            */
+            /*!
+                \fn void QPieSeries::positionChanged()
+                This signal is emitted when position of the pie has been changed.
+                \sa position(), setPosition()
+            */
             void QPieSeries::sliceChanged()
             {
                 QPieSlice* slice = qobject_cast<QPieSlice *>(sender());
                 Q_ASSERT(m_slices.contains(slice));
                 ChangeSet changeSet;
                 changeSet.appendChanged(slice);
                 emit changed(changeSet);
                 updateDerivativeData();
             }
             void QPieSeries::sliceClicked()
             {
                 QPieSlice* slice = qobject_cast<QPieSlice *>(sender());
                 Q_ASSERT(m_slices.contains(slice));
                 emit clicked(slice);
             }
             void QPieSeries::sliceHoverEnter()
             {
                 QPieSlice* slice = qobject_cast<QPieSlice *>(sender());
                 Q_ASSERT(m_slices.contains(slice));
                 emit hoverEnter(slice);
             }
             void QPieSeries::sliceHoverLeave()
             {
                 QPieSlice* slice = qobject_cast<QPieSlice *>(sender());
                 Q_ASSERT(m_slices.contains(slice));
                 emit hoverLeave(slice);
             }
             void QPieSeries::toggleExploded(QPieSlice* slice)
             {
                 Q_ASSERT(slice);
                 slice->setExploded(!slice->isExploded());
             }
             void QPieSeries::highlightOn(QPieSlice* slice)
             {
                 Q_ASSERT(slice);
                 QColor c = slice->brush().color().lighter();
                 slice->setBrush(c);
                 slice->setLabelVisible(true);
             }
             void QPieSeries::highlightOff(QPieSlice* slice)
             {
                 Q_ASSERT(slice);
                 QColor c = slice->brush().color().darker(150);
                 slice->setBrush(c);
                 slice->setLabelVisible(false);
             }
             void QPieSeries::updateDerivativeData()
             {
                 m_total = 0;
                 // nothing to do?
                 if (m_slices.count() == 0)
                     return;
                 // calculate total
                 foreach (QPieSlice* s, m_slices)
                     m_total += s->value();
                 // we must have some values
                 Q_ASSERT(m_total > 0); // TODO: is this the correct way to handle this?
                 // update slice attributes
                 qreal sliceAngle = m_pieStartAngle;
                 foreach (QPieSlice* s, m_slices) {
                     bool changed = false;
                     qreal percentage = s->value() / m_total;
                     if (s->m_percentage != percentage) {
                         s->m_percentage = percentage;
                         changed = true;
                     }
-                    qreal sliceSpan = m_pieSpan * percentage;
+                    qreal sliceSpan = m_pieAngleSpan * percentage;
                     if (s->m_angleSpan != sliceSpan) {
                         s->m_angleSpan = sliceSpan;
                         changed = true;
                     }
                     if (s->m_angle != sliceAngle) {
                         s->m_angle = sliceAngle;
                         changed = true;
                     }
                     sliceAngle += sliceSpan;
                     if (changed)
                         emit s->changed();
                 }
             }
             #include "moc_qpieseries.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/piechart/qpieseries.h +9 -7

             #ifndef PIESERIES_H
             #define PIESERIES_H
             #include "qchartseries.h"
             #include <QObject>
             #include <QRectF>
             #include <QColor>
             #include <QPen>
             #include <QBrush>
             #include <QSignalMapper>
             class QGraphicsObject;
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             class PiePresenter;
             class PieSlice;
             class QPieSlice;
             class QTCOMMERCIALCHART_EXPORT QPieSeries : public QChartSeries
             {
                 Q_OBJECT
             public:
                 enum PiePosition {
                     PiePositionMaximized = 0,
                     PiePositionTopLeft,
                     PiePositionTopRight,
                     PiePositionBottomLeft,
                     PiePositionBottomRight
                 };
                 class ChangeSet
                 {
                 public:
+                    // TODO: these should not really be exposed to the public API
                     void appendAdded(QPieSlice* slice);
                     void appendAdded(QList<QPieSlice*> slices);
                     void appendChanged(QPieSlice* slice);
                     void appendRemoved(QPieSlice* slice);
                     QList<QPieSlice*> added() const;
                     QList<QPieSlice*> changed() const;
                     QList<QPieSlice*> removed() const;
                     bool isEmpty() const;
                 private:
                     QList<QPieSlice*> m_added;
                     QList<QPieSlice*> m_changed;
                     QList<QPieSlice*> m_removed;
                 };
             public:
                 QPieSeries(QObject *parent = 0);
                 virtual ~QPieSeries();
             public: // from QChartSeries
-                QChartSeriesType type() const { return QChartSeries::SeriesTypePie; }
+                QChartSeriesType type() const;
                 virtual bool setData(QList<qreal> data);  // TODO: remove this
             public:
                 void set(QList<QPieSlice*> slices);
                 void add(QList<QPieSlice*> slices);
                 void add(QPieSlice* slice);
                 QPieSlice* add(qreal value, QString name);
                 void remove(QPieSlice* slice);
                 void clear();
-                int count() const { return m_slices.count(); }
+                int count() const;
-                QList<QPieSlice*> slices() const { return m_slices; }
+                QList<QPieSlice*> slices() const;
                 void setSizeFactor(qreal sizeFactor);
-                qreal sizeFactor() const { return m_sizeFactor; }
+                qreal sizeFactor() const;
                 void setPosition(PiePosition position);
-                PiePosition position() const { return m_position; }
+                PiePosition position() const;
-                void setSpan(qreal startAngle, qreal span);
+                void setSpan(qreal startAngle, qreal angleSpan);
                 void setLabelsVisible(bool visible);
                 void enableClickExplodes(bool enable);
                 void enableHoverHighlight(bool enable);
                 // TODO: find slices?
                 // QList<QPieSlice*> findByValue(qreal value);
                 // ...
                 // TODO: sorting slices?
                 // void sort(QPieSeries::SortByValue|label|??)
                 // TODO: general graphics customization
                 // setDrawStyle(2d|3d)
                 // setDropShadows(bool)
             Q_SIGNALS:
                 void changed(const QPieSeries::ChangeSet& changeSet);
                 void clicked(QPieSlice* slice);
                 void hoverEnter(QPieSlice* slice);
                 void hoverLeave(QPieSlice* slice);
                 void sizeFactorChanged();
                 void positionChanged();
             private Q_SLOTS: // TODO: should be private and not visible in the interface at all
                 void sliceChanged();
                 void sliceClicked();
                 void sliceHoverEnter();
                 void sliceHoverLeave();
                 void toggleExploded(QPieSlice* slice);
                 void highlightOn(QPieSlice* slice);
                 void highlightOff(QPieSlice* slice);
             private:
                 void updateDerivativeData();
             private:
                 Q_DISABLE_COPY(QPieSeries)
                 // TODO: use PIML
                 friend class PiePresenter;
                 friend class PieSlice;
                 QList<QPieSlice*> m_slices;
                 qreal m_sizeFactor;
                 PiePosition m_position;
                 qreal m_total;
                 qreal m_pieStartAngle;
-                qreal m_pieSpan;
+                qreal m_pieAngleSpan;
             };
             QTCOMMERCIALCHART_END_NAMESPACE
             #endif // PIESERIES_H

src/piechart/qpieslice.cpp +176 -12

             #include "qpieslice.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             #define DEFAULT_PEN_COLOR         Qt::black
             #define DEFAULT_BRUSH_COLOR       Qt::white
-            #define DEFAULT_LABEL_ARM_LENGTH  50
+            #define DEFAULT_LABEL_ARM_LENGTH  40
             #define DEFAULT_EXPOLODE_DISTANCE 20
+            /*!
+                \class QPieSlice
+                \brief QtCommercial charts pie series API.
+            */
+            /*!
+                \property QPieSlice::label
+                Label of the slice.
+            */
+            /*!
+                \property QPieSlice::value
+                Value of the slice.
+            */
+            /*!
+                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)
                 :QObject(parent),
                 m_value(0),
                 m_isLabelVisible(false),
                 m_isExploded(false),
                 m_explodeDistance(DEFAULT_EXPOLODE_DISTANCE),
                 m_percentage(0),
                 m_angle(0),
                 m_angleSpan(0),
                 m_pen(DEFAULT_PEN_COLOR),
                 m_brush(DEFAULT_BRUSH_COLOR),
                 m_labelPen(DEFAULT_PEN_COLOR),
                 m_labelArmLength(DEFAULT_LABEL_ARM_LENGTH)
             {
             }
-            QPieSlice::QPieSlice(qreal value, QString label, bool labelVisible, 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::set(), QPieSeries::add()
+            */
+            QPieSlice::QPieSlice(qreal value, QString label, QObject *parent)
                 :QObject(parent),
                 m_value(value),
                 m_label(label),
-                m_isLabelVisible(labelVisible),
+                m_isLabelVisible(false),
                 m_isExploded(false),
                 m_explodeDistance(DEFAULT_EXPOLODE_DISTANCE),
                 m_percentage(0),
                 m_angle(0),
                 m_angleSpan(0),
                 m_pen(DEFAULT_PEN_COLOR),
                 m_brush(DEFAULT_BRUSH_COLOR),
                 m_labelPen(DEFAULT_PEN_COLOR),
                 m_labelArmLength(DEFAULT_LABEL_ARM_LENGTH)
             {
             }
+            /*!
+                Destroys the slice.
+                User should not delete the slice if it has been added to the series.
+            */
             QPieSlice::~QPieSlice()
             {
             }
+            /*!
+                Gets the value of the slice.
+                Note that all values in the series
+                \sa setValue()
+            */
             qreal QPieSlice::value() const
             {
                 return m_value;
             }
+            /*!
+                Gets the label of the slice.
+                \sa setLabel()
+            */
             QString QPieSlice::label() const
             {
                 return m_label;
             }
+            /*!
+                Returns true if label is set as visible.
+                \sa setLabelVisible()
+            */
             bool QPieSlice::isLabelVisible() const
             {
                 return m_isLabelVisible;
             }
+            /*!
+                Returns true if slice is exloded from the pie.
+                \sa setExploded()
+            */
             bool QPieSlice::isExploded() const
             {
                 return m_isExploded;
             }
+            /*!
+                Returns the explosion distance of the slice.
+                Default value is 20.
+                \sa setExplodeDistance()
+            */
             qreal QPieSlice::explodeDistance() const
             {
                 return m_explodeDistance;
             }
+            /*!
+                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
             {
                 return m_percentage;
             }
+            /*!
+                Returns the starting angle of this slice in the series it belongs to.
+                Updated internally after the slice is added to the series.
+            */
             qreal QPieSlice::angle() const
             {
                 return m_angle;
             }
+            /*!
+                Returns the angle span of this slice in the series it belongs to.
+                Updated internally after the slice is added to the series.
+            */
             qreal QPieSlice::angleSpan() const
             {
                 return m_angleSpan;
             }
+            /*!
+                Returns the pen used to draw this slice.
+                \sa setPen()
+            */
             QPen QPieSlice::pen() const
             {
                 return m_pen;
             }
+            /*!
+                Returns the brush used to draw this slice.
+                \sa setBrush()
+            */
             QBrush QPieSlice::brush() const
             {
                 return m_brush;
             }
+            /*!
+                Returns the pen used to draw label in this slice.
+                \sa setLabelPen()
+            */
             QPen QPieSlice::labelPen() const
             {
                 return m_labelPen;
             }
+            /*!
+                Returns the font used to draw label in this slice.
+                \sa setLabelFont()
+            */
             QFont QPieSlice::labelFont() const
             {
                 return m_labelFont;
             }
+            /*!
+                Returns the label arm lenght used in this slice.
+                Default value is 40 pixels.
+                \sa setLabelArmLength()
+            */
             qreal QPieSlice::labelArmLength() const
             {
                 return m_labelArmLength;
             }
+            /*!
+                \fn void QPieSlice::clicked()
+                This signal is emitted when user has clicked the slice.
+                \sa QPieSeries::clicked()
+            */
+            /*!
+                \fn void QPieSlice::hoverEnter()
+                This signal is emitted when user has hovered over the slice.
+                \sa QPieSeries::hoverEnter()
+            */
+            /*!
+                \fn void QPieSlice::hoverLeave()
+                This signal is emitted when user has hovered away from the slice.
+                \sa QPieSeries::hoverLeave()
+            */
+            /*!
+                \fn void QPieSlice::changed()
+                This signal emitted when something has changed in the slice.
+                \sa QPieSeries::changed()
+            */
+            /*!
+                Sets the value of this slice.
+                \sa value()
+            */
             void QPieSlice::setValue(qreal value)
             {
                 if (m_value != value) {
                     m_value = value;
                     emit changed();
                 }
             }
+            /*!
+                Sets the \a label of the slice.
+                \sa label()
+            */
             void QPieSlice::setLabel(QString label)
             {
                 if (m_label != label) {
                     m_label = label;
                     emit changed();
                 }
             }
+            /*!
+                Sets the label \a visible in this slice.
+                \sa isLabelVisible(), QPieSeries::setLabelsVisible()
+            */
             void QPieSlice::setLabelVisible(bool visible)
             {
                 if (m_isLabelVisible != visible) {
                     m_isLabelVisible = visible;
                     emit changed();
                 }
             }
+            /*!
+                Sets this slice \a exploded.
+                \sa isExploded(), setExplodeDistance(), QPieSeries::enableClickExplodes()
+            */
             void QPieSlice::setExploded(bool exploded)
             {
                 if (m_isExploded != exploded) {
                     m_isExploded = exploded;
                     emit changed();
                 }
             }
+            /*!
+                Sets the explosion \a distance of this slice.
+                It is the distance the slice is moved away from the pie center.
+                \sa explodeDistance(), isExploded(), QPieSeries::enableClickExplodes()
+            */
             void QPieSlice::setExplodeDistance(qreal distance)
             {
                 if (m_explodeDistance != distance) {
                     m_explodeDistance = distance;
                     emit changed();
                 }
             }
+            /*!
+                Sets the \a pen used to draw this slice.
+                Note that applying a theme will override this.
+                \sa pen()
+            */
             void QPieSlice::setPen(QPen pen)
             {
                 if (m_pen != pen) {
                     m_pen = pen;
                     emit changed();
                 }
             }
+            /*!
+                Sets the \a brush used to draw this slice.
+                Note that applying a theme will override this.
+                \sa brush()
+            */
             void QPieSlice::setBrush(QBrush brush)
             {
                 if (m_brush != brush) {
                     m_brush = brush;
                     emit changed();
                 }
             }
-            void QPieSlice::setLabelFont(QFont font)
+            /*!
+                Sets the \a pen used to draw the label in this slice.
+                Note that applying a theme will override this.
+                \sa labelPen()
+            */
+            void QPieSlice::setLabelPen(QPen pen)
             {
-                if (m_labelFont != font) {
+                if (m_labelPen != pen) {
-                    m_labelFont = font;
+                    m_labelPen = pen;
                     emit changed();
                 }
             }
-            void QPieSlice::setLabelPen(QPen pen)
+            /*!
+                Sets the \a font used to draw the label in this slice.
+                Note that applying a theme will override this.
+                \sa labelFont()
+            */
+            void QPieSlice::setLabelFont(QFont font)
             {
-                if (m_labelPen != pen) {
+                if (m_labelFont != font) {
-                    m_labelPen = pen;
+                    m_labelFont = font;
                     emit changed();
                 }
             }
-            void QPieSlice::setLabelArmLength(qreal len)
+            /*!
+                Sets the label arm \a length used to draw the label in this slice.
+                \sa labelArmLength()
+            */
+            void QPieSlice::setLabelArmLength(qreal length)
             {
-                if (m_labelArmLength != len) {
+                if (m_labelArmLength != length) {
-                    m_labelArmLength = len;
+                    m_labelArmLength = length;
                     emit changed();
                 }
             }
             #include "moc_qpieslice.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/piechart/qpieslice.h +3 -3

             #ifndef QPIESLICE_H
             #define QPIESLICE_H
             #include <qchartglobal.h>
             #include <QObject>
             #include <QPen>
             #include <QBrush>
             #include <QFont>
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             class QTCOMMERCIALCHART_EXPORT QPieSlice : public QObject
             {
                 Q_OBJECT
-                Q_PROPERTY(QString label READ label WRITE setLabel /*NOTIFY dataYChanged*/)
+                Q_PROPERTY(QString label READ label WRITE setLabel NOTIFY changed)
-                Q_PROPERTY(qreal value READ value WRITE setValue /*NOTIFY dataXChanged*/)
+                Q_PROPERTY(qreal value READ value WRITE setValue NOTIFY changed)
             public:
                 QPieSlice(QObject *parent = 0);
-                QPieSlice(qreal value, QString label, bool labelVisible = false, QObject *parent = 0);
+                QPieSlice(qreal value, QString label, QObject *parent = 0);
                 virtual ~QPieSlice();
                 // data
                 qreal value() const;
                 QString label() const;
                 bool isLabelVisible() const;
                 bool isExploded() const;
                 qreal explodeDistance() const;
                 // generated data
                 qreal percentage() const;
                 qreal angle() const;
                 qreal angleSpan() const;
                 // customization
                 QPen pen() const;
                 QBrush brush() const;
                 QPen labelPen() const;
                 QFont labelFont() const;
                 qreal labelArmLength() const;
             Q_SIGNALS:
                 void clicked();
                 void hoverEnter();
                 void hoverLeave();
                 void changed();
             public Q_SLOTS:
                 // data
                 void setLabel(QString label);
                 void setLabelVisible(bool visible);
                 void setValue(qreal value);
                 void setExploded(bool exploded);
                 void setExplodeDistance(qreal distance);
                 // customization
                 void setPen(QPen pen);
                 void setBrush(QBrush brush);
                 void setLabelFont(QFont font);
                 void setLabelPen(QPen pen);
                 void setLabelArmLength(qreal len);
                 // TODO: label position in general
                 // setLabelFlags(inside|outside|labelArmOn|labelArmOff|???)
                 // setLabelOrientation(horizontal|vertical|same as slice center angle|???)
             private:
                 // TODO: use private class
                 friend class QPieSeries;
                 friend class PiePresenter;
                 // data
                 qreal m_value;
                 QString m_label;
                 bool m_isLabelVisible;
                 bool m_isExploded;
                 qreal m_explodeDistance;
                 // generated data
                 qreal m_percentage;
                 qreal m_angle;
                 qreal m_angleSpan;
                 // customization
                 QPen m_pen;
                 QBrush m_brush;
                 QPen m_labelPen;
                 QFont m_labelFont;
                 qreal m_labelArmLength;
             };
             QTCOMMERCIALCHART_END_NAMESPACE
             #endif // QPIESLICE_H

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