summaryrefslogtreecommitdiffstats
path: root/doc/src/declarative
diff options
context:
space:
mode:
authorMartin Jones <martin.jones@nokia.com>2010-02-04 00:07:46 (GMT)
committerMartin Jones <martin.jones@nokia.com>2010-02-04 00:07:46 (GMT)
commite1c72879ed2c25819537bc5bbb12569b705ba79f (patch)
treea27f9d00b88cfbc186ab3fa81da4185f7da1ed6e /doc/src/declarative
parentefdcf95ded79ea5d745800ae86850e8c0605e9c8 (diff)
parent0a10f00d1ca93e30982b662e2d35841dab5d7bbb (diff)
downloadQt-e1c72879ed2c25819537bc5bbb12569b705ba79f.zip
Qt-e1c72879ed2c25819537bc5bbb12569b705ba79f.tar.gz
Qt-e1c72879ed2c25819537bc5bbb12569b705ba79f.tar.bz2
Merge branch 'kinetic-declarativeui' of git@scm.dev.nokia.troll.no:qt/kinetic into kinetic-declarativeui
Diffstat (limited to 'doc/src/declarative')
-rw-r--r--doc/src/declarative/basictypes.qdoc430
-rw-r--r--doc/src/declarative/extending.qdoc11
-rw-r--r--doc/src/declarative/qmlviewer.qdoc21
3 files changed, 289 insertions, 173 deletions
diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc
index 0551443..de5a959 100644
--- a/doc/src/declarative/basictypes.qdoc
+++ b/doc/src/declarative/basictypes.qdoc
@@ -40,218 +40,302 @@
****************************************************************************/
/*!
- \page basicqmltypes.html
- \title Common QML Types
+ \page qmlbasictypes.html
+ \title QML Basic Types
- QML uses a range of property types, which you will see
- referenced throughout the element documentation. Almost all of them are
- exactly what you would expect.
+ QML uses a set of property types, which are primitive within QML.
+ These basic types are referenced throughout the documentation of the
+ QML elements. Almost all of them are exactly what you would expect.
- \target basicqmlint
- \section1 int
+ \annotatedlist qmlbasictypes
+*/
+
+/*!
+ \qmlbasictype int
+ \ingroup qmlbasictypes
+
+ \brief An integer is a whole number, e.g. 0, 10, or -20.
+
+ An integer is a whole number, e.g. 0, 10, or -20. The possible \c
+ int values range from around -2000000000 to around 2000000000,
+ although most elements will only accept a reduced range (which they
+ mention in their documentation).
+
+ Example:
+ \qml
+ Item { width: 100; height: 200 }
+ \endqml
+*/
+
+/*!
+ \qmlbasictype bool
+ \ingroup qmlbasictypes
+
+ \brief A boolean is a binary true/false value.
+
+ A boolean is a binary true/false value.
+
+ Example:
+ \qml
+ Item { focus: true; clip: false }
+ \endqml
+
+*/
+
+/*!
+ \qmlbasictype real
+ \ingroup qmlbasictypes
+
+ \brief A real number has a decimal point, e.g. 1.2 or -29.8.
+
+ A real number has a decimal point, e.g. 1.2 or -29.8.
+
+ Example:
+ \qml
+ Item { width: 100.45; height: 150.82 }
+ \endqml
+
+ \note In QML all reals are stored in single precision, \l
+ {http://en.wikipedia.org/wiki/IEEE_754} {IEEE floating point}
+ format.
+
+*/
+
+/*!
+ \qmlbasictype string
+ \ingroup qmlbasictypes
+
+ \brief A string is a free form text in quotes, e.g. "Hello world!".
+
+ A string is a free form text in quotes, e.g. "Hello world!".
+
+ Example:
+ \qml
+ Text { text: "Hello world!" }
+ \endqml
+
+*/
+
+/*!
+ \qmlbasictype url
+ \ingroup qmlbasictypes
+
+ \brief A URL is a resource locator, like a file name.
+
+ A URL is a resource locator, like a file name. It can be either
+ absolute, e.g. "http://qtsoftware.com", or relative, e.g.
+ "pics/logo.png". A relative URL is resolved relative to the URL of
+ the component where the URL is converted from a JavaScript string
+ expression to a url property value.
+
+ Example:
+ \qml
+ Image { source: "pics/logo.png" }
+ \endqml
+
+ \raw HTML
+ \endraw
- An integer or \c int is a whole numbers like 0, 10 or -20. The possible \c int
- values range from around -2000000000 to around 2000000000, although most
- elements will only accept a reduced range (which they mention in their
- documentation).
+*/
+
+/*!
+ \qmlbasictype color
+ \ingroup qmlbasictypes
+
+ \brief A color is a standard color name in quotes.
+
+ A color is a standard color name in quotes. It is normally specified
+ as an \l {http://www.w3.org/TR/SVG/types.html#ColorKeywords} {SVG
+ color name}. These names include colors like "red", "green" and
+ "lightsteelblue".
- Example:
- \qml
- Item { width: 100; height: 200 }
- \endqml
+ If the color you want isn't part of this list, colors can also be
+ specified in hexidecimal triplets or quads that take the form \c
+ "#RRGGBB" and \c "#AARRGGBB" respectively. For example, the color
+ red corresponds to a triplet of \c "#FF0000" and a slightly
+ transparent blue to a quad of \c "#800000FF".
- \target basicqmlbool
- \section1 bool
+ Example:
+ \qml
+ Rectangle { color: "steelblue" }
+ Rectangle { color: "#FF0000" }
+ Rectangle { color: "#800000FF" }
+ \endqml
+
+*/
+
+/*!
+ \qmlbasictype point
+ \ingroup qmlbasictypes
- A boolean or \c bool is a binary true/false value.
+ \brief A point is specified as "x,y".
- Example:
- \qml
- Item { focus: true; clip: false }
- \endqml
+ A point is specified as "x,y".
- \target basicqmlreal
- \section1 real
+ Example:
+ \qml
+ Widget { pos: "0,20" }
+ \endqml
- A \c real is a number - either a whole number like an \c int, or a fractional number
- like 1.2 or -29.8.
+*/
- Example:
- \qml
- Item { width: 100.45; height: 150.82 }
- \endqml
+/*!
+ \qmlbasictype size
+ \ingroup qmlbasictypes
- \note In QML all reals are stored in single precision, \l {http://en.wikipedia.org/wiki/IEEE_754}{IEEE floating point} format.
+ \brief A size is specified as "width x height".
- \target basicqmlstring
- \section1 string
+ A size is specified as "width x height".
- A string is a free form text, like "Hello world!".
+ Example:
+ \qml
+ Widget { size: "150x50" }
+ \endqml
- Example:
- \qml
- Text { text: "Hello world!" }
- \endqml
+*/
- \target basicqmlurl
- \section1 url
+/*!
+ \qmlbasictype rect
+ \ingroup qmlbasictypes
- A URL is a resource locator, like a file name. It can be either absolute, like "http://qtsoftware.com",
- or relative, like "pics/logo.png". A relative URL is resolved relative to the URL of the component where
- the URL is converted from a JavaScript string expression to a url property value.
+ \brief A rect is specified as "x, y, width x height".
- Example:
- \qml
- Image { source: "pics/logo.png" }
- \endqml
+ A rect is specified as "x, y, width x height".
- \raw HTML
- \endraw
+ Example:
+ \qml
+ Widget { geometry: "50,50,100x100" }
+ \endqml
- \target basicqmlcolor
- \section1 color
+*/
- A \c color is most commonly specified as an \l {http://www.w3.org/TR/SVG/types.html#ColorKeywords}{SVG color name}. These names include colors like
- "red", "green" and "lightsteelblue".
+/*!
+ \qmlbasictype date
+ \ingroup qmlbasictypes
- If the color you want isn't part of this list, colors can also be specified
- in hexidecimal triplets or quads that take the form \c "#RRGGBB" and
- \c "#AARRGGBB" respectively. For example, the color red corresponds to a
- triplet of \c "#FF0000" and a slightly transparent blue to a quad of
- \c "#800000FF".
+ \brief A date is specified as "YYYY-MM-DD".
- Example:
- \qml
- Rectangle { color: "steelblue" }
- Rectangle { color: "#FF0000" }
- Rectangle { color: "#800000FF" }
- \endqml
+ A date is specified as "YYYY-MM-DD".
- \target basicqmlpoint
- \section1 point
+ Example:
+ \qml
+ DatePicker { minDate: "2000-01-01"; maxDate: "2020-12-31" }
+ \endqml
- A \c point is specified in \c "x,y" format.
-
- Example:
- \qml
- Widget { pos: "0,20" }
- \endqml
+*/
- \target basicqmlsize
- \section1 size
+/*!
+ \qmlbasictype time
+ \ingroup qmlbasictypes
- A \c size is specified in \c "widthxheight" format.
+ \brief A time is specified as "hh:mm:ss".
- Example:
- \qml
- Widget { size: "150x50" }
- \endqml
+ A time is specified as "hh:mm:ss".
- \target basicqmlrectangle
- \section1 rect
+ Example:
+ \qml
+ TimePicker { time: "14:22:15" }
+ \endqml
- A \c rect is specified in \c "x,y,widthxheight" format.
+ */
- Example:
- \qml
- Widget { geometry: "50,50,100x100" }
- \endqml
+/*!
+ \qmlbasictype font
+ \ingroup qmlbasictypes
- \target basicqmldate
- \section1 date
+ \brief A font type has the properties of a QFont.
- A \c date is specified in \c "YYYY-MM-DD" format.
+ A font type has the properties of a QFont. The properties are:
- Example:
- \qml
- DatePicker { minDate: "2000-01-01"; maxDate: "2020-12-31" }
- \endqml
+ \list
+ \o \c string font.family
+ \o \c bool font.bold
+ \o \c bool font.italic
+ \o \c bool font.underline
+ \o \c real font.pointSize
+ \o \c int font.pixelSize
+ \endlist
- \target basicqmltime
- \section1 time
+ Example:
+ \qml
+ Text { font.family: "Helvetica"; font.pointSize: 13; font.bold: true }
+ \endqml
+
+*/
+
+/*!
+ \qmlbasictype action
+ \ingroup qmlbasictypes
+
+ \brief The action type has all the properties of QAction.
+
+ The action type has all the properties of QAction. The properties
+ are:
+
+ \list
+ \o \c slot action.trigger - invoke the action
+ \o \c bool action.enabled - true if the action is enabled
+ \o \c string action.text - the text associated with the action
+ \endlist
+
+ Actions are used like this:
+
+ \qml
+ MouseRegion { onClicked: MyItem.myaction.trigger() }
+ State { name: "enabled"; when: MyItem.myaction.enabled == true }
+ Text { text: MyItem.someaction.text }
+ \endqml
+
+*/
+
+/*!
+ \qmlbasictype list
+ \ingroup qmlbasictypes
+
+ \brief A list of objects.
+
+ A list of objects. While not technically a basic type, QML also
+ supports lists of object types. When used from QML, the engine
+ automatically appends each value to the list.
+
+ For example, the \l Item class contains a list property named
+ children that can be used like this:
+
+ \qml
+ Item {
+ children: [
+ Item { id: child1 },
+ Rectangle { id: child2 },
+ Text { id: child3 }
+ ]
+ }
+ \endqml
+ \c Child1, \c Child2 and \c Child3 will all be added to the children list
+ in the order in which they appear.
+
+*/
+
+/*!
+ \qmlbasictype vector3d
+ \ingroup qmlbasictypes
- A \c time is specified in \c "hh:mm:ss" format.
+ \brief A vector3d is specified as "x,y,z".
- Example:
- \qml
- TimePicker { time: "14:22:15" }
- \endqml
+ A vector3d is specified as "x,y,z".
- \target basicqmlfont
- \section1 font
+ \qml
+ Rotation { angle: 60; axis: "0,1,0" }
+ \endqml
- The \c font type has the following properties of a QFont:
- \list
- \o \c string font.family
- \o \c bool font.bold
- \o \c bool font.italic
- \o \c bool font.underline
- \o \c real font.pointSize
- \o \c int font.pixelSize
- \endlist
-
- Example:
- \qml
- Text { font.family: "Helvetica"; font.pointSize: 13; font.bold: true }
- \endqml
-
- \target basicqmlaction
- \section1 action
-
- The action type has all the properties of QAction, in particular:
- \list
- \o \c slot action.trigger - invoke the action
- \o \c bool action.enabled - true if the action is enabled
- \o \c string action.text - the text associated with the action
- \endlist
+ or with the \c{Qt.vector3d()} helper function:
- Actions are used like this:
-
- \qml
- MouseRegion { onClicked: MyItem.myaction.trigger() }
- State { name: "enabled"; when: MyItem.myaction.enabled == true }
- Text { text: MyItem.someaction.text }
- \endqml
-
- \target basicqmllist
- \section1 list
-
- While not technically a basic type, QML also supports lists of object
- types. When used from QML, the engine automatically appends each value to the
- list.
+ \qml
+ Rotation { angle: 60; axis: Qt.vector3d(0, 1, 0) }
+ \endqml
- For example, the \l Item class has a children list property
- that can be used like this:
- \qml
- Item {
- children: [
- Item { id: child1 },
- Rectangle { id: child2 },
- Text { id: child3 }
- ]
- }
- \endqml
- \c Child1, \c Child2 and \c Child3 will all be added to the children list
- in the order in which they appear.
-
- \target basicqmlvector3d
- \section1 vector3d
+ or as separate \c x, \c y, and \c z components:
- A \c vector3d is specified in \c "x,y,z" format:
-
- \qml
- Rotation { angle: 60; axis: "0,1,0" }
- \endqml
-
- or with the \c{Qt.vector3d()} helper function:
-
- \qml
- Rotation { angle: 60; axis: Qt.vector3d(0, 1, 0) }
- \endqml
-
- or as separate \c x, \c y, and \c z components:
-
- \qml
- Rotation { angle: 60; axis.x: 0; axis.y: 1; axis.z: 0 }
- \endqml
+ \qml
+ Rotation { angle: 60; axis.x: 0; axis.y: 1; axis.z: 0 }
+ \endqml
*/
diff --git a/doc/src/declarative/extending.qdoc b/doc/src/declarative/extending.qdoc
index 42b054f..3b9c7f3 100644
--- a/doc/src/declarative/extending.qdoc
+++ b/doc/src/declarative/extending.qdoc
@@ -825,6 +825,17 @@ Here are three examples of signal declarations:
}
\endcode
+Adding a signal to an item automatically adds a signal handler to it.
+The signal hander is named on<Signal name>, with the first letter of the
+signal name being upper cased. The above example item would now have the
+following signal handlers:
+
+\list
+ \o onClicked
+ \o onHovered
+ \o onPerformAction
+\endlist
+
\section1 Adding new methods
New methods can be added to an existing type. These new methods are available
diff --git a/doc/src/declarative/qmlviewer.qdoc b/doc/src/declarative/qmlviewer.qdoc
index df96535..6a107ce 100644
--- a/doc/src/declarative/qmlviewer.qdoc
+++ b/doc/src/declarative/qmlviewer.qdoc
@@ -75,4 +75,25 @@
\endcode
Any QML can be used in the dummy data files. You could even animate the
fictional data!
+
+ \section1 Screen Orientation
+
+ A special piece of dummy data which is integrated into the viewer is
+ a simple orientation property. The orientation can be set via the
+ settings menu in the application, or by pressing Ctrl+T to toggle it.
+
+ To use this from within your QML file, import QmlViewer 1.0 and create a
+ Screen object. This object has a property, orientation, which can be either
+ Screen.Lanscape or Screen.Portrait and which can be bound to in your
+ application. An example is below:
+
+\code
+ import QmlViewer 1.0 as QmlViewer
+
+ Item {
+ QmlViewer.Screen { id: qmlviewerScreen }
+ state: (qmlviewerScreen.orientation == QmlViewer.Screen.Landscape) ? 'landscape' : ''
+ }
+\endcode
+
*/