summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2010-05-20 03:43:22 (GMT)
committerBea Lam <bea.lam@nokia.com>2010-05-20 04:11:51 (GMT)
commit91251b69edd966965bf7944aec642321c362af2a (patch)
tree1a377a8a9ea571416a2676e4cebdcfdbcd97e4f5
parentc37a7442d298ccec251b9178a31b1f0c8f199676 (diff)
downloadQt-91251b69edd966965bf7944aec642321c362af2a.zip
Qt-91251b69edd966965bf7944aec642321c362af2a.tar.gz
Qt-91251b69edd966965bf7944aec642321c362af2a.tar.bz2
Fixes for docs, example code
-rw-r--r--doc/src/declarative/examples.qdoc4
-rw-r--r--doc/src/declarative/integrating.qdoc2
-rw-r--r--doc/src/examples/qml-examples.qdoc190
-rw-r--r--examples/declarative/cppextensions/networkaccessmanagerfactory/main.cpp2
-rw-r--r--examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.pro5
-rw-r--r--examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.qml12
-rw-r--r--examples/declarative/cppextensions/qgraphicslayouts/layoutItem/main.cpp2
-rw-r--r--src/declarative/graphicsitems/qdeclarativeflickable.cpp2
-rw-r--r--src/declarative/graphicsitems/qdeclarativelistview.cpp20
9 files changed, 168 insertions, 71 deletions
diff --git a/doc/src/declarative/examples.qdoc b/doc/src/declarative/examples.qdoc
index 72c585b..a355f9f 100644
--- a/doc/src/declarative/examples.qdoc
+++ b/doc/src/declarative/examples.qdoc
@@ -75,7 +75,7 @@ For example, from your build directory, run:
\list
\o \l{declarative/animation/basics}{Basics}
\o \l{declarative/animation/behaviors}{Behaviors}
-\o \l{declarative/animation/easing}{Easing}
+\o \l{declarative/animation/easing}{Easing types}
\o \l{declarative/animation/states}{States}
\endlist
@@ -138,7 +138,7 @@ For example, from your build directory, run:
\list
\o \l{declarative-cppextensions-reference.html}{Reference examples} (discussed in \l {Extending QML in C++})
\o \l{declarative/cppextensions/plugins}{Plugins}
-\o \l{declarative/cppextensions/qgraphicslayouts}{QGraphicsLayouts}
+\o \l{declarative-cppextensions-qgraphicslayouts.html}{QGraphicsLayouts}
\o \l{declarative/cppextensions/qwidgets}{QWidgets}
\o \l{declarative/cppextensions/imageprovider}{Image provider}
\o \l{declarative/cppextensions/networkaccessmanagerfactory}{Network access manager factory}
diff --git a/doc/src/declarative/integrating.qdoc b/doc/src/declarative/integrating.qdoc
index 83380a1..c6f754b 100644
--- a/doc/src/declarative/integrating.qdoc
+++ b/doc/src/declarative/integrating.qdoc
@@ -110,7 +110,7 @@ of QML UIs:
\section2 Loading QGraphicsWidget objects in QML
An alternative approach is to expose your existing QGraphicsWidget objects to
-QML and construct your scene in QML instead. See the \l {declarative/cppextensions/qgraphicslayouts}{graphics layouts example}
+QML and construct your scene in QML instead. See the \l {declarative-cppextensions-qgraphicslayouts.html}{graphics layouts example}
which shows how to expose Qt's graphics layout classes to QML in order
to use QGraphicsWidget with classes like QGraphicsLinearLayout and QGraphicsGridLayout.
diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc
index fa17c6a..c2237d6 100644
--- a/doc/src/examples/qml-examples.qdoc
+++ b/doc/src/examples/qml-examples.qdoc
@@ -40,39 +40,43 @@
****************************************************************************/
/*!
- \title Animation basics
+ \title Animation: Basics
\example declarative/animation/basics
- This example shows how to use animations in QML.
+ This example shows how to create \l{QML Animation}{animations} in QML.
*/
/*!
- \title Behaviors
+ \title Animation: Behaviors
\example declarative/animation/behaviors
+
+ This example shows how to use QML behaviors.
*/
/*!
- \title Easing types
+ \title Animation: Easing types
\example declarative/animation/easing
- This example shows the different easing modes available for animations.
+ This example shows the different easing modes available for \l{QML Animation}{animations}.
*/
/*!
- \title States
+ \title Animation: States
\example declarative/animation/states
+
+ This example shows how to use \l{States}{states} and \l{Transitions}{transitions}.
*/
/*!
- \title Border Image
+ \title Image Elements: Border Image
\example declarative/imageelements/borderimage
- This example shows how to use a BorderImage in QML.
+ This example shows how to use the BorderImage element.
*/
/*!
\page declarative-cppextensions-reference.html
- \title C++ Extensions - Reference examples
+ \title C++ Extensions: Reference examples
These examples show how QML can be extended from C++ in various ways.
@@ -99,33 +103,67 @@
*/
/*!
- \title Plugins
+ \title C++ Extensions: Plugins
\example declarative/cppextensions/plugins
+
+ This example shows how to create a C++ plugin extension by subclassing QDeclarativeExtensionPlugin.
+*/
+
+/*!
+ \title Graphics Layouts
+ \example declarative/cppextensions/qgraphicslayouts/graphicsLayouts
+
+ This example show how to integrate Qt \l{Graphics View Framework}{Graphics View} components
+ like QGraphicsLayoutItem, QGraphicsLinearLayout and QGraphicsGridLayout into QML.
*/
+/*!
+ \title Layout Item
+ \example declarative/cppextensions/qgraphicslayouts/layoutItem
+ This example show how to integrate QML into an existing
+ \l{Graphics View Framework}{Graphics View}-based application.
+*/
/*!
- \title QGraphicsLayouts
- \example declarative/cppextensions/qgraphicslayouts
+ \page declarative-cppextensions-qgraphicslayouts.html
+ \title C++ Extensions: QGraphicsLayouts
+
+ These examples show how to integrate \l{Graphics View Framework}{Graphics View}
+ layout components with QML:
+
+ \list
+ \o \l{declarative/cppextensions/qgraphicslayouts/graphicsLayouts}{Graphics Layouts}
+ \o \l{declarative/cppextensions/qgraphicslayouts/layoutItem}{Layout Item}
+ \endlist
*/
/*!
- \title QWidgets
+ \title C++ Extensions: QWidgets
\example declarative/cppextensions/qwidgets
+
+ This example shows how to embed QWidget-based objects into QML using QGraphicsProxyWidget.
*/
/*!
- \title Image Provider
+ \title C++ Extensions: Image Provider
\example declarative/cppextensions/imageprovider
+
+ This examples shows how to use QDeclarativeImageProvider to serve images asynchronously
+ into a QML item.
*/
/*!
- \title Network access manager
+ \title C++ Extensions: Network access manager
\example declarative/cppextensions/networkaccessmanagerfactory
+
+ This example shows how to use QDeclarativeNetworkAccessManagerFactory to create a QNetworkAccessManager
+ with a proxy.
*/
/*!
\title Internationlization
\example declarative/i18n
+
+ This example shows how to enable text translation in QML.
*/
/*!
@@ -137,7 +175,7 @@
*/
/*!
- \title Focus
+ \title Key Interaction: Focus
\example declarative/keyinteraction/focus
This example shows how to handle keys and focus in QML.
@@ -146,144 +184,204 @@
*/
/*!
- \title GridView
+ \title Models and Views: GridView
\example declarative/modelviews/gridview
+
+ This example shows how to use the GridView element.
*/
/*!
- \title ListView
+ \title Models and Views: ListView
\example declarative/modelviews/listview
+
+ This example shows how to use the ListView element.
*/
/*!
- \title Object ListModel
+ \title Models and Views: Object ListModel
\example declarative/modelviews/objectlistmodel
+
+ This example shows how to create a C++ extension that exposes a
+ QList<QObject*> as a model in QML.
*/
/*!
- \title Package
+ \title Models and Views: Package
\example declarative/modelviews/package
+
+ This example shows how to use the Package element.
*/
/*!
- \title Parallax
+ \title Models and Views: Parallax
\example declarative/modelviews/parallax
+
+ This example shows how to combine and switch between views.
*/
/*!
- \title String ListModel
+ \title Models and Views: String ListModel
\example declarative/modelviews/stringlistmodel
+
+ This example shows how to create a C++ extension that exposes a
+ QStringList as a model in QML.
*/
/*!
- \title WebView
+ \title Models and Views: WebView
\example declarative/modelviews/webview
+
+ This example shows how to use the WebView element.
*/
/*!
\title SQL Local Storage
\example declarative/sqllocalstorage
+
+ This example shows how to use the SQL Local Storage API in QML.
*/
/*!
- \title Fonts
+ \title Text: Fonts
\example declarative/text/fonts
+
+ This example shows how to discover available fonts from QML and use
+ fonts in different ways.
*/
/*!
- \title Threaded ListModel
+ \title Threading: Threaded ListModel
\example declarative/threading/threadedlistmodel
+
+ This example shows how to use a ListModel from multiple threads using
+ WorkerScript.
*/
/*!
- \title WorkerScript
+ \title Threading: WorkerScript
\example declarative/threading/workerscript
+
+ This example shows how to use the WorkerScript element for threading in QML.
*/
/*!
- \title Clocks
+ \title Toys: Clocks
\example declarative/toys/clocks
- This example shows how to create a Clock component and reuse it in a grid.
+ This example displays a set of clocks with different times for different cities.
+ Each clock is created by combining \l Image elements with \l Rotation transforms
+ and \l SpringFollow animations.
*/
/*!
- \title Corkboards
+ \title Toys: Corkboards
\example declarative/toys/corkboards
+
+ This example presents a flickable set of interactive corkboards. It is created
+ through a combination of elements like \l ListModel, \l Repeater and \l TextEdit
+ together with rotation and scaling transforms, animation and mouse interaction.
*/
/*!
- \title Dial
+ \title Toys: Dial
\example declarative/toys/dial
- This example shows how to implement a dial in QML.
+ This example presents an interactive speedometer-type dial by combining
+ \l Image elements with \l Rotation transforms and \l SpringFollow animations.
*/
/*!
- \title Dynamic Scene
+ \title Toys: Dynamic Scene
\example declarative/toys/dynamicscene
- This example shows how to create dynamic objects QML.
+ This example presents an interactive drag-and-drop scene. It demonstrates
+ how to use QML's \l{Dynamic Object Creation} support to dynamically create and
+ destroy objects.
*/
/*!
- \title Tic-Tac-Toe
+ \title Toys: Tic-Tac-Toe
\example declarative/toys/tic-tac-toe
+
+ This example presents a simple implementation of Tic Tac Toe.
*/
/*!
- \title TV Tennis
+ \title Toys: TV Tennis
\example declarative/toys/tvtennis
+
+ This example shows how to use animation components such as \l SpringFollow,
+ \l SequentialAnimation and \l PropertyAction to create a game of TV tennis.
*/
/*!
- \title Gestures
+ \title Touch Interaction: Gestures
\example declarative/touchinteraction/gestures
+
+ This example shows how to use the GestureArea element.
*/
/*!
- \title Mouse Area
+ \title Touch Interaction: Mouse Area
\example declarative/touchinteraction/mousearea
+
+ This example shows how to use the MouseArea element.
*/
/*!
- \title Flipable
+ \title UI Components: Flipable
\example declarative/ui-components/flipable
- This example shows how to use a Flipable element in QML.
+ This example shows how to use the Flipable element.
*/
/*!
- \title Progress Bars
+ \title UI Components: Progress Bars
\example declarative/ui-components/progressbar
+
+ This example shows how to create a progress bar.
*/
/*!
- \title Scrollbar
+ \title UI Components: Scroll Bar
\example declarative/ui-components/scrollbar
+
+ This example shows how to create scroll bars for a Flickable element
+ using the \l {Flickable::visibleArea.xPosition}{Flickable::visibleArea}
+ properties.
*/
/*!
- \title Search Box
+ \title UI Components: Search Box
\example declarative/ui-components/searchbox
+
+ This example shows how to create a search box.
*/
/*!
- \title Slide Switch
+ \title UI Components: Slide Switch
\example declarative/ui-components/slideswitch
+
+ This example shows how to create a slide switch.
*/
/*!
- \title Spinner
+ \title UI Components: Spinner
\example declarative/ui-components/spinner
+
+ This example shows how to create a spinner-type component.
*/
/*!
- \title Tab Widget
+ \title UI Components: Tab Widget
\example declarative/ui-components/tabwidget
+
+ This example shows how to create a tab widget.
*/
/*!
- \title XMLHttpRequest
+ \title XML: XMLHttpRequest
\example declarative/xml/xmlhttprequest
+
+ This example shows how to use \l XmlHttpRequest in QML.
*/
diff --git a/examples/declarative/cppextensions/networkaccessmanagerfactory/main.cpp b/examples/declarative/cppextensions/networkaccessmanagerfactory/main.cpp
index 4ecbb5c..fac36ff 100644
--- a/examples/declarative/cppextensions/networkaccessmanagerfactory/main.cpp
+++ b/examples/declarative/cppextensions/networkaccessmanagerfactory/main.cpp
@@ -49,7 +49,7 @@
/*
- This example illustrates using a QNetworkAccessManagerFactory to
+ This example illustrates using a QDeclarativeNetworkAccessManagerFactory to
create a QNetworkAccessManager with a proxy.
Usage:
diff --git a/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.pro b/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.pro
index 4a3fc73..c85a400 100644
--- a/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.pro
+++ b/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.pro
@@ -1,13 +1,8 @@
-######################################################################
-# Automatically generated by qmake (2.01a) Tue May 4 13:36:26 2010
-######################################################################
-
TEMPLATE = app
TARGET =
DEPENDPATH += .
INCLUDEPATH += .
QT += declarative
-# Input
SOURCES += main.cpp
RESOURCES += layoutItem.qrc
diff --git a/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.qml b/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.qml
index 460c564..6f91dc9 100644
--- a/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.qml
+++ b/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/layoutItem.qml
@@ -1,15 +1,17 @@
import Qt 4.7
-LayoutItem {//Sized by the layout
+LayoutItem { //Sized by the layout
id: resizable
+
minimumSize: "100x100"
maximumSize: "300x300"
preferredSize: "100x100"
+
Rectangle { color: "yellow"; anchors.fill: parent }
+
Rectangle {
- width: 100; height: 100;
- anchors.top: parent.top;
- anchors.right: parent.right;
- color: "green";
+ width: 100; height: 100
+ anchors.top: parent.top; anchors.right: parent.right
+ color: "green"
}
}
diff --git a/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/main.cpp b/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/main.cpp
index a104251..47d3a23 100644
--- a/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/main.cpp
+++ b/examples/declarative/cppextensions/qgraphicslayouts/layoutItem/main.cpp
@@ -53,6 +53,7 @@
int main(int argc, char* argv[])
{
QApplication app(argc, argv);
+
//Set up a graphics scene with a QGraphicsWidget and Layout
QGraphicsView view;
QGraphicsScene scene;
@@ -61,6 +62,7 @@ int main(int argc, char* argv[])
widget->setLayout(layout);
scene.addItem(widget);
view.setScene(&scene);
+
//Add the QML snippet into the layout
QDeclarativeEngine engine;
QDeclarativeComponent c(&engine, QUrl(":layoutItem.qml"));
diff --git a/src/declarative/graphicsitems/qdeclarativeflickable.cpp b/src/declarative/graphicsitems/qdeclarativeflickable.cpp
index 3c0f5a2..560d586 100644
--- a/src/declarative/graphicsitems/qdeclarativeflickable.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeflickable.cpp
@@ -415,7 +415,7 @@ void QDeclarativeFlickablePrivate::updateBeginningEnd()
These properties are typically used to draw a scrollbar. For example:
\snippet doc/src/snippets/declarative/flickableScrollbar.qml 0
- \dots 4
+ \dots 8
\snippet doc/src/snippets/declarative/flickableScrollbar.qml 1
\sa {declarative/ui-components/scrollbar}{scrollbar example}
diff --git a/src/declarative/graphicsitems/qdeclarativelistview.cpp b/src/declarative/graphicsitems/qdeclarativelistview.cpp
index 23a6f63..61283df 100644
--- a/src/declarative/graphicsitems/qdeclarativelistview.cpp
+++ b/src/declarative/graphicsitems/qdeclarativelistview.cpp
@@ -1321,7 +1321,7 @@ void QDeclarativeListViewPrivate::flick(AxisData &data, qreal minExtent, qreal m
\snippet doc/src/snippets/declarative/listview/ContactModel.qml 0
- A ListView can display the data in the model, like this:
+ Another component can display this model data in a ListView, like this:
\table
\row
@@ -1332,13 +1332,13 @@ void QDeclarativeListViewPrivate::flick(AxisData &data, qreal minExtent, qreal m
\endtable
Here, the ListView creates a \c ContactModel component for its model, and a \l Text element
- for its delegate. The view creates a new \l Text component for each item in the model. Note
+ for its delegate. The view will create a new \l Text component for each item in the model. Notice
the delegate is able to access the model's \c name and \c number data directly.
An improved list view is shown below. The delegate is visually improved and is moved
into a separate \c contactDelegate component. Also, the currently selected item is highlighted
with a blue \l Rectangle using the \l highlight property, and \c focus is set to \c true
- to enable keyboard navigation for the list.
+ to enable keyboard navigation for the list view.
\table
\row
@@ -1346,10 +1346,10 @@ void QDeclarativeListViewPrivate::flick(AxisData &data, qreal minExtent, qreal m
\o \image listview-highlight.png
\endtable
- Delegates are instantiated as needed and may be destroyed at any time.
+ In a ListView, delegates are instantiated as needed and may be destroyed at any time.
State should \e never be stored in a delegate.
- \bold Note that views do not enable \e clip automatically. If the view
+ \note Views do not enable \e clip automatically. If the view
is not clipped by another item or the screen, it will be necessary
to set \e {clip: true} in order to have the out of view items clipped
nicely.
@@ -1693,9 +1693,9 @@ void QDeclarativeListView::setHighlightFollowsCurrentItem(bool autoHighlight)
\qmlproperty real ListView::preferredHighlightEnd
\qmlproperty enumeration ListView::highlightRangeMode
- These properties set the preferred range of the highlight (current item)
- within the view. The \c preferredHighlightEnd must be greater than or equal to
- \c preferredHighlightBegin.
+ These properties define the preferred range of the highlight (for the current item)
+ within the view. The \c preferredHighlightBegin value must be less than the
+ \c preferredHighlightEnd value.
These properties affect the position of the current item when the list is scrolled.
For example, if the currently selected item should stay in the middle of the
@@ -1794,8 +1794,8 @@ void QDeclarativeListView::setSpacing(qreal spacing)
Possible values:
\list
- \o ListView.Horizontal - Items are laid out horizontally.
- \o ListView.Vertical - Items are laid out vertically. This is the default value.
+ \o ListView.Horizontal - Items are laid out horizontally
+ \o ListView.Vertical (default) - Items are laid out vertically
\endlist
\table