HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r809:ca452bc5066a

Doc fixes for pie

Jani Honkonen -

r809:ca452bc5066a

parent child

Context file:

r809:ca452bc5066a

Collapse all files

src/piechart/qpieseries.cpp +39 -6

              /*!
-                 Adds a single slice to the series with give \a value and \a name.
+                 Appends a single slice to the series with give \a value and \a name.
                  Slice ownership is passed to the series.
              */
              QPieSlice* QPieSeries::append(qreal value, QString name)
                  return slice;
              }
-             void QPieSeries::insert(int i, QPieSlice* slice)
+             /*!
+                 Inserts a single \a slice to the series before the slice at \a index position.
+                 Slice ownership is passed to the series.
+             */
+             void QPieSeries::insert(int index, QPieSlice* slice)
              {
                  Q_D(QPieSeries);
-                 Q_ASSERT(i <= d->m_slices.count());
+                 Q_ASSERT(index <= d->m_slices.count());
                  slice->setParent(this);
-                 d->m_slices.insert(i, slice);
+                 d->m_slices.insert(index, slice);
                  d->updateDerivativeData();
              }
              /*!
-                 \fn void QPieSeries::clicked(QPieSlice* slice)
+                 \fn void QPieSeries::clicked(QPieSlice* slice, Qt::MouseButtons buttons)
-                 This signal is emitted when a \a slice has been clicked.
+                 This signal is emitted when a \a slice has been clicked with mouse \a buttons.
                  \sa QPieSlice::clicked()
              */
                  \sa QPieSlice::hoverLeave()
              */
+             /*!
+                 \fn void QPieSeries::added(QList<QPieSlice*> slices)
+                 This signal is emitted when \a slices has been added to the series.
+                 \sa append(), insert()
+             */
+             /*!
+                 \fn void QPieSeries::removed(QList<QPieSlice*> slices)
+                 This signal is emitted when \a slices has been removed from the series.
+                 \sa remove(), clear()
+             */
+             /*!
+                 \fn void QPieSeries::piePositionChanged()
+                 This signal is emitted when pie position has changed.
+                 \sa setPiePosition(), pieVerticalPosition(), pieHorizontalPosition()
+             */
+             /*!
+                 \fn void QPieSeries::pieSizeChanged()
+                 This signal is emitted when pie size has changed.
+                 \sa pieSize(), setPieSize()
+             */
              bool QPieSeries::setModel(QAbstractItemModel* model)
              {

src/piechart/qpieseries.h +1 -1

                  // slice setters
                  void append(QPieSlice* slice);
                  void append(QList<QPieSlice*> slices);
-                 void insert(int i, QPieSlice* slice);
+                 void insert(int index, QPieSlice* slice);
                  void replace(QList<QPieSlice*> slices);
                  void remove(QPieSlice* slice);
                  void clear();

src/piechart/qpieslice.cpp +7 -7

              /*!
                  Returns the pen used to draw this slice.
-                 \sa setSlicePen()
+                 \sa setPen()
              */
              QPen QPieSlice::pen() const
              {
              /*!
                  Returns the brush used to draw this slice.
-                 \sa setSliceBrush()
+                 \sa setBrush()
              */
              QBrush QPieSlice::brush() const
              {
              /*!
                  Returns the pen used to draw the label in this slice.
-                 \sa setLabelArmPen()
+                 \sa setLabelPen()
              */
              QPen QPieSlice::labelPen() const
              {
              }
              /*!
-                 \fn void QPieSlice::clicked()
+                 \fn void QPieSlice::clicked(Qt::MouseButtons buttons)
                  This signal is emitted when user has clicked the slice.
              /*!
                  Sets the \a pen used to draw this slice.
                  Note that applying a theme will override this.
-                 \sa slicePen()
+                 \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.
-                 \sa sliceBrush()
+                 \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.
-                 \sa labelArmPen()
+                 \sa labelPen()
              */
              void QPieSlice::setLabelPen(const QPen &pen)
              {

src/qseries.cpp +1 -1

                  The name of a series is shown in the legend for QXYSeries.
                  \sa QChart::setTitle()
-                 \sa QPieSlice::setName()
+                 \sa QPieSlice::setLabel()
                  \sa QBarSet::setName()
              */

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