diff options
author | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-11-25 09:46:24 +0200 |
---|---|---|
committer | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-11-25 12:39:56 +0200 |
commit | e7e01ec065d3874d28e9e28d213783c4275d8813 (patch) | |
tree | cae322801171a81362477d0a4156f451ae8cc450 /src/datavisualization/data/qscatter3dseries.cpp | |
parent | 8b55f6d7a7d8772553d7d2cc3647fb7465b9dc32 (diff) |
Fix documentation related to multiseries changes.
Also fixed some other miscellaneous issues.
Task-number: QTRD-2558
Change-Id: I2da3f7e64fbbbb287ddb7845cb0a15006dc4d6f5
Reviewed-by: Mika Salmela <mika.salmela@digia.com>
Diffstat (limited to 'src/datavisualization/data/qscatter3dseries.cpp')
-rw-r--r-- | src/datavisualization/data/qscatter3dseries.cpp | 32 |
1 files changed, 29 insertions, 3 deletions
diff --git a/src/datavisualization/data/qscatter3dseries.cpp b/src/datavisualization/data/qscatter3dseries.cpp index aff0f33c..4d9eb01a 100644 --- a/src/datavisualization/data/qscatter3dseries.cpp +++ b/src/datavisualization/data/qscatter3dseries.cpp @@ -30,9 +30,8 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * QScatter3DSeries manages the series specific visual elements, as well as series data * (via data proxy). * - * If no data proxy is set explicitly for the series, QScatter3DSeries creates a default - * proxy. If any other proxy is set as active data proxy later, the default proxy and all data - * added to it are destroyed. + * If no data proxy is set explicitly for the series, the series creates a default + * proxy. Setting another proxy will destroy the existing proxy and all data added to it. * * QScatter3DSeries supports the following format tags for QAbstract3DSeries::setItemLabelFormat(): * \table @@ -76,6 +75,30 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \sa {Qt Data Visualization Data Handling} */ +/*! + * \qmlproperty ScatterDataProxy Scatter3DSeries::dataProxy + * + * This property holds the active data \a proxy. The series assumes ownership of any proxy set to + * it and deletes any previously set proxy when a new one is added. The \a proxy cannot be null or + * set to another series. + */ + +/*! + * \qmlproperty int Scatter3DSeries::selectedItem + * + * Selects an item at the \a index. The \a index is the index in the data array of the series. + * Only one item can be selected at a time. + * To clear selection, set invalidSelectionIndex() as the \a index. + * If this series is added to a graph, the graph can adjust the selection according to user + * interaction or if it becomes invalid. Selecting an item on another added series will also + * clear the selection. + */ + +/*! + * \qmlmethod int Scatter3DSeries::invalidSelectionIndex() + * \return an invalid index for selection. Set this index to selectedItem property if you + * want to clear the selection. + */ /*! * Constructs QScatter3DSeries with the given \a parent. @@ -87,6 +110,9 @@ QScatter3DSeries::QScatter3DSeries(QObject *parent) : dptr()->setDataProxy(new QScatterDataProxy); } +/*! + * Constructs QScatter3DSeries with the given \a dataProxy and the \a parent. + */ QScatter3DSeries::QScatter3DSeries(QScatterDataProxy *dataProxy, QObject *parent) : QAbstract3DSeries(new QScatter3DSeriesPrivate(this), parent) { |