From eca4f57c854874ec6e4f616e663b43675d76cff4 Mon Sep 17 00:00:00 2001 From: Miikka Heikkinen Date: Thu, 3 Oct 2013 10:41:45 +0300 Subject: Improve documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit +QML types now in their own group +Overview improved, though some linked pages are still just stubs +Some missing documentation added +Some needed tags added to qml type documentations +Removed license page +Fixed lisence footer Change-Id: Ic5e3d922cd5caf9f23294aea6f0e5d2ac493ae63 Reviewed-by: Tomi Korpipää --- src/datavisualization/axis/q3dabstractaxis.cpp | 6 ++- src/datavisualization/axis/q3dabstractaxis.h | 1 - src/datavisualization/axis/q3dcategoryaxis.cpp | 4 ++ src/datavisualization/axis/q3dcategoryaxis.h | 3 -- src/datavisualization/axis/q3dvalueaxis.cpp | 4 ++ src/datavisualization/axis/q3dvalueaxis.h | 1 - src/datavisualization/data/qabstractdataproxy.cpp | 9 +++- src/datavisualization/data/qbardataproxy.cpp | 14 ++++++- .../data/qheightmapsurfacedataproxy.cpp | 12 +++++- .../data/qitemmodelbardatamapping.cpp | 10 +++-- .../data/qitemmodelbardataproxy.cpp | 10 +++-- .../data/qitemmodelscatterdatamapping.cpp | 10 +++-- .../data/qitemmodelscatterdataproxy.cpp | 10 ++++- .../data/qitemmodelsurfacedatamapping.cpp | 10 +++-- .../data/qitemmodelsurfacedataproxy.cpp | 10 ++++- src/datavisualization/data/qscatterdataitem.cpp | 30 +++++++++++++ src/datavisualization/data/qscatterdataproxy.cpp | 14 ++++++- src/datavisualization/data/qsurfacedataitem.cpp | 30 +++++++++++++ src/datavisualization/data/qsurfacedataproxy.cpp | 16 ++++++- src/datavisualization/data/qsurfacedataproxy.h | 2 - .../doc/qtdatavisualization.qdocconf | 18 ++++++++ .../doc/src/qtdatavisualization-index.qdoc | 38 ++++++++++++++--- ...tdatavisualization-qml-abstractdeclarative.qdoc | 8 ++-- .../doc/src/qtdatavisualization-qml-bars3d.qdoc | 5 ++- .../src/qtdatavisualization-qml-colorgradient.qdoc | 8 ++++ .../doc/src/qtdatavisualization-qml-scatter3d.qdoc | 5 ++- .../doc/src/qtdatavisualization-qml-surface3d.qdoc | 5 ++- .../doc/src/qtdatavisualization.qdoc | 49 ++++++++++++++++++++++ .../doc/src/qtdatavisualizationlicense.qdoc | 37 ---------------- 29 files changed, 299 insertions(+), 80 deletions(-) delete mode 100644 src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc (limited to 'src') diff --git a/src/datavisualization/axis/q3dabstractaxis.cpp b/src/datavisualization/axis/q3dabstractaxis.cpp index 8e1e6a35..07761d0c 100644 --- a/src/datavisualization/axis/q3dabstractaxis.cpp +++ b/src/datavisualization/axis/q3dabstractaxis.cpp @@ -34,9 +34,13 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \qmltype AbstractAxis3D + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates Q3DAbstractAxis + * \brief AbstractAxis3D is base type for axes of a graph. * - * You should not need to use this type directly. + * This type is uncreatable, but contains properties that are exposed via subtypes. */ /*! diff --git a/src/datavisualization/axis/q3dabstractaxis.h b/src/datavisualization/axis/q3dabstractaxis.h index 31b7ab55..9e5c426a 100644 --- a/src/datavisualization/axis/q3dabstractaxis.h +++ b/src/datavisualization/axis/q3dabstractaxis.h @@ -73,7 +73,6 @@ public: qreal max() const; bool isAutoAdjustRange() const; -public slots: void setTitle(QString title); void setRange(qreal min, qreal max); void setMin(qreal min); diff --git a/src/datavisualization/axis/q3dcategoryaxis.cpp b/src/datavisualization/axis/q3dcategoryaxis.cpp index fec2442c..05f52cdc 100644 --- a/src/datavisualization/axis/q3dcategoryaxis.cpp +++ b/src/datavisualization/axis/q3dcategoryaxis.cpp @@ -38,8 +38,12 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \qmltype CategoryAxis3D + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates Q3DCategoryAxis * \inherits AbstractAxis3D + * \brief The CategoryAxis3D type is used for manipulating an axis of a graph. * * This type provides an axis that can be given labels. */ diff --git a/src/datavisualization/axis/q3dcategoryaxis.h b/src/datavisualization/axis/q3dcategoryaxis.h index 7376760b..ef545950 100644 --- a/src/datavisualization/axis/q3dcategoryaxis.h +++ b/src/datavisualization/axis/q3dcategoryaxis.h @@ -35,9 +35,6 @@ public: virtual ~Q3DCategoryAxis(); QStringList categoryLabels() const; - - -public slots: void setCategoryLabels(const QStringList &labels); protected: diff --git a/src/datavisualization/axis/q3dvalueaxis.cpp b/src/datavisualization/axis/q3dvalueaxis.cpp index a32a96e7..5e38e4ca 100644 --- a/src/datavisualization/axis/q3dvalueaxis.cpp +++ b/src/datavisualization/axis/q3dvalueaxis.cpp @@ -38,8 +38,12 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \qmltype ValueAxis3D + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates Q3DValueAxis * \inherits AbstractAxis3D + * \brief The ValueAxis3D type is used for manipulating an axis of a graph. * * This type provides an axis that can be given a range of values and segment and subsegment * counts to divide the range into. diff --git a/src/datavisualization/axis/q3dvalueaxis.h b/src/datavisualization/axis/q3dvalueaxis.h index 3e0a8cb1..f1280e25 100644 --- a/src/datavisualization/axis/q3dvalueaxis.h +++ b/src/datavisualization/axis/q3dvalueaxis.h @@ -40,7 +40,6 @@ public: int subSegmentCount() const; QString labelFormat() const; -public slots: void setSegmentCount(int count); void setSubSegmentCount(int count); void setLabelFormat(const QString &format); diff --git a/src/datavisualization/data/qabstractdataproxy.cpp b/src/datavisualization/data/qabstractdataproxy.cpp index 9267e93e..8ccb0d7a 100644 --- a/src/datavisualization/data/qabstractdataproxy.cpp +++ b/src/datavisualization/data/qabstractdataproxy.cpp @@ -28,12 +28,19 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \since 1.0.0 * * You use the visualization type specific inherited classes instead of the base class. - * \sa QBarDataProxy, QScatterDataProxy, QSurfaceDataProxy + * \sa QBarDataProxy, QScatterDataProxy, QSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype AbstractDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QAbstractDataProxy + * \brief Base type for all QtDataVisualization data proxies. + * + * This type is uncreatable, but contains properties that are exposed via subtypes. + * \sa BarDataProxy, ScatterDataProxy, SurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qbardataproxy.cpp b/src/datavisualization/data/qbardataproxy.cpp index f1f36638..2ec38980 100644 --- a/src/datavisualization/data/qbardataproxy.cpp +++ b/src/datavisualization/data/qbardataproxy.cpp @@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QBarDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DBars. + * \brief Base proxy class for Q3DBars. * \since 1.0.0 * * QBarDataProxy handles adding, inserting, changing and removing rows of data. @@ -68,14 +68,26 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * For example: * \snippet doc_src_qtdatavisualization.cpp 1 + * + * \sa {Qt Data Visualization Data Handling} */ /*! * \qmltype BarDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QBarDataProxy * \inherits AbstractDataProxy + * \brief Base proxy type for Bars3D. * * This type handles adding, inserting, changing and removing rows of data with Qt Quick 2. + * + * This type is uncreatable, but contains properties that are exposed via subtypes. + * + * For more complete description, see QBarDataProxy. + * + * \sa ItemModelBarDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp index 7c8f9fce..518e69eb 100644 --- a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp +++ b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp @@ -27,7 +27,7 @@ const float defaultMaxValue = 10.0f; /*! * \class QHeightMapSurfaceDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DSurface. + * \brief Base proxy class for Q3DSurface. * \since 1.0.0 * * QHeightMapSurfaceDataProxy takes care of surface related height map data handling. It provides a @@ -38,16 +38,24 @@ const float defaultMaxValue = 10.0f; * to image horizontal direction and Z-value to the vertical. Setting any of these * properties triggers asynchronous re-resolving of any existing height map. * - * \sa QSurfaceDataProxy + * \sa QSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype HeightMapSurfaceDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QHeightMapSurfaceDataProxy * \inherits SurfaceDataProxy + * \brief Base proxy type for Surface3D. * * HeightMapSurfaceDataProxy takes care of surface related height map data handling. It provides a * way for giving the surface plot a height map to be visualized. + * + * For more complete description, see QHeightMapSurfaceDataProxy. + * + * \sa {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelbardatamapping.cpp b/src/datavisualization/data/qitemmodelbardatamapping.cpp index 6a60ff1e..83d6c784 100644 --- a/src/datavisualization/data/qitemmodelbardatamapping.cpp +++ b/src/datavisualization/data/qitemmodelbardatamapping.cpp @@ -23,7 +23,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelBarDataMapping * \inmodule QtDataVisualization - * \brief Data model mapping for Q3DBars. + * \brief Item model mapping for Q3DBars. * \since 1.0.0 * * QItemModelBarDataMapping is used to map roles of QAbstractItemModel to rows, columns, and values @@ -50,12 +50,16 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qtdatavisualization.cpp 3 * - * \sa QItemModelBarDataProxy + * \sa QItemModelBarDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype BarDataMapping + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelBarDataMapping + * \brief Item model mapping for Bars3D. * * This type is used to map roles of AbstractItemModel to rows, columns, and values of Bars3D. For * more complete description, see QItemModelBarDataMapping. @@ -64,7 +68,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 4 * - * \sa ItemModelBarDataProxy + * \sa ItemModelBarDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelbardataproxy.cpp b/src/datavisualization/data/qitemmodelbardataproxy.cpp index 7c989aef..85fd8bf9 100644 --- a/src/datavisualization/data/qitemmodelbardataproxy.cpp +++ b/src/datavisualization/data/qitemmodelbardataproxy.cpp @@ -25,20 +25,24 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelBarDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DBars data model mapping. + * \brief Proxy class for presenting data in item models with Q3DBars. * \since 1.0.0 * * QItemModelBarDataProxy allows you to use QAbstractItemModel derived models as a data source * for Q3DBars. It uses QItemModelBarDataMapping instance to map data from the model to Q3DBars * graph. * - * \sa QItemModelBarDataMapping + * \sa QItemModelBarDataMapping, {Qt Data Visualization Data Handling} */ /*! * \qmltype ItemModelBarDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelBarDataProxy * \inherits BarDataProxy + * \brief Proxy class for presenting data in item models with Bars3D. * * This type allows you to use AbstractItemModel derived models as a data source for Bars3D. * @@ -46,7 +50,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 7 * - * \sa BarDataProxy, BarDataMapping + * \sa BarDataProxy, BarDataMapping, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp index 4b2be700..7ffd44f9 100644 --- a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp +++ b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp @@ -23,7 +23,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelScatterDataMapping * \inmodule QtDataVisualization - * \brief Data model mapping for Q3DScatter. + * \brief Item model mapping for Q3DScatter. * \since 1.0.0 * * QItemModelScatterDataMapping is used to map roles of QAbstractItemModel to the XYZ-values @@ -39,12 +39,16 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qtdatavisualization.cpp 4 * - * \sa QItemModelScatterDataProxy + * \sa QItemModelScatterDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype ScatterDataMapping + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelScatterDataMapping + * \brief Item model mapping for Scatter3D. * * This type is used to map roles of AbstractItemModel to the XYZ-values of Scatter3D points. For * more complete description, see QItemModelScatterDataMapping. @@ -53,7 +57,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 5 * - * \sa ItemModelScatterDataProxy + * \sa ItemModelScatterDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp index df94483a..7527f87e 100644 --- a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp +++ b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp @@ -25,17 +25,23 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelScatterDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DScatter data model mapping. + * \brief Proxy class for presenting data in item models with Q3DScatter. * \since 1.0.0 * * QItemModelScatterDataProxy allows you to use QAbstractItemModel derived models as a data source * for Q3DScatter. It maps roles defined in QItemModelScatterDataMapping to roles in the model. + * + * /sa {Qt Data Visualization Data Handling} */ /*! * \qmltype ItemModelScatterDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelScatterDataProxy * \inherits ScatterDataProxy + * \brief Proxy class for presenting data in item models with Scatter3D. * * This type allows you to use AbstractItemModel derived models as a data source for Scatter3D. * @@ -43,7 +49,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 8 * - * \sa ScatterDataProxy, ScatterDataMapping + * \sa ScatterDataProxy, ScatterDataMapping, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp index 27df0309..0b7c74c9 100644 --- a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp @@ -23,7 +23,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelSurfaceDataMapping * \inmodule QtDataVisualization - * \brief Data model mapping for Q3DSurface. + * \brief Item model mapping for Q3DSurface. * \since 1.0.0 * * QItemModelSurfaceDataMapping is used to map roles of QAbstractItemModel to rows, columns, and values @@ -51,12 +51,16 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qtdatavisualization.cpp 5 * - * \sa QItemModelSurfaceDataProxy + * \sa QItemModelSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype SurfaceDataMapping + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelSurfaceDataMapping + * \brief Item model mapping for Surface3D. * * This type is used to map roles of AbstractItemModel to rows, columns, and values of Surface3D. * For more complete description, see QItemModelSurfaceDataMapping. @@ -65,7 +69,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 6 * - * \sa ItemModelSurfaceDataProxy + * \sa ItemModelSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp index 77eb571a..22271c2e 100644 --- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp @@ -27,17 +27,23 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelSurfaceDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DSurface data model mapping. + * \brief Proxy class for presenting data in item models with Q3DSurface. * \since 1.0.0 * * QItemModelSurfaceDataProxy allows you to use QAbstractItemModel derived models as a data source * for Q3DSurface. It maps roles defined in QItemModelSurfaceDataMapping to roles in the model. + * + * /sa {Qt Data Visualization Data Handling} */ /*! * \qmltype ItemModelSurfaceDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelSurfaceDataProxy * \inherits SurfaceDataProxy + * \brief Proxy class for presenting data in item models with Surface3D. * * This type allows you to use AbstractItemModel derived models as a data source for Surface3D. * @@ -45,7 +51,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 9 * - * \sa SurfaceDataProxy, SurfaceDataMapping + * \sa SurfaceDataProxy, SurfaceDataMapping, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qscatterdataitem.cpp b/src/datavisualization/data/qscatterdataitem.cpp index 3de5bbd7..055a9dad 100644 --- a/src/datavisualization/data/qscatterdataitem.cpp +++ b/src/datavisualization/data/qscatterdataitem.cpp @@ -93,6 +93,36 @@ QScatterDataItem &QScatterDataItem::operator=(const QScatterDataItem &other) * \return position of this data item. */ +/*! + * \fn void QScatterDataItem::setX(float value) + * Sets the X component of the item position to the \a value. + */ + +/*! + * \fn void QScatterDataItem::setY(float value) + * Sets the Y component of the item position to the \a value. + */ + +/*! + * \fn void QScatterDataItem::setZ(float value) + * Sets the Z component of the item position to the \a value. + */ + +/*! + * \fn float QScatterDataItem::x() const + * \return the X component of the position of this data item. + */ + +/*! + * \fn float QScatterDataItem::y() const + * \return the Y component of the position of this data item. + */ + +/*! + * \fn float QScatterDataItem::z() const + * \return the Z component of the position of this data item. + */ + //void QScatterDataItem::setSize(qreal size) //{ // m_size = size; diff --git a/src/datavisualization/data/qscatterdataproxy.cpp b/src/datavisualization/data/qscatterdataproxy.cpp index 50328d1a..4d83da8d 100644 --- a/src/datavisualization/data/qscatterdataproxy.cpp +++ b/src/datavisualization/data/qscatterdataproxy.cpp @@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QScatterDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DScatter. + * \brief Base proxy class for Q3DScatter. * \since 1.0.0 * * QScatterDataProxy handles adding, inserting, changing and removing data items. @@ -52,14 +52,26 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * For example: * \snippet doc_src_qtdatavisualization.cpp 2 + * + * /sa {Qt Data Visualization Data Handling} */ /*! * \qmltype ScatterDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QScatterDataProxy * \inherits AbstractDataProxy + * \brief Base proxy class for Scatter3D. * * This type handles adding, inserting, changing and removing data items. + * + * This type is uncreatable, but contains properties that are exposed via subtypes. + * + * For more complete description, see QScatterDataProxy. + * + * \sa ItemModelScatterDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qsurfacedataitem.cpp b/src/datavisualization/data/qsurfacedataitem.cpp index 3fb21c95..19f8f347 100644 --- a/src/datavisualization/data/qsurfacedataitem.cpp +++ b/src/datavisualization/data/qsurfacedataitem.cpp @@ -93,6 +93,36 @@ QSurfaceDataItem &QSurfaceDataItem::operator=(const QSurfaceDataItem &other) * \return position of this data item. */ +/*! + * \fn void QSurfaceDataItem::setX(float value) + * Sets the X component of the item position to the \a value. + */ + +/*! + * \fn void QSurfaceDataItem::setY(float value) + * Sets the Y component of the item position to the \a value. + */ + +/*! + * \fn void QSurfaceDataItem::setZ(float value) + * Sets the Z component of the item position to the \a value. + */ + +/*! + * \fn float QSurfaceDataItem::x() const + * \return the X component of the position of this data item. + */ + +/*! + * \fn float QSurfaceDataItem::y() const + * \return the Y component of the position of this data item. + */ + +/*! + * \fn float QSurfaceDataItem::z() const + * \return the Z component of the position of this data item. + */ + /*! * \internal */ diff --git a/src/datavisualization/data/qsurfacedataproxy.cpp b/src/datavisualization/data/qsurfacedataproxy.cpp index f1351521..72f33de7 100644 --- a/src/datavisualization/data/qsurfacedataproxy.cpp +++ b/src/datavisualization/data/qsurfacedataproxy.cpp @@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QSurfaceDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DSurface. + * \brief Base proxy class for Q3DSurface. * \since 1.0.0 * * QSurfaceDataProxy takes care of surface related data handling. The QSurfaceDataProxy handles the data @@ -61,14 +61,26 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * see \l{Q3DValueAxis::setLabelFormat()} for more information. * \endtable * + * \sa {Qt Data Visualization Data Handling} */ /*! * \qmltype SurfaceDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QSurfaceDataProxy * \inherits AbstractDataProxy + * \brief Base proxy class for Surface3D. * - * DOCUMENTATION GOES HERE TOO + * This type handles surface data items. The data is arranged into rows and columns, and all rows must have + * the same number of columns. + * + * This type is uncreatable, but contains properties that are exposed via subtypes. + * + * For more complete description, see QSurfaceDataProxy. + * + * \sa ItemModelSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qsurfacedataproxy.h b/src/datavisualization/data/qsurfacedataproxy.h index 2aeda80e..460fa437 100644 --- a/src/datavisualization/data/qsurfacedataproxy.h +++ b/src/datavisualization/data/qsurfacedataproxy.h @@ -49,8 +49,6 @@ public: signals: void arrayReset(); - void valueRangeRowsChanged(int min, int max); - void valueRangeColumnsChanged(int min, int max); protected: explicit QSurfaceDataProxy(QSurfaceDataProxyPrivate *d, QObject *parent = 0); diff --git a/src/datavisualization/doc/qtdatavisualization.qdocconf b/src/datavisualization/doc/qtdatavisualization.qdocconf index 016fbe0c..e3189604 100644 --- a/src/datavisualization/doc/qtdatavisualization.qdocconf +++ b/src/datavisualization/doc/qtdatavisualization.qdocconf @@ -31,3 +31,21 @@ qhp.qtdatavisualization.subprojects.classes.title = C++ Classes qhp.qtdatavisualization.subprojects.classes.indexTitle = Qt Data Visualization C++ Classes qhp.qtdatavisualization.subprojects.classes.selectors = class fake:headerfile qhp.qtdatavisualization.subprojects.classes.sortPages = true + + +HTML.footer = \ + "
\n" \ + "

\n" \ + " © 2013 Digia. Qt and Qt logos are\n" \ + " trademarks of of Digia Corporation in Finland and/or other countries worldwide.\n" \ + "

\n" \ + " All other trademarks are property of their respective owners.\n" \ + "
\n" \ + "

\n" \ + " Licensees holding valid Qt Enterprise licenses may use this document in accordance\n" \ + " with the Qt Enterprise License Agreement provided with the Software or,\n" \ + " alternatively, in accordance with the terms contained in a written agreement\n" \ + " between you and Digia.\n" \ + "

\n" \ + "
\n" + diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc index 843df153..2a09dc68 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc @@ -22,28 +22,54 @@ \brief QtDataVisualization module provides functionality for 3D visualization. Qt Data Visualization module provides a way to visualize data in 3D. - It uses OpneGL for the data rendering. + + \section1 Features + + \list + \li Multiple data visualization options: 3D Bars, 3D Scatter, and 3D Surface + \li 2D slice views of the 3D data + \li Interactive data: Rotate, zoom, and highlight data using mouse or touch + \li Uses OpenGL for rendering the data + \li QML2 support + \li Customizable axes for data - control viewable data window with axis ranges + \li Customizable input handling (upcoming feature - not supported in technology preview) + \li Customizable scene handling - full control of cameras and lights (upcoming feature - + not supported in technology preview) + \li Customizable themes (upcoming feature - not supported in technology preview) + \endlist \section1 Getting Started - Qt Data Visualization provides classes for rendering 3D data. To include - the definitions of the module's classes, use the following directive: + To import Qt Data Visualization QML types, add the following import statement to your \c .qml + file: + + \snippet doc_src_qmldatavisualization.cpp 0 + + If you intend to use Qt Data Visualization C++ classes in your application, use the + following directive: \snippet doc_src_qtdatavisualization.cpp 0 - To link against the module, add this line to your qmake \c - .pro file: + \note If you are using a few classes from this module, we recommend including those specific + classes only instead of the whole module. + + To link against Qt Data Visualization module, add this line to your \c qmake project file: \snippet doc_src_qtdatavisualization.pro 0 + See \l{Qt Data Visualization Getting Started}{Getting started} page for further information + how to use Qt Data Visualization in your application. + \section1 Articles \list - \li \l{Qt Data Visualization License Information}{License Information} + \li \l{Qt Data Visualization Data Handling}{Data input} + \li \l{Qt Data Visualization Interacting with Data}{Interacting with visualized data} \endlist \section1 References \list \li \l{Qt Data Visualization C++ Classes} + \li \l{Qt Data Visualization QML Types} \endlist Qt Data Visualization comes with the following examples: diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index 300a31b6..7a0d2c4a 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -18,9 +18,12 @@ /*! \qmltype AbstractGraph3D - \inmodule QtDataVisualization + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief Base type for 3D visualizations. - This type is the base class for all 3D visualizations in Qt Quick 2. + This type is the base type for all 3D visualizations in QtDataVisualization. It resides in the data visualization module that can be imported like this: @@ -29,7 +32,6 @@ Note that this type is uncreatable, but contains properties that are shared between the 3D visualizations. - \sa Bars3D, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc index fac53960..f778cc92 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc @@ -19,7 +19,10 @@ /*! * \qmltype Bars3D * \inherits AbstractGraph3D - * \inmodule QtDataVisualization + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml + * \brief 3D bar graph. * * This type enables developers to render bar graphs in 3D with Qt Quick 2. * diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc index 98b29c87..f8edf492 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc @@ -18,6 +18,10 @@ /*! \qmltype ColorGradientStop + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief Defines the color at a position in ColorGradient. Defines the color at a position in a ColorGradient. @@ -46,6 +50,10 @@ /*! \qmltype ColorGradient + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief Defines a color gradient. A gradient is defined by two or more colors, which will be blended seamlessly. diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc index d78cc3a7..2839468e 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -19,7 +19,10 @@ /*! \qmltype Scatter3D \inherits AbstractGraph3D - \inmodule QtDataVisualization + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief 3D scatter graph. This type enables developers to render scatter graphs in 3D with Qt Quick 2. diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc index 31d05844..3669c1cd 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -19,7 +19,10 @@ /*! \qmltype Surface3D \inherits AbstractGraph3D - \inmodule QtDataVisualization + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief 3D surface graph. This type enables developers to render surface plots in 3D with Qt Quick 2. diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index 5ddd0720..c0e317d0 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -24,3 +24,52 @@ \brief The QtDataVisualization module provides functionality for 3D visualization. */ +/*! + \group datavisualization_qml + \title Qt Data Visualization QML Types + + \brief QML types for the Qt Data Visualization API. + + Qt Data Visualization functionality can be accessed via these QML types. + + \section1 QML Types +*/ + +/*! + \page qtdatavisualization_getting_started.html + \title Qt Data Visualization Getting Started + + \section1 Building Qt Data Visualization + + TODO + + \section1 Creating a simple application + + TODO +*/ + +/*! + \page qtdatavisualization_data_handling.html + \title Qt Data Visualization Data Handling + + \section1 Data proxies + + TODO + + \section1 Item models and data mapping + + TODO +*/ + +/*! + \page qtdatavisualization_interacting_with_data.html + \title Qt Data Visualization Interacting with Data + + \section1 View manipulation + + TODO + + \section1 Highlighting data + + TODO +*/ diff --git a/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc b/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc deleted file mode 100644 index 16c1ed70..00000000 --- a/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc +++ /dev/null @@ -1,37 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2013 Digia Plc -** All rights reserved. -** For any questions to Digia, please use contact form at http://qt.digia.com -** -** This file is part of the QtDataVisualization module. -** -** Licensees holding valid Qt Enterprise licenses may use this file in -** accordance with the Qt Enterprise License Agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. -** -** If you have questions regarding the use of this file, please use -** contact form at http://qt.digia.com -** -****************************************************************************/ - -/*! - \page qtdatavisualizationlicense.html - \title Qt Data Visualization License Information - \ingroup licensing - \brief License information for Qt Data Visualization - - \legalese - Copyright 2013 Digia. - - Qt and Qt logos are trademarks of of Digia Corporation in Finland and/or other countries - worldwide. - - All other trademarks are property of their respective owners. - - Licensees holding valid Qt Enterprise licenses may use this document in accordance with the - Qt Enterprise License Agreement provided with the Software or, alternatively, in accordance - with the terms contained in a written agreement between you and Digia. - \endlegalese -*/ -- cgit v1.2.3