summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorMichael Brasser <michael.brasser@nokia.com>2009-04-30 06:18:50 (GMT)
committerMichael Brasser <michael.brasser@nokia.com>2009-04-30 06:18:50 (GMT)
commita26c1cbe326f59162cd6549b8da479c4a7f198da (patch)
treeab6e2f999d19d7e07d5b4ad2fed48cd30c42063e /doc/src
parent488d2f6012c13291d2a8fe7907c332e2ab1b1b15 (diff)
downloadQt-a26c1cbe326f59162cd6549b8da479c4a7f198da.zip
Qt-a26c1cbe326f59162cd6549b8da479c4a7f198da.tar.gz
Qt-a26c1cbe326f59162cd6549b8da479c4a7f198da.tar.bz2
Documentation work.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/declarative/basictypes.qdoc210
-rw-r--r--doc/src/declarative/elements.qdoc4
-rw-r--r--doc/src/declarative/index.qdoc2
-rw-r--r--doc/src/declarative/qtprogrammers.qdoc2
-rw-r--r--doc/src/declarative/tutorial3.qdoc2
5 files changed, 49 insertions, 171 deletions
diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc
index a6b9177..0000c37 100644
--- a/doc/src/declarative/basictypes.qdoc
+++ b/doc/src/declarative/basictypes.qdoc
@@ -1,20 +1,16 @@
/*!
- \page basicxmltypes.html
+ \page basicqmltypes.html
\title Common QML 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.
- \target basicxmlint
+ \target basicqmlint
\raw HTML
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>int</td></tr>
+ <table>
+ <tr><td><div class="qmltype">int</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
ints are whole numbers - things like 0, 10 and -20. The possible int
@@ -30,25 +26,16 @@
<Item width="100" height="200" />
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlbool
+ \target basicqmlbool
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>bool</td></tr>
+ <table>
+ <tr><td><div class="qmltype">bool</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
bools are a binary true/false value, represented by the strings
- "true" and "false" in XML.
+ "true" and "false" in QML.
Setting bools looks like this:
\code
@@ -58,21 +45,12 @@
\note Technically bool treats an empty string, "false" and "0" as false and
everything else as true. Seriously, though, use "true" and "false".
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlreal
+ \target basicqmlreal
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>real</td></tr>
+ <table>
+ <tr><td><div class="qmltype">real</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
reals are numbers - either whole numbers like ints, or fractional numbers
@@ -85,21 +63,12 @@
\note In QML all reals are stored in single precision, \l {http://en.wikipedia.org/wiki/IEEE_754}{IEEE floating point} format.
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlstring
+ \target basicqmlstring
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>string</td></tr>
+ <table>
+ <tr><td><div class="qmltype">string</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
strings are free form text, like "hello world", "QML is cool" and
@@ -111,20 +80,14 @@
\endcode
\raw HTML
- </div>
- </div>
\endraw
- \target basicxmlcolor
+ \target basicqmlcolor
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>color</td></tr>
+ <table>
+ <tr><td><div class="qmltype">color</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
Colors are most commonly specified as an \l {http://www.w3.org/TR/SVG/types.html#ColorKeywords}{SVG color name}. These names include colors like
@@ -143,21 +106,12 @@
<Rect color="#800000FF" />
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlpoint
+ \target basicqmlpoint
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>point</td></tr>
+ <table>
+ <tr><td><div class="qmltype">point</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
Points are specified in \c "x,y" format.
@@ -167,21 +121,12 @@
<Widget pos="50,50"/>
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlsize
+ \target basicqmlsize
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>size</td></tr>
+ <table>
+ <tr><td><div class="qmltype">size</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
Sizes are specified in \c "widthxheight" format.
@@ -191,21 +136,12 @@
<Widget size="50x50"/>
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlrectangle
+ \target basicqmlrectangle
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>rectangle</td></tr>
+ <table>
+ <tr><td><div class="qmltype">rectangle</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
Rectangles are specified in \c "x,y,widthxheight" format.
@@ -215,21 +151,12 @@
<Widget geometry="50,50,100x100"/>
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmldate
+ \target basicqmldate
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>date</td></tr>
+ <table>
+ <tr><td><div class="qmltype">date</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
Dates are specified in \c "YYYY-MM-DD" format.
@@ -239,21 +166,12 @@
<DatePicker minDate="2000-01-01" maxDate="2020-12-31"/>
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmltime
+ \target basicqmltime
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>time</td></tr>
+ <table>
+ <tr><td><div class="qmltype">time</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
Times are specified in \c "hh:mm:ss" format.
@@ -263,21 +181,12 @@
<TimePicker time="14:22:15"/>
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlfont
+ \target basicqmlfont
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>font</td></tr>
+ <table>
+ <tr><td><div class="qmltype">font</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
The font type has components:
@@ -293,21 +202,12 @@
<Text font.family="Helvetica" font.size="13" font.bold="true">
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlaction
+ \target basicqmlaction
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>action</td></tr>
+ <table>
+ <tr><td><div class="qmltype">action</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
The action type has all the properties of QAction, in particular:
@@ -325,42 +225,24 @@
<Text text="{someitem.someaction.text}">
\endcode
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmlany
+ \target basicqmlany
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>any</td></tr>
+ <table>
+ <tr><td><div class="qmltype">any</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
The any type can accept any basic type, object or list. Generally this
is only used in very special cases. The documentation for elements that
use the any type will explain the constraints in that particular case.
- \raw HTML
- </div>
- </div>
- \endraw
-
- \target basicxmllist
+ \target basicqmllist
\raw HTML
<br>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr><td>Lists</td></tr>
+ <table>
+ <tr><td><div class="qmltype">Lists</div></td></tr>
</table>
- </div>
- <div class="memdoc">
\endraw
While not technically a basic type, QML also supports lists of object
@@ -380,8 +262,4 @@
\endcode
\c child1, \c child2 and \c child3 will all be added to the children list
in the order in which they appear.
- \raw HTML
- </div>
- </div>
- \endraw
*/
diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc
index 8955587..3e88e5a 100644
--- a/doc/src/declarative/elements.qdoc
+++ b/doc/src/declarative/elements.qdoc
@@ -7,7 +7,7 @@ The following table lists the Qml elements provided by the Qt Declarative module
\bold {Standard Qt Declarative Elements}
-\table
+\table 100%
\header
\o \bold {States}
\o \bold {Animation and Transitions}
@@ -51,7 +51,7 @@ The following table lists the Qml elements provided by the Qt Declarative module
\bold {Fluid UI Primitives}
-\table
+\table 100%
\header
\o \bold {Basic Items}
\o \bold {Utility}
diff --git a/doc/src/declarative/index.qdoc b/doc/src/declarative/index.qdoc
index 22195ba..b5e9001 100644
--- a/doc/src/declarative/index.qdoc
+++ b/doc/src/declarative/index.qdoc
@@ -13,7 +13,7 @@ user-interfaces.
Building fluid applications is done declaratively, rather than procedurally.
That is, you specify \e what the UI should look like and how it should behave
-in an XML-based format called QML instead of specifying step-by-step \e how to
+in an declarative format called QML instead of specifying step-by-step \e how to
build it in a language like C++ or JavaScript. Specifying a UI declaratively
does not just include the layout of the interface items, but also the way each
individual item looks and behaves and the overall flow of the application.
diff --git a/doc/src/declarative/qtprogrammers.qdoc b/doc/src/declarative/qtprogrammers.qdoc
index 92caa3f..b63ebbb 100644
--- a/doc/src/declarative/qtprogrammers.qdoc
+++ b/doc/src/declarative/qtprogrammers.qdoc
@@ -14,7 +14,7 @@ an application with a UI defined in QML also uses Qt for all the non-UI logic.
QML provides direct access to the following concepts from Qt:
\list
- \o QAction - the \l {basicxmlaction}{action} type
+ \o QAction - the \l {basicqmlaction}{action} type
\o QObject signals and slots - available as functions to call in JavaScript
\o QObject properties - available as variables in JavaScript
\o QWidget - QFxView is a QML-displaying widget
diff --git a/doc/src/declarative/tutorial3.qdoc b/doc/src/declarative/tutorial3.qdoc
index 91ab9f0..533e179 100644
--- a/doc/src/declarative/tutorial3.qdoc
+++ b/doc/src/declarative/tutorial3.qdoc
@@ -52,7 +52,7 @@ Here is the QML code:
</states>
\endcode
-First, we create a new state \e down for our text element. This state will be activated when \l {xmlMouseRegion}{MouseRegion} is pressed, and deactivated when it is released.
+First, we create a new state \e down for our text element. This state will be activated when MouseRegion is pressed, and deactivated when it is released.
The \e down state includes a set of property changes from our implicit \e {default state} (the items as they were initially defined in the QML). Specifically, we set the \c y property of the text to 160 and the \c color to red.