HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1531:658bb1d8ea02

QML signals documentation

Tero Ahola -

r1531:658bb1d8ea02

parent child

Context file:

r1531:658bb1d8ea02

Collapse all files

plugins/declarative/declarativechart.cpp +24 0

		@@ -185,6 +185,30 QTCOMMERCIALCHART_BEGIN_NAMESPACE
185	185	\sa Axis::min, Axis::max
186	186	*/
187	187
	188	/*!
	189	\qmlsignal ChartView::onTopMarginChanged(real margin)
	190	The top margin of the chart view has changed to \a margin. This may happen for example if you modify font size
	191	related properties of the legend or chart title.
	192	*/
	193
	194	/*!
	195	\qmlsignal ChartView::onBottomMarginChanged(real margin)
	196	The bottom margin of the chart view has changed to \a margin. This may happen for example if you modify font size
	197	related properties of the legend or chart title.
	198	*/
	199
	200	/*!
	201	\qmlsignal ChartView::onLeftMarginChanged(real margin)
	202	The left margin of the chart view has changed to \a margin. This may happen for example if you modify font size
	203	related properties of the legend or chart title.
	204	*/
	205
	206	/*!
	207	\qmlsignal ChartView::onRightMarginChanged(real margin)
	208	The right margin of the chart view has changed to \a margin. This may happen for example if you modify font size
	209	related properties of the legend or chart title.
	210	*/
	211
188	212	DeclarativeChart::DeclarativeChart(QDeclarativeItem *parent)
189	213	: QDeclarativeItem(parent),
190	214	m_chart(new QChart(this))

src/areachart/qareaseries.cpp +4 -4

                  \brief Signal is emitted when the fill (brush) color has changed to \a color.
              */
              /*!
-                 \qmlsignal AreaSeries::colorChanged(color color)
+                 \qmlsignal AreaSeries::onColorChanged(color color)
                  Signal is emitted when the fill (brush) color has changed to \a color.
              */
                  \brief Signal is emitted when the line (pen) color has changed to \a color.
              */
              /*!
-                 \qmlsignal AreaSeries::borderColorChanged(color color)
+                 \qmlsignal AreaSeries::onBorderColorChanged(color color)
                  Signal is emitted when the line (pen) color has changed to \a color.
              */
                  \brief Signal is emitted when user clicks the \a point on area chart.
              */
              /*!
-                 \qmlsignal AreaSeries::clicked(QPointF point)
+                 \qmlsignal AreaSeries::onClicked(QPointF point)
                  Signal is emitted when user clicks the \a point on area chart.
              */
                  implemented by the user of QAreaSeries API.
              */
              /*!
-                 \qmlsignal AreaSeries::selected()
+                 \qmlsignal AreaSeries::onSelected()
                  The signal is emitted if the user selects/deselects the XY series. The logic for maintaining selections should be
                  implemented by the user of AreaSeries API.
              */

src/axis/qaxis.cpp +15 0

                \fn void QAxis::minChanged(qreal min)
                Axis emits signal when \a min of axis has changed.
              */
+             /*!
+               \qmlsignal Axis::onMinChanged(real min)
+               Axis emits signal when \a min of axis has changed. This may happen for example if you zoom, scroll or
+               enable nice numbers algorithm.
+             */
              /*!
                \fn void QAxis::maxChanged(qreal max)
                Axis emits signal when \a max of axis has changed.
              */
+             /*!
+               \qmlsignal Axis::onMaxChanged(real max)
+               Axis emits signal when \a max of axis has changed. This may happen for example if you zoom, scroll or
+               enable nice numbers algorithm.
+             */
              /*!
                \fn void QAxis::rangeChanged(qreal min, qreal max)
                Axis emits signal when \a min or \a max of axis has changed.
              */
+             /*!
+               \qmlsignal Axis::onRangeChanged(real min, real max)
+               Axis emits signal when \a min or \a max of axis has changed. This may happen for example if you zoom, scroll or
+               enable nice numbers algorithm.
+             */
              /*!
                \fn QChartAxisCategories* QAxis::categories()

src/barchart/qbarseries.cpp +3 -5

              /*!
                  \fn void QBarSeries::clicked(QBarSet *barset, int index)
                  The signal is emitted if the user clicks with a mouse on top of QBarSet \a barset.
                  Clicked bar inside set is indexed by \a index
              */
              /*!
                  \qmlsignal BarSeries::onClicked(BarSet barset, int index)
                  The signal is emitted if the user clicks with a mouse on top of BarSet.
                  Clicked bar inside set is indexed by \a index
              */
                  This signal is emitted when barset count has been changed, for example by append or remove.
              */
              /*!
-                 \qmlsignal BarSeries::countChanged()
+                 \qmlsignal BarSeries::onCountChanged()
                  This signal is emitted when barset count has been changed, for example by append or remove.
              */
                  \sa append(), insert()
              */
              /*!
-                 \qmlsignal BarSeries::added(BarSet barset)
+                 \qmlsignal BarSeries::onAdded(BarSet barset)
                  Emitted when \a barset has been added to the series.
              */
                  \sa remove()
              */
              /*!
-                 \qmlsignal BarSeries::removed(BarSet barset)
+                 \qmlsignal BarSeries::onRemoved(BarSet barset)
                  Emitted when \a barset has been removed from the series.
              */

src/barchart/qbarset.cpp +4 0

                  This signal is emitted when the label of the barSet has changed.
                  \sa label
              */
+             /*!
+                 \qmlsignal BarSet::onLabelChanged()
+                 This signal is emitted when the label of the barSet has changed.
+             */
              /*!
                  \fn void QBarSet::penChanged()

src/piechart/qpieseries.cpp +20 -11

              /*!
                  \fn void QPieSeries::countChanged()
                  Emitted when the slice count has changed.
                  \sa count
              */
+             /*!
+                 \qmlsignal PieSeries::onCountChanged()
+                 Emitted when the slice count has changed.
+             */
              /*!
                  \property QPieSeries::sum
              /*!
                  \fn void QPieSeries::sumChanged()
                  Emitted when the sum of all slices has changed.
                  \sa sum
              */
+             /*!
+                 \qmlsignal PieSeries::onSumChanged()
+                 Emitted when the sum of all slices has changed. This may happen for example if you add or remove slices, or if you
+                 change value of a slice.
+             */
              /*!
                  \fn void QPieSeries::added(QList<QPieSlice*> slices)
                  \sa append(), insert()
              */
              /*!
-                 \qmlsignal PieSeries::added(PieSlice slice)
+                 \qmlsignal PieSeries::onAdded(PieSlice slice)
                  Emitted when \a slice has been added to the series.
              */
                  \sa remove()
              */
              /*!
-                 \qmlsignal PieSeries::removed(PieSlice slice)
+                 \qmlsignal PieSeries::onRemoved(PieSlice slice)
                  Emitted when \a slice has been removed from the series.
              */
              /*!
                  \fn void QPieSeries::clicked(QPieSlice* slice)
                  This signal is emitted when a \a slice has been clicked.
                  \sa QPieSlice::clicked()
              */
+             /*!
+               \qmlsignal PieSeries::onClicked(PieSlice slice)
+               This signal is emitted when a \a slice has been clicked.
+             */
              /*!
                  \fn void QPieSeries::hovered(QPieSlice* slice, bool state)
                  This signal is emitted when user has hovered over or away from the \a slice.
                  \a state is true when user has hovered over the slice and false when hover has moved away from the slice.
                  \sa QPieSlice::hovered()
              */
+             /*!
+                 \qmlsignal PieSeries::onHovered(PieSlice slice, bool state)
+                 This signal is emitted when user has hovered over or away from the \a slice. \a state is true when user has hovered
+                 over the slice and false when hover has moved away from the slice.
+             */
              /*!
                  \qmlmethod PieSlice PieSeries::at(int index)

src/piechart/qpieslice.cpp +10 -10

                  \sa label
              */
              /*!
-                 \qmlsignal PieSlice::labelChanged()
+                 \qmlsignal PieSlice::onLabelChanged()
                  This signal emitted when the slice label has been changed.
                  \sa label
              */
                  \sa value
              */
              /*!
-                 \qmlsignal PieSlice::valueChanged()
+                 \qmlsignal PieSlice::onValueChanged()
                  This signal is emitted when the slice value changes.
                  \sa value
              */
                  \sa labelVisible
              */
              /*!
-                 \qmlsignal PieSlice::labelVisibleChanged()
+                 \qmlsignal PieSlice::onLabelVisibleChanged()
                  This signal emitted when visibility of the slice label has changed.
                  \sa labelVisible
              */
                  \sa pen, borderColor
              */
              /*!
-                 \qmlsignal PieSlice::borderColorChanged()
+                 \qmlsignal PieSlice::onBorderColorChanged()
                  This signal is emitted when slice border color changes.
                  \sa borderColor
              */
                  \sa pen, borderWidth
              */
              /*!
-                 \qmlsignal PieSlice::borderWidthChanged()
+                 \qmlsignal PieSlice::onBorderWidthChanged()
                  This signal is emitted when slice border width changes.
                  \sa borderWidth
              */
                  \sa brush
              */
              /*!
-                 \qmlsignal PieSlice::colorChanged()
+                 \qmlsignal PieSlice::onColorChanged()
                  This signal is emitted when slice color changes.
              */
                  \sa labelColor
              */
              /*!
-                 \qmlsignal PieSlice::labelColorChanged()
+                 \qmlsignal PieSlice::onLabelColorChanged()
                  This signal is emitted when slice label color changes.
                  \sa labelColor
              */
                  \sa percentage
              */
              /*!
-                 \qmlsignal void PieSlice::percentageChanged()
+                 \qmlsignal void PieSlice::onPercentageChanged()
                  This signal is emitted when the percentage of the slice has changed.
                  \sa percentage
              */
                  \sa startAngle
              */
              /*!
-                 \qmlsignal PieSlice::startAngleChanged()
+                 \qmlsignal PieSlice::onStartAngleChanged()
                  This signal is emitted when the starting angle f the slice has changed.
                  \sa startAngle
              */
                  \sa angleSpan
              */
              /*!
-                 \qmlsignal PieSlice::angleSpanChanged()
+                 \qmlsignal PieSlice::onAngleSpanChanged()
                  This signal is emitted when the angle span of the slice has changed.
                  \sa angleSpan
              */

src/xychart/qxyseries.cpp +4 -4

                  \sa replace()
              */
              /*!
-                 \qmlsignal XYSeries::pointReplaced(int index)
+                 \qmlsignal XYSeries::onPointReplaced(int index)
                  Signal is emitted when a point has been replaced at \a index.
              */
                  \sa append(), insert()
              */
              /*!
-                 \qmlsignal XYSeries::pointAdded(int index)
+                 \qmlsignal XYSeries::onPointAdded(int index)
                  Signal is emitted when a point has been added at \a index.
              */
                  \sa remove()
              */
              /*!
-                 \qmlsignal XYSeries::pointRemoved(int index)
+                 \qmlsignal XYSeries::onPointRemoved(int index)
                  Signal is emitted when a point has been removed from \a index.
              */
                  \brief Signal is emitted when the line (pen) color has changed to \a color.
              */
              /*!
-                 \qmlsignal XYSeries::colorChanged(QColor color)
+                 \qmlsignal XYSeries::onColorChanged(color color)
                  Signal is emitted when the line (pen) color has changed to \a color.
              */

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