HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r932:fa77b3cd02ea

Update pie docs

Jani Honkonen -

r932:fa77b3cd02ea

parent child

Context file:

r932:fa77b3cd02ea

Collapse all files

src/piechart/qpieseries.cpp +35 -84

              /*!
                  \property QPieSeries::horizontalPosition
-                 \brief Pie horizontal position property
+                 \brief Defines the horizontal position of the pie.
-                 By default horizontal position is 0.5 (center).
+                 The value is a relative value to the chart rectangle where:
+                 \list
+                 \o 0.0 is the absolute left.
+                 \o 1.0 is the absolute right.
+                 \endlist
+                 Default value is 0.5 (center).
              */
              /*!
                  \property QPieSeries::verticalPosition
-                 \brief Pie vertical position property
+                 \brief Defines the vertical position of the pie.
+                 The value is a relative value to the chart rectangle where:
+                 \list
+                 \o 0.0 is the absolute top.
+                 \o 1.0 is the absolute bottom.
+                 \endlist
-                 By default vertical position is 0.5 (center)
+                 Default value is 0.5 (center).
              */
              /*!
                  \property QPieSeries::size
-                 \brief Pie size property
+                 \brief Defines the pie size.
-                 By default size is 0.7.
+                 The value is a relative value to the chart rectangle where:
+                 \list
+                 \o 0.0 is the minumum size (pie not drawn).
+                 \o 1.0 is the maximum size that can fit the chart.
+                 \endlist
+                 Default value is 0.7.
              */
              /*!
                  \property QPieSeries::startAngle
-                 \brief Pie start angle.
+                 \brief Defines the starting angle of the pie.
-                 Starting angle of the pie. Default is 0.
-             */
+                 Full pie is 360 degrees where 0 degrees is at 12 a'clock.
+                 Default is value is 0.
+             */
              /*!
                  \property QPieSeries::endAngle
-                 \brief Pie end angle.
+                 \brief Defines the ending angle of the pie.
-                 Ending angle of the pie. Default is 360.
-             */
+                 Full pie is 360 degrees where 0 degrees is at 12 a'clock.
+                 Default is value is 360.
+             */
              /*!
                  return d->m_slices;
              }
-             /*!
-                 Sets the horizontal center position of the pie to \a relativePosition. If \a relativePosition is
-                 set to  0.0 the pie is drawn on the left side of the chart and if it's set to 1.0 the pie is
-                 drawn on right side of the chart. The default value 0.5 puts the pie in the middle.
-                 \sa setHorizontalPosition(), setPieSize()
-             */
              void QPieSeries::setHorizontalPosition(qreal relativePosition)
              {
                  Q_D(QPieSeries);
                      emit piePositionChanged();
              }
-             /*!
-                 Sets the vertical center position of the pie to \a relativePosition. If \a relativePosition is
-                 set to 0.0 the pie is drawn on the top of the chart and if it's set to 1.0 the pie is drawn
-                 on bottom of the chart. The default value 0.5 puts the pie in the middle.
-                 \sa verticalPosition(), setPieSize()
-             */
              void QPieSeries::setVerticalPosition(qreal relativePosition)
              {
                  Q_D(QPieSeries);
                      emit piePositionChanged();
              }
-             /*!
-                 Gets the horizontal position of the pie.
-                 The returned value is relative to the chart rectangle where:
-.0 means the absolute left.
-.0 means the absolute right.
-                 By default it is 0.5 which puts the pie in the horizontal middle of the chart rectangle.
-                 \sa verticalPosition(), setPieSize()
-             */
              qreal QPieSeries::horizontalPosition() const
              {
                  Q_D(const QPieSeries);
                  return d->m_pieRelativeHorPos;
              }
-             /*!
-                 Gets the vertical position position of the pie.
-                 The returned value is relative to the chart rectangle where:
-.0 means the absolute top.
-.0 means the absolute bottom.
-                 By default it is 0.5 which puts the pie in the vertical middle of the chart rectangle.
-                 \sa horizontalPosition(), setPieSize()
-             */
              qreal QPieSeries::verticalPosition() const
              {
                  Q_D(const QPieSeries);
                  return d->m_pieRelativeVerPos;
              }
-             /*!
-                 Sets the relative size of the pie.
-                 The \a relativeSize is defined so that the 1.0 is the maximum that can fit the given chart rectangle.
-                 Default value is 0.7.
-                 \sa pieSize(), verticalPosition(), horizontalPosition()
-             */
              void QPieSeries::setPieSize(qreal relativeSize)
              {
                  Q_D(QPieSeries);
                      emit pieSizeChanged();
              }
-             /*!
-                 Gets the relative size of the pie.
-                 The size is defined so that the 1.0 is the maximum that can fit the given chart rectangle.
-                 Default value is 0.7.
-                 \sa setPieSize(), setPiePosition(), pieVerticalPosition(), pieHorizontalPosition()
-             */
              qreal QPieSeries::pieSize() const
              {
                  Q_D(const QPieSeries);
              }
-             /*!
-                 Sets the end angle of the pie.
-                 Full pie is 360 degrees where 0 degrees is at 12 a'clock.
-                 \a angle must be less than pie end angle. Default value is 0.
-                 \sa pieStartAngle(), pieEndAngle(), setPieEndAngle()
-             */
              void QPieSeries::setPieStartAngle(qreal angle)
              {
                  Q_D(QPieSeries);
                      d->updateDerivativeData();
              }
-             /*!
-                 Gets the start angle of the pie.
-                 Full pie is 360 degrees where 0 degrees is at 12 a'clock. Default value is 360.
-                 \sa setPieStartAngle(), pieEndAngle(), setPieEndAngle()
-             */
              qreal QPieSeries::pieStartAngle() const
              {
                  Q_D(const QPieSeries);

src/piechart/qpieslice.cpp +6 0

              */
              /*!
+                 \fn void QPieSlice::selected()
+                 This signal emitted when this slice has been clicked in the legend.
+             */
+             /*!
                  Sets the \a value of this slice.
                  \sa value()
              */

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