summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2010-08-09 11:57:14 (GMT)
committerJerome Pasion <jerome.pasion@nokia.com>2010-08-09 11:57:14 (GMT)
commit662f87ad52ea75229ce18b19983890425cc45298 (patch)
tree67b1764083e54f017e0d318c63c152af40307ad9 /doc
parenteea84818e98af917d3cf2bf04ea17a416ef9d55e (diff)
parent7829343dc9e12befd6c471cc72d00139bad5d42b (diff)
downloadQt-662f87ad52ea75229ce18b19983890425cc45298.zip
Qt-662f87ad52ea75229ce18b19983890425cc45298.tar.gz
Qt-662f87ad52ea75229ce18b19983890425cc45298.tar.bz2
Merge branch '4.7' of scm.dev.nokia.troll.no:qt/oslo-staging-1 into 4.7
Diffstat (limited to 'doc')
-rw-r--r--doc/src/declarative/example-slideswitch.qdoc2
-rw-r--r--doc/src/declarative/modules.qdoc8
-rw-r--r--doc/src/declarative/qdeclarativestates.qdoc95
-rw-r--r--doc/src/examples/qml-examples.qdoc2
-rw-r--r--doc/src/examples/simpletreemodel.qdoc16
-rw-r--r--doc/src/examples/spinboxdelegate.qdoc5
-rw-r--r--doc/src/index.qdoc11
-rw-r--r--doc/src/objectmodel/metaobjects.qdoc3
-rw-r--r--doc/src/objectmodel/properties.qdoc3
-rw-r--r--doc/src/overviews.qdoc1
-rw-r--r--doc/src/painting-and-printing/paintsystem.qdoc6
-rwxr-xr-xdoc/src/tutorials/modelview.qdoc4
-rw-r--r--doc/src/widgets-and-layouts/layout.qdoc4
-rw-r--r--doc/src/widgets-and-layouts/styles.qdoc2
-rw-r--r--doc/src/widgets-and-layouts/stylesheet.qdoc2
-rw-r--r--doc/src/widgets-and-layouts/widgets.qdoc3
-rw-r--r--doc/src/windows-and-dialogs/dialogs.qdoc13
17 files changed, 105 insertions, 75 deletions
diff --git a/doc/src/declarative/example-slideswitch.qdoc b/doc/src/declarative/example-slideswitch.qdoc
index f056892..1a40f14 100644
--- a/doc/src/declarative/example-slideswitch.qdoc
+++ b/doc/src/declarative/example-slideswitch.qdoc
@@ -115,7 +115,7 @@ For more information on scripts see \l{Integrating JavaScript}.
At this point, when the switch toggles between the two states the knob will instantly change its \c x position between 1 and 78.
In order for the the knob to move smoothly we add a transition that will animate the \c x property with an easing curve for a duration of 200ms.
-For more information on transitions see \l{state-transitions}{QML Transitions}.
+For more information on transitions see \l{qdeclarativeanimation.html#transitions}{QML Transitions}.
\section1 Usage
The switch can be used in a QML file, like this:
diff --git a/doc/src/declarative/modules.qdoc b/doc/src/declarative/modules.qdoc
index 9e51a40..467b7d0 100644
--- a/doc/src/declarative/modules.qdoc
+++ b/doc/src/declarative/modules.qdoc
@@ -302,5 +302,13 @@ For examples of \c qmldir files for plugins, see the
\l {declarative/cppextensions/plugins}{Plugins} example and
\l {Tutorial: Writing QML extensions with C++}.
+
+\section1 Debugging
+
+The \c QML_IMPORT_TRACE environment variable can be useful for debugging
+when there are problems with finding and loading modules. See
+\l{Debugging module imports} for more information.
+
+
*/
/
diff --git a/doc/src/declarative/qdeclarativestates.qdoc b/doc/src/declarative/qdeclarativestates.qdoc
index 0b91756..274040a 100644
--- a/doc/src/declarative/qdeclarativestates.qdoc
+++ b/doc/src/declarative/qdeclarativestates.qdoc
@@ -84,18 +84,34 @@ Rectangle.
\snippet doc/src/snippets/declarative/states.qml 0
-A \l State item defines all the changes to be made in the new state. You
+The \l State item defines all the changes to be made in the new state. It
could specify additional properties to be changed, or create additional
-PropertyChanges for other objects. (Note that a \l State can modify the
-properties of other objects, not just the object that owns the state.)
+PropertyChanges for other objects. It can also modify the properties of other
+objects, not just the object that owns the state. For example:
-For example:
+\qml
+Rectangle {
+ ...
+ states: [
+ State {
+ name: "moved"
+ PropertyChanges { target: myRect; x: 50; y: 50; color: "blue" }
+ PropertyChanges { target: someOtherItem; width: 1000 }
+ }
+ ]
+}
+\endqml
+
+As a convenience, if an item only has one state, its \l {Item::}{states}
+property can be defined as a single \l State, without the square-brace list
+syntax:
\qml
-State {
- name: "moved"
- PropertyChanges { target: myRect; x: 50; y: 50; color: "blue" }
- PropertyChanges { target: someOtherItem; width: 1000 }
+Item {
+ ...
+ states: State {
+ ...
+ }
}
\endqml
@@ -118,54 +134,61 @@ transitions between them.
Of course, the \l Rectangle in the example above could have simply been moved
by setting its position to (50, 50) in the mouse area's \c onClicked handler.
-However, aside from enabling batched property changes, the use of states allows
-an item to revert to its \e {default state}, which contains all of the items'
-initial property values before they were modified in a state change.
+However, aside from enabling batched property changes, one of the features of
+QML states is the ability of an item to revert to its \e {default state}.
+The default state contains all of an item's initial property values before
+they were modified in a state change.
-The default state is specified by an empty string. If the MouseArea in the
-above example was changed to this:
+For example, suppose the \l Rectangle should move to (50,50) when the mouse is
+pressed, and then move back to its original position when the mouse is
+released. This can be achieved by using the \l {State::}{when} property,
+like this:
-\qml
-MouseArea {
- anchors.fill: parent
- onClicked: myRect.state == 'moved' ? myRect.state = "" : myRect.state = 'moved';
-}
-\endqml
-
-This would toggle the \l Rectangle's state between the \e moved and \e default
-states when clicked. The properties can be reverted to their initial
-values without requiring the definition of another \l State that defines these
-value changes.
+\qml
+Rectangle {
+ ...
+ MouseArea {
+ id: mouseArea
+ anchors.fill: parent
+ }
+ states: State {
+ name: "moved"; when: mouseArea.pressed
+ ...
+ }
+}
+\endqml
-\section1 The "when" property
+The \l {State::}{when} property is set to an expression that evaluates to
+\c true when the item should be set to that state. When the mouse is pressed,
+the state is changed to \e moved. When it is released, the item reverts to its
+\e default state, which defines all of the item's original property values.
-The \l {State::}{when} property is useful for specifying when a state should be
-applied. This can be set to an expression that evaluates to \c true when an
-item should change to a particular state.
+Alternatively, an item can be explicitly set to its default state by setting its
+\l {Item::}{state} property to an empty string (""). For example, instead of
+using the \l {State::}{when} property, the above code could be changed to:
-If the above example was changed to this:
-
\qml
Rectangle {
...
MouseArea {
- id: mouseArea
anchors.fill: parent
+ onPressed: myRect.state = 'moved';
+ onReleased: myRect.state = '';
}
states: State {
- name: "moved"; when: mouseArea.pressed
+ name: "moved"
...
}
+}
\endqml
-The \l Rectangle would automatically change to the \e moved state when the
-mouse is pressed, and revert to the default state when it is released. This is
-simpler (and a better, more declarative method) than creating \c onPressed
-and \c onReleased handlers in the MouseArea to set the current state.
+Obviously it makes sense to use the \l {State::}{when} property when possible
+as it provides a simpler (and a better, more declarative) solution than
+assigning the state from signal handlers.
\section1 Animating state changes
diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc
index 8d3aa25..0d191c9 100644
--- a/doc/src/examples/qml-examples.qdoc
+++ b/doc/src/examples/qml-examples.qdoc
@@ -562,7 +562,7 @@
\example declarative/ui-components/dialcontrol
This example shows how to create a dial-type control. It combines
- \l Image elements with \l Rotation transforms and \l SpringAnimatino behaviors
+ \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors
to produce an interactive speedometer-type dial.
\image qml-dialcontrol-example.png
diff --git a/doc/src/examples/simpletreemodel.qdoc b/doc/src/examples/simpletreemodel.qdoc
index c34f4af..16cf8b7 100644
--- a/doc/src/examples/simpletreemodel.qdoc
+++ b/doc/src/examples/simpletreemodel.qdoc
@@ -36,13 +36,15 @@
\image simpletreemodel-example.png
- Qt's model/view architecture provides a standard way for views to manipulate
- information in a data source, using an abstract model of the data to
- simplify and standardize the way it is accessed. Simple models represent
- data as a table of items, and allow views to access this data via an
- \l{model-view-model.html}{index-based} system. More generally, models can
- be used to represent data in the form of a tree structure by allowing each
- item to act as a parent to a table of child items.
+ Qt's model/view architecture provides a standard way for views to
+ manipulate information in a data source, using an abstract model
+ of the data to simplify and standardize the way it is accessed.
+ Simple models represent data as a table of items, and allow views
+ to access this data via an
+ \l{model-view-programming.html#model-indexes} {index-based}
+ system. More generally, models can be used to represent data in
+ the form of a tree structure by allowing each item to act as a
+ parent to a table of child items.
Before attempting to implement a tree model, it is worth considering whether
the data is supplied by an external source, or whether it is going to be
diff --git a/doc/src/examples/spinboxdelegate.qdoc b/doc/src/examples/spinboxdelegate.qdoc
index 49e3295..da65831 100644
--- a/doc/src/examples/spinboxdelegate.qdoc
+++ b/doc/src/examples/spinboxdelegate.qdoc
@@ -42,8 +42,9 @@
\image spinboxdelegate-example.png
This concepts behind this example are covered in the
- \l{model-view-delegate.html}{Delegate Classes} chapter of the
- \l{model-view-programming.html}{Model/View Programming} overview.
+ \l{model-view-programming.html#delegate-classes}{Delegate Classes}
+ chapter of the \l{model-view-programming.html}{Model/View
+ Programming} overview.
\section1 SpinBoxDelegate Class Definition
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index f890aa6..1032e30 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -66,7 +66,8 @@
<div class="sectionlist tricol">
<ul>
<!-- <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> -->
- <li><a href="qt-basic-concepts.html">Basic Qt Architecture</a></li>
+ <li><a href="qt-basic-concepts.html">Qt Basic Concepts</a></li>
+ <li><a href="qt-gui-concepts.html">Qt GUI Concepts</a></li>
<li><a href="developing-with-qt.html">Cross-platform &amp; Platform-specific Development</a></li>
<li><a href="technology-apis.html">Qt &amp; standard technologies </a></li>
<li><a href="best-practices.html">Qt How-to's &amp; best practices</a></li>
@@ -94,14 +95,14 @@
</div>
<div class="section sectionlist">
<ul>
- <li><a href="http://doc.qt.nokia.com/qtcreator-2.0/index.html">Qt Creator</a> (online)</li>
+ <li><a href="http://doc.qt.nokia.com/qtcreator-2.0/index.html">Qt Creator</a></li>
<li><a href="designer-manual.html">Qt Designer</a></li>
<li><a href="linguist-manual.html">Qt Linguist</a></li>
<li><a href="assistant-manual.html">Qt Assistant</a></li>
<li><a href="qmake-manual.html">Qt qmake</a></li>
- <li><a href="http://doc.qt.nokia.com/qtsimulator-1.0/simulator-description.html">Qt Simulator</a> (online)</li>
- <li><a href="http://qt.nokia.com/developer/eclipse-integration">Eclipse Integration</a> (online)</li>
- <li><a href="http://qt.nokia.com/products/appdev">Add-On Products and Services</a> (online)</li>
+ <li><a href="http://doc.qt.nokia.com/qtsimulator-1.0/simulator-description.html">Qt Simulator</a></li>
+ <li><a href="http://qt.nokia.com/developer/eclipse-integration">Eclipse Integration</a></li>
+ <li><a href="http://qt.nokia.com/products/appdev">Add-On Products and Services</a></li>
<li><a href="qvfb.html">Virtual Framebuffer</a></li>
</ul>
</div>
diff --git a/doc/src/objectmodel/metaobjects.qdoc b/doc/src/objectmodel/metaobjects.qdoc
index dd00c5e..0597cd6 100644
--- a/doc/src/objectmodel/metaobjects.qdoc
+++ b/doc/src/objectmodel/metaobjects.qdoc
@@ -28,8 +28,9 @@
/*!
\page metaobjects.html
\title The Meta-Object System
- \ingroup qt-basic-concepts
\brief An overview of Qt's meta-object system and introspection capabilities.
+
+ \ingroup qt-basic-concepts
\keyword meta-object
\target Meta-Object System
diff --git a/doc/src/objectmodel/properties.qdoc b/doc/src/objectmodel/properties.qdoc
index 356aaaf..dca332e 100644
--- a/doc/src/objectmodel/properties.qdoc
+++ b/doc/src/objectmodel/properties.qdoc
@@ -28,8 +28,9 @@
/*!
\page properties.html
\title The Property System
- \ingroup qt-basic-concepts
\brief An overview of Qt's property system.
+
+ \ingroup qt-basic-concepts
\target Qt's Property System
Qt provides a sophisticated property system similar to the ones
diff --git a/doc/src/overviews.qdoc b/doc/src/overviews.qdoc
index b72df98..a1773a3 100644
--- a/doc/src/overviews.qdoc
+++ b/doc/src/overviews.qdoc
@@ -29,7 +29,6 @@
\page overviews.html
\title All Overviews and HOWTOs
- \ingroup qt-basic-concepts
\generatelist overviews
*/
diff --git a/doc/src/painting-and-printing/paintsystem.qdoc b/doc/src/painting-and-printing/paintsystem.qdoc
index e5eb75d..4c6fd91 100644
--- a/doc/src/painting-and-printing/paintsystem.qdoc
+++ b/doc/src/painting-and-printing/paintsystem.qdoc
@@ -273,7 +273,7 @@
\previouspage Paint Devices and Backends
\contentspage The Paint System
- \nextpage The Coordinate System
+ \nextpage Coordinate System
\section1 Drawing
@@ -395,7 +395,7 @@
\page paintsystem-images.html
\title Reading and Writing Image Files
- \previouspage The Coordinate System
+ \previouspage Coordinate System
\contentspage The Paint System
\nextpage Styling
@@ -554,5 +554,5 @@
\endtable
For more information about widget styling and appearance, see the
- \l{Styles &amp Style Aware Widgets}.
+ \l{Styles and Style Aware Widgets}.
*/
diff --git a/doc/src/tutorials/modelview.qdoc b/doc/src/tutorials/modelview.qdoc
index 98096a0..b39a01c 100755
--- a/doc/src/tutorials/modelview.qdoc
+++ b/doc/src/tutorials/modelview.qdoc
@@ -80,8 +80,8 @@
/*!
\page modelview-part1.html
- \contentspage {modelview-index.html}{Model/View Contents}
- \previouspage {modelview-index.html}{Model/View Contents}
+ \contentspage {modelview.html}{Model/View Contents}
+ \previouspage {modelview.html}{Model/View Contents}
\nextpage {modelview-part2.html}{Developing a Simple Model/View Application}
\title An Introduction to Model/View Programming
diff --git a/doc/src/widgets-and-layouts/layout.qdoc b/doc/src/widgets-and-layouts/layout.qdoc
index 798a7a1..d2687ea 100644
--- a/doc/src/widgets-and-layouts/layout.qdoc
+++ b/doc/src/widgets-and-layouts/layout.qdoc
@@ -37,9 +37,9 @@
\brief A tour of the standard layout managers and an introduction to custom
layouts.
- \previouspage Widget Classes
+ \previouspage Widgets and Layouts
\contentspage Widgets and Layouts
- \nextpage {Implementing Styles and Style Aware Widgets}{Styles}
+ \nextpage {Styles and Style Aware Widgets}{Styles}
\ingroup frameworks-technologies
diff --git a/doc/src/widgets-and-layouts/styles.qdoc b/doc/src/widgets-and-layouts/styles.qdoc
index eab7014..180260b 100644
--- a/doc/src/widgets-and-layouts/styles.qdoc
+++ b/doc/src/widgets-and-layouts/styles.qdoc
@@ -33,7 +33,7 @@
/*!
\page style-reference.html
- \title Styles &amp Style Aware Widgets
+ \title Styles and Style Aware Widgets
\ingroup qt-gui-concepts
\brief Styles and the styling of widgets.
diff --git a/doc/src/widgets-and-layouts/stylesheet.qdoc b/doc/src/widgets-and-layouts/stylesheet.qdoc
index 1390376..475de3d 100644
--- a/doc/src/widgets-and-layouts/stylesheet.qdoc
+++ b/doc/src/widgets-and-layouts/stylesheet.qdoc
@@ -32,7 +32,7 @@
\ingroup frameworks-technologies
- \previouspage {Implementing Styles and Style Aware Widgets}{Styles}
+ \previouspage {Styles and Style Aware Widgets}{Styles}
\contentspage Widgets and Layouts
\nextpage The Style Sheet Syntax
diff --git a/doc/src/widgets-and-layouts/widgets.qdoc b/doc/src/widgets-and-layouts/widgets.qdoc
index f2475c2..fbce744 100644
--- a/doc/src/widgets-and-layouts/widgets.qdoc
+++ b/doc/src/widgets-and-layouts/widgets.qdoc
@@ -29,7 +29,6 @@
\page widgets-and-layouts.html
\title Widgets and Layouts
\ingroup qt-gui-concepts
- \ingroup qt-basic-concepts
\brief The primary elements for designing user interfaces in Qt.
\section1 Widgets
@@ -68,7 +67,7 @@
\section1 Widget Styles
- \l{Styles &amp Style Aware Widgets}{Styles} draw on behalf of
+ \l{Styles and Style Aware Widgets}{Styles} draw on behalf of
widgets and encapsulate the look and feel of a GUI. Qt's built-in
widgets use the QStyle class to perform nearly all of their drawing,
ensuring that they look exactly like the equivalent native widgets.
diff --git a/doc/src/windows-and-dialogs/dialogs.qdoc b/doc/src/windows-and-dialogs/dialogs.qdoc
index 74df2aa..bcf9c0e 100644
--- a/doc/src/windows-and-dialogs/dialogs.qdoc
+++ b/doc/src/windows-and-dialogs/dialogs.qdoc
@@ -27,14 +27,9 @@
/*!
\group standard-dialogs
- \ingroup qt-basic-concepts
- \title Standard Dialog Classes
-*/
-
-/*!
- \group dialog-classes
- \ingroup qt-basic-concepts
- \title Classes for Building Dialogs
+ \ingroup qt-gui-concepts
+ \title Standard Dialogs
+ \brief A list of Qt classes for implementing standard dialogs.
*/
/*!
@@ -43,7 +38,7 @@
\ingroup qt-gui-concepts
\brief An overview over dialog windows.
- \previouspage The Application Main Window
+ \previouspage Application Main Window
\contentspage Application Windows and Dialogs
\nextpage Desktop Integration