summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src
diff options
context:
space:
mode:
authorTomi Korpipää <tomi.korpipaa@digia.com>2014-05-21 10:10:36 +0300
committerTomi Korpipää <tomi.korpipaa@digia.com>2014-05-21 10:12:29 +0300
commitfdae1424df750bd02913b9ceec1716b1187b2ae7 (patch)
tree7a7e6448b5b0daa4f42162be6403016341b8103b /src/datavisualization/doc/src
parent1fe989d12f8fe5c13675158044bb76551fb5eb0f (diff)
Added enablers for axis dragging to QML
Task-number: QTRD-3003 Will add an example in a separate commit Change-Id: I7fa9eb1b504d188c77b66ef8d4b2ee44416667e2 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc39
1 files changed, 27 insertions, 12 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
index a71bd28b..2af73021 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
@@ -201,55 +201,70 @@
/*!
* \qmlmethod int AbstractGraph3D::selectedLabelIndex()
*
- * Can be used to query the index of the selected label after receiving elementSelected signal with
- * any label type. Selection is valid until the next elementSelected signal.
+ * Can be used to query the index of the selected label after receiving \c selectedElementChanged
+ * signal with any label type. Selection is valid until the next \c selectedElementChanged signal.
*
* \return index of the selected label, or -1.
*
* \since Qt Data Visualization 1.1
+ *
+ * \sa selectedElement
*/
/*!
* \qmlmethod Abstract3DAxis AbstractGraph3D::selectedAxis()
*
- * Can be used to get the selected axis after receiving elementSelected signal with any label type.
- * Selection is valid until the next elementSelected signal.
+ * Can be used to get the selected axis after receiving \c selectedElementChanged signal with any label
+ * type. Selection is valid until the next \c selectedElementChanged signal.
*
* \return the selected axis, or null.
*
* \since Qt Data Visualization 1.1
+ *
+ * \sa selectedElement
*/
/*!
* \qmlmethod int AbstractGraph3D::selectedCustomItemIndex()
*
- * Can be used to query the index of the selected custom item after receiving elementSelected signal
- * with \l{QAbstract3DGraph::ElementCustomItem}{ElementCustomItem} type. Selection is valid until
- * the next elementSelected signal.
+ * Can be used to query the index of the selected custom item after receiving \c selectedElementChanged
+ * signal with \l{QAbstract3DGraph::ElementCustomItem}{ElementCustomItem} type. Selection is valid
+ * until the next \c selectedElementChanged signal.
*
* \return index of the selected custom item, or -1.
*
* \since Qt Data Visualization 1.1
+ *
+ * \sa selectedElement
*/
/*!
* \qmlmethod Custom3DItem AbstractGraph3D::selectedCustomItem()
*
- * Can be used to get the selected custom item after receiving elementSelected signal with
+ * Can be used to get the selected custom item after receiving \c selectedElementChanged signal with
* \l{QAbstract3DGraph::ElementCustomItem}{ElementCustomItem} type. Ownership of the item remains
- * with the graph. Selection is valid until the next elementSelected signal.
+ * with the graph. Selection is valid until the next \c selectedElementChanged signal.
*
* \return the selected custom item, or null.
*
* \since Qt Data Visualization 1.1
+ *
+ * \sa selectedElement
*/
-/*! \qmlsignal AbstractGraph3D::elementSelected(ElementType type)
+/*!
+ * \qmlproperty AbstractGraph3D.ElementType AbstractGraph3D::selectedElement
+ *
+ * Can be used to query the selected element type.
+ * Type is valid until the next \c selectedElementChanged signal.
+ *
+ * \c selectedElementChanged signal is emitted when a selection is made in the graph.
*
- * Emits selection \a type when a selection is made in the graph.
+ * Signal can be used for example for implementing customized input handling, as demonstrated in
+ * this \l {Qt Quick 2 Axis Dragging Example}{example}.
*
* \sa selectedLabelIndex(), selectedAxis(), selectedCustomItemIndex(), selectedCustomItem(),
- * Bars3D::selectedSeries, Scatter3D::selectedSeries, Surface3D::selectedSeries
+ * Bars3D::selectedSeries, Scatter3D::selectedSeries, Scene3D::selectionQueryPosition
*
* \since Qt Data Visualization 1.1
*/