diff options
Diffstat (limited to 'src/datavisualization/data/qitemmodelsurfacedataproxy.cpp')
| -rw-r--r-- | src/datavisualization/data/qitemmodelsurfacedataproxy.cpp | 50 |
1 files changed, 28 insertions, 22 deletions
diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp index f15a8923..440ce2d6 100644 --- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * * 2) For models that do not have data already neatly sorted into rows and columns, such as * QAbstractListModel based models, you can define a role from the model to map for each of row, - * column and value. + * column and Y-position. * * 3) If you do not want to include all data contained in the model, or the autogenerated rows and * columns are not ordered as you wish, you can specify which rows and columns should be included @@ -89,7 +89,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION */ /*! - * \qmlproperty list ItemModelSurfaceDataProxy::itemModel + * \qmlproperty model ItemModelSurfaceDataProxy::itemModel * The item model. */ @@ -109,7 +109,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \qmlproperty string ItemModelSurfaceDataProxy::xPosRole - * The X position role of the mapping. + * The X position role of the mapping. If this role is not defined, columnRole is used to + * determine the X-coordinate value of resolved QSurfaceDataItems. */ /*! @@ -119,41 +120,42 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \qmlproperty string ItemModelSurfaceDataProxy::zPosRole - * The Z position role of the mapping. + * The Z position role of the mapping. If this role is not defined, rowRole is used to + * determine the Z-coordinate value of resolved QSurfaceDataItems. */ /*! - * \qmlproperty list ItemModelSurfaceDataProxy::rowCategories + * \qmlproperty list<String> ItemModelSurfaceDataProxy::rowCategories * The row categories of the mapping. Only items with row roles that are found in this list are * included when data is resolved. The rows are ordered in the same order as they are in this list. */ /*! - * \qmlproperty list ItemModelSurfaceDataProxy::columnCategories + * \qmlproperty list<String> ItemModelSurfaceDataProxy::columnCategories * The column categories of the mapping. Only items with column roles that are found in this list are * included when data is resolved. The columns are ordered in the same order as they are in this list. */ /*! - * \qmlproperty list ItemModelSurfaceDataProxy::useModelCategories + * \qmlproperty bool ItemModelSurfaceDataProxy::useModelCategories * When set to true, the mapping ignores row and column roles and categories, and uses - * the rows and columns from the model instead. Defaults to false. + * the rows and columns from the model instead. Defaults to \c{false}. */ /*! - * \qmlproperty list ItemModelSurfaceDataProxy::autoRowCategories + * \qmlproperty bool ItemModelSurfaceDataProxy::autoRowCategories * When set to true, the mapping ignores any explicitly set row categories * and overwrites them with automatically generated ones whenever the * data from model is resolved. Proxy minimum and maximum row values are also - * autogenerated from data when this is set to true. Defaults to true. + * autogenerated from data when this is set to true. Defaults to \c{true}. */ /*! - * \qmlproperty list ItemModelSurfaceDataProxy::autoColumnCategories + * \qmlproperty bool ItemModelSurfaceDataProxy::autoColumnCategories * When set to true, the mapping ignores any explicitly set column categories * and overwrites them with automatically generated ones whenever the * data from model is resolved. Proxy minimum and maximum column values are also - * autogenerated from data when this is set to true. Defaults to true. + * autogenerated from data when this is set to true. Defaults to \c{true}. */ /*! @@ -329,7 +331,7 @@ const QAbstractItemModel *QItemModelSurfaceDataProxy::itemModel() const /*! * \property QItemModelSurfaceDataProxy::rowRole * - * Defines the row role for the mapping. + * Defines the row \a role for the mapping. */ void QItemModelSurfaceDataProxy::setRowRole(const QString &role) { @@ -347,7 +349,7 @@ QString QItemModelSurfaceDataProxy::rowRole() const /*! * \property QItemModelSurfaceDataProxy::columnRole * - * Defines the column role for the mapping. + * Defines the column \a role for the mapping. */ void QItemModelSurfaceDataProxy::setColumnRole(const QString &role) { @@ -365,7 +367,9 @@ QString QItemModelSurfaceDataProxy::columnRole() const /*! * \property QItemModelSurfaceDataProxy::xPosRole * - * Defines the X position role for the mapping. + * Defines the X position \a role for the mapping. + * If this role is not defined, columnRole is used to determine the X-coordinate + * value of resolved QSurfaceDataItems. */ void QItemModelSurfaceDataProxy::setXPosRole(const QString &role) { @@ -383,7 +387,7 @@ QString QItemModelSurfaceDataProxy::xPosRole() const /*! * \property QItemModelSurfaceDataProxy::yPosRole * - * Defines the Y position role for the mapping. + * Defines the Y position \a role for the mapping. */ void QItemModelSurfaceDataProxy::setYPosRole(const QString &role) { @@ -401,7 +405,9 @@ QString QItemModelSurfaceDataProxy::yPosRole() const /*! * \property QItemModelSurfaceDataProxy::zPosRole * - * Defines the Z position role for the mapping. + * Defines the Z position \a role for the mapping. + * If this role is not defined, rowRole is used to determine the Z-coordinate + * value of resolved QSurfaceDataItems. */ void QItemModelSurfaceDataProxy::setZPosRole(const QString &role) { @@ -419,7 +425,7 @@ QString QItemModelSurfaceDataProxy::zPosRole() const /*! * \property QItemModelSurfaceDataProxy::rowCategories * - * Defines the row categories for the mapping. + * Defines the row \a categories for the mapping. */ void QItemModelSurfaceDataProxy::setRowCategories(const QStringList &categories) { @@ -437,7 +443,7 @@ QStringList QItemModelSurfaceDataProxy::rowCategories() const /*! * \property QItemModelSurfaceDataProxy::columnCategories * - * Defines the column categories for the mapping. + * Defines the column \a categories for the mapping. */ void QItemModelSurfaceDataProxy::setColumnCategories(const QStringList &categories) { @@ -456,7 +462,7 @@ QStringList QItemModelSurfaceDataProxy::columnCategories() const * \property QItemModelSurfaceDataProxy::useModelCategories * * When set to true, the mapping ignores row and column roles and categories, and uses - * the rows and columns from the model instead. Defaults to false. + * the rows and columns from the model instead. Defaults to \c{false}. */ void QItemModelSurfaceDataProxy::setUseModelCategories(bool enable) { @@ -476,7 +482,7 @@ bool QItemModelSurfaceDataProxy::useModelCategories() const * * When set to true, the mapping ignores any explicitly set row categories * and overwrites them with automatically generated ones whenever the - * data from model is resolved. Defaults to true. + * data from model is resolved. Defaults to \c{true}. */ void QItemModelSurfaceDataProxy::setAutoRowCategories(bool enable) { @@ -496,7 +502,7 @@ bool QItemModelSurfaceDataProxy::autoRowCategories() const * * When set to true, the mapping ignores any explicitly set column categories * and overwrites them with automatically generated ones whenever the - * data from model is resolved. Defaults to true. + * data from model is resolved. Defaults to \c{true}. */ void QItemModelSurfaceDataProxy::setAutoColumnCategories(bool enable) { |