diff options
author | Bea Lam <bea.lam@nokia.com> | 2010-06-03 01:39:21 (GMT) |
---|---|---|
committer | Bea Lam <bea.lam@nokia.com> | 2010-06-03 01:44:26 (GMT) |
commit | 551d4d2e022c7b86c62afbe10d29cb66d6240acb (patch) | |
tree | fd3459722aff428a363e21c7f47c3f59cb0c01ed /doc | |
parent | 8119f82f6bc835dbd5bdc7827f9f80e5cfccbd6a (diff) | |
download | Qt-551d4d2e022c7b86c62afbe10d29cb66d6240acb.zip Qt-551d4d2e022c7b86c62afbe10d29cb66d6240acb.tar.gz Qt-551d4d2e022c7b86c62afbe10d29cb66d6240acb.tar.bz2 |
Improve basic types documentation. Don't imply that Item has
properties like "geometry" and "position".
Task-number: QTBUG-11169
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/declarative/basictypes.qdoc | 74 |
1 files changed, 44 insertions, 30 deletions
diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc index 43ae214..5f9902e 100644 --- a/doc/src/declarative/basictypes.qdoc +++ b/doc/src/declarative/basictypes.qdoc @@ -185,46 +185,53 @@ \qmlbasictype point \ingroup qmlbasictypes - \brief A point is specified as "x,y". + \brief A point type has x and y attributes. - A point is specified as "x,y". + A \c point type has \c x and \c y attributes. + + To create a \c point value, specify it as a "x,y" string: - Example: \qml - MyItem { position: "0,20" } + CustomObject { myPointProperty: "0,20" } \endqml - Or with the \l{Qt::point()}{Qt.point()} function: + Or use the \l{Qt::point()}{Qt.point()} function: \qml - MyItem { position: Qt.point(0, 20) } + CustomObject { myPointProperty: Qt.point(0, 20) } \endqml - A point object has \c x and \c y attributes that contain the \c x and \c y values. - \sa {QML Basic Types} */ /*! \qmlbasictype size \ingroup qmlbasictypes + + \brief A size type has width and height attributes - \brief A size is specified as "width x height". + A \c size type has \c width and \c height attributes. - A size is specified as "width x height". + For example, to read the \l {Image::sourceSize} \c size property: - Example: \qml - LayoutItem { preferredSize: "150x50" } + Column { + Image { id: image; source: "logo.png" } + Text { text: image.sourceSize.width + "," + image.sourceSize.height } + } \endqml - Or with the \l{Qt::size()}{Qt.size()} function: + To create a \c size value, specify it as a "width x height" string: \qml - MyItem { position: Qt.size(150, 50) } + LayoutItem { preferredSize: "150x50" } \endqml - A size object has \c width and \c height attributes that contain the \c width and \c height values. + Or use the \l{Qt::size()}{Qt.size()} function: + + \qml + LayoutItem { preferredSize: Qt.size(150, 50) } + \endqml \sa {QML Basic Types} */ @@ -233,23 +240,31 @@ \qmlbasictype rect \ingroup qmlbasictypes - \brief A rect is specified as "x, y, width x height". + \brief A rect type has x, y, width and height attributes. - A rect is specified as "x, y, width x height". + A \c rect type has \c x, \c y, \c width and \c height attributes. - Example: + For example, to read the \l {Item::childrenRect.x}{Item::childrenRect} \c rect property: \qml - MyItem { geometry: "50,50,100x100" } + Rectangle { + width: childrenRect.width + height: childrenRect.height + + Rectangle { width: 100; height: 100 } + } \endqml - Or with the \l{Qt::rect()}{Qt.rect()} function: + To create a \c rect value, specify it as a "x, y, width x height" string: \qml - MyItem { position: Qt.rect(50, 50, 100, 100) } + CustomObject { myRectProperty: "50,50,100x100" } \endqml - A rect object has \c x, \c, y, \c width and \c height attributes that contain the - \c x, \c y, \c width and \c height values. + Or use the \l{Qt::rect()}{Qt.rect()} function: + + \qml + CustomObject { myRectProperty: Qt.rect(50, 50, 100, 100) } + \endqml \sa {QML Basic Types} */ @@ -260,7 +275,7 @@ \brief A date is specified as "YYYY-MM-DD". - A date is specified as "YYYY-MM-DD". + To create a \c date value, specify it as a "YYYY-MM-DD" string: Example: \qml @@ -375,15 +390,17 @@ \qmlbasictype vector3d \ingroup qmlbasictypes - \brief A vector3d is specified as "x,y,z". + \brief A vector3d type has x, y, and z attributes. - A vector3d is specified as "x,y,z". + A \c vector3d type has \c x, \c y, and \c z attributes. + + To create a \c vector3d value, specify it as a "x,y,z" string: \qml Rotation { angle: 60; axis: "0,1,0" } \endqml - or with the \c{Qt.vector3d()} function: + or with the \l{Qt::vector3d()}{Qt.vector3d()} function: \qml Rotation { angle: 60; axis: Qt.vector3d(0, 1, 0) } @@ -395,8 +412,5 @@ Rotation { angle: 60; axis.x: 0; axis.y: 1; axis.z: 0 } \endqml - A vector3d object has \c x, \c, y, and \c z attributes that contain the - \c x, \c y, \c z values. - \sa {QML Basic Types} */ |