From 79ef1d214c47eb993b95c54b377f584acee11e2f Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 24 Jan 2017 16:15:31 +0100 Subject: Doc: Add missing QML type docs Task-number: QTBUG-57539 Change-Id: I14cc8349c56d3a3d538d124f339e7f3ce4dff544 Reviewed-by: Miikka Heikkinen --- src/charts/axis/datetimeaxis/qdatetimeaxis.cpp | 8 ++++++ src/charts/axis/qabstractaxis.cpp | 21 ++++++++++++--- src/charts/barchart/qbarset.cpp | 36 ++++++++++++++++++++++++++ src/charts/linechart/qlineseries.cpp | 5 ++++ src/charts/piechart/qvpiemodelmapper.cpp | 2 +- src/charts/scatterchart/qscatterseries.cpp | 6 +++++ src/charts/splinechart/qsplineseries.cpp | 5 ++++ 7 files changed, 78 insertions(+), 5 deletions(-) (limited to 'src/charts') diff --git a/src/charts/axis/datetimeaxis/qdatetimeaxis.cpp b/src/charts/axis/datetimeaxis/qdatetimeaxis.cpp index 03ffccb2..f01ed5fc 100644 --- a/src/charts/axis/datetimeaxis/qdatetimeaxis.cpp +++ b/src/charts/axis/datetimeaxis/qdatetimeaxis.cpp @@ -144,6 +144,14 @@ QT_CHARTS_BEGIN_NAMESPACE and \a max, changes. */ +/*! + \qmlmethod DateTimeAxis::rangeChanged(datetime min, datetime max) + This signal is emitted when the minimum or maximum value of the axis, specified by \a min + and \a max, changes. + + The corresponding signal handler is \c onRangeChanged(). +*/ + /*! \property QDateTimeAxis::tickCount \brief The number of tick marks on the axis. diff --git a/src/charts/axis/qabstractaxis.cpp b/src/charts/axis/qabstractaxis.cpp index a4065570..cad5e9b9 100644 --- a/src/charts/axis/qabstractaxis.cpp +++ b/src/charts/axis/qabstractaxis.cpp @@ -130,11 +130,12 @@ QT_CHARTS_BEGIN_NAMESPACE \property QAbstractAxis::minorGridVisible \brief The visibility of the minor grid lines. - Applies only to QValueAxis. + Applies only to axes that support minor grid lines. */ /*! \qmlproperty bool AbstractAxis::minorGridVisible - The visibility of the minor grid lines. Applies only to ValueAxis. + The visibility of the minor grid lines. Applies only to axes that support + minor grid lines. */ /*! @@ -155,7 +156,7 @@ QT_CHARTS_BEGIN_NAMESPACE \property QAbstractAxis::minorGridLinePen \brief The pen used to draw the minor grid line. - Applies only to QValueAxis. + Applies only to axes that support minor grid lines. */ /*! @@ -163,11 +164,23 @@ QT_CHARTS_BEGIN_NAMESPACE \brief The color of the grid line. */ +/*! + \qmlproperty color AbstractAxis::gridLineColor + The color of the grid line. +*/ + /*! \property QAbstractAxis::minorGridLineColor \brief The color of the minor grid line. - Applies only to QValueAxis. + Applies only to axes that support minor grid lines. +*/ + +/*! + \qmlproperty color AbstractAxis::minorGridLineColor + The color of the minor grid line. + + Applies only to axes that support minor grid lines. */ /*! diff --git a/src/charts/barchart/qbarset.cpp b/src/charts/barchart/qbarset.cpp index 7538bb50..4635ef9a 100644 --- a/src/charts/barchart/qbarset.cpp +++ b/src/charts/barchart/qbarset.cpp @@ -145,6 +145,15 @@ QT_CHARTS_BEGIN_NAMESPACE This signal is emitted when the user clicks the bar specified by \a index in a bar set. */ +/*! + \qmlmethod BarSet::clicked(int index) + + This signal is emitted when the user clicks the bar specified by \a index + in a bar set. + + The corresponding signal handler is \c onClicked. +*/ + /*! \fn void QBarSet::pressed(int index) @@ -152,6 +161,15 @@ QT_CHARTS_BEGIN_NAMESPACE and holds down the mouse button. */ +/*! + \qmlmethod BarSet::pressed(int index) + + This signal is emitted when the user clicks the bar specified by \a index in + a bar set and holds down the mouse button. + + The corresponding signal handler is \c onPressed. +*/ + /*! \fn void QBarSet::released(int index) @@ -159,12 +177,30 @@ QT_CHARTS_BEGIN_NAMESPACE \a index in a bar set. */ +/*! + \qmlmethod BarSet::released(int index) + + This signal is emitted when the user releases the mouse press on the bar + specified by \a index in a bar set. + + The corresponding signal handler is \c onReleased. +*/ + /*! \fn void QBarSet::doubleClicked(int index) This signal is emitted when the user double-clicks the bar specified by \a index in a bar set. */ +/*! + \qmlmethod BarSet::doubleClicked(int index) + + This signal is emitted when the user double-clicks the bar specified by + \a index in a bar set. + + The corresponding signal handler is \c onDoubleClicked. +*/ + /*! \fn void QBarSet::hovered(bool status, int index) diff --git a/src/charts/linechart/qlineseries.cpp b/src/charts/linechart/qlineseries.cpp index b055a896..f08dae17 100644 --- a/src/charts/linechart/qlineseries.cpp +++ b/src/charts/linechart/qlineseries.cpp @@ -74,6 +74,11 @@ QT_CHARTS_BEGIN_NAMESPACE \clearfloat */ +/*! + \qmlproperty int LineSeries::count + The number of data points in the series. +*/ + /*! \qmlproperty real LineSeries::width The width of the line. By default, the width is 2.0. diff --git a/src/charts/piechart/qvpiemodelmapper.cpp b/src/charts/piechart/qvpiemodelmapper.cpp index 9c0d8443..9f876c48 100644 --- a/src/charts/piechart/qvpiemodelmapper.cpp +++ b/src/charts/piechart/qvpiemodelmapper.cpp @@ -143,7 +143,7 @@ QT_CHARTS_BEGIN_NAMESPACE The minimum and default value is -1 (number limited by the number of rows in the model). */ /*! - \qmlproperty int VPieModelMapper::columnCount + \qmlproperty int VPieModelMapper::rowCount The number of rows of the model that are mapped as the data for a pie series. The default value is -1 (number limited by the number of rows in the model). */ diff --git a/src/charts/scatterchart/qscatterseries.cpp b/src/charts/scatterchart/qscatterseries.cpp index 52855ac5..c5a8a8ba 100644 --- a/src/charts/scatterchart/qscatterseries.cpp +++ b/src/charts/scatterchart/qscatterseries.cpp @@ -114,6 +114,12 @@ This is a convenience property for modifying the color of the pen. \sa QScatterSeries::pen() */ + +/*! + \qmlproperty int ScatterSeries::count + The number of data points in the series. +*/ + /*! \qmlproperty color ScatterSeries::borderColor The color used to draw the marker borders. diff --git a/src/charts/splinechart/qsplineseries.cpp b/src/charts/splinechart/qsplineseries.cpp index 3c3e167b..78103111 100644 --- a/src/charts/splinechart/qsplineseries.cpp +++ b/src/charts/splinechart/qsplineseries.cpp @@ -101,6 +101,11 @@ \sa Qt::PenCapStyle */ +/*! + \qmlproperty int SplineSeries::count + The number of data points in the series. +*/ + QT_CHARTS_BEGIN_NAMESPACE /*! -- cgit v1.2.3