summaryrefslogtreecommitdiffstats
path: root/doc/src/examples
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/examples')
-rw-r--r--doc/src/examples/audiodevices.qdoc2
-rw-r--r--doc/src/examples/audioinput.qdoc2
-rw-r--r--doc/src/examples/audiooutput.qdoc2
-rw-r--r--doc/src/examples/basicgraphicslayouts.qdoc8
-rw-r--r--doc/src/examples/combowidgetmapper.qdoc2
-rw-r--r--doc/src/examples/concentriccircles.qdoc2
-rw-r--r--doc/src/examples/drilldown.qdoc2
-rw-r--r--doc/src/examples/elasticnodes.qdoc14
-rw-r--r--doc/src/examples/fancybrowser.qdoc4
-rw-r--r--doc/src/examples/qml-examples.qdoc22
-rw-r--r--doc/src/examples/qml-folderlistmodel.qdoc7
-rw-r--r--doc/src/examples/svgalib.qdoc5
-rw-r--r--doc/src/examples/textfinder.qdoc2
13 files changed, 47 insertions, 27 deletions
diff --git a/doc/src/examples/audiodevices.qdoc b/doc/src/examples/audiodevices.qdoc
index b812968..fd56e38 100644
--- a/doc/src/examples/audiodevices.qdoc
+++ b/doc/src/examples/audiodevices.qdoc
@@ -32,6 +32,8 @@
The Audio Devices example demonstrates the basic use of QAudioDeviceInfo class
provided with Qt.
+ \image audiodevices-example.png
+
Qt provides the QAudioDeviceInfo class to enable audio querying within
a standard application user interface.
diff --git a/doc/src/examples/audioinput.qdoc b/doc/src/examples/audioinput.qdoc
index 7ca01a5..44b480f 100644
--- a/doc/src/examples/audioinput.qdoc
+++ b/doc/src/examples/audioinput.qdoc
@@ -32,6 +32,8 @@
The Audio Input example demonstrates the basic use of QAudioInput class
provided with Qt.
+ \image audioinput-example.png
+
Qt provides the QAudioInput class to enable audio functionality within
a standard application user interface.
diff --git a/doc/src/examples/audiooutput.qdoc b/doc/src/examples/audiooutput.qdoc
index 358c404..1703883 100644
--- a/doc/src/examples/audiooutput.qdoc
+++ b/doc/src/examples/audiooutput.qdoc
@@ -32,6 +32,8 @@
The Audio Output example demonstrates the basic use of the QAudioOutput class
provided with Qt.
+ \image audiooutput-example.png
+
This example provides a tone generator to supply continuous audio playback.
The first button allows pause and resume of the playback.
The second button allows toggling between push and pull modes of operation.
diff --git a/doc/src/examples/basicgraphicslayouts.qdoc b/doc/src/examples/basicgraphicslayouts.qdoc
index 11b99f3..0110e29 100644
--- a/doc/src/examples/basicgraphicslayouts.qdoc
+++ b/doc/src/examples/basicgraphicslayouts.qdoc
@@ -133,19 +133,19 @@
\snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 2
- The reimplementation of {QGraphicsItem::boundingRect()}{boundingRect()}
+ The reimplementation of \l{QGraphicsItem::}{boundingRect()}
will set the top left corner at (0,0), and the size of it will be
the size of the layout items
- {QGraphicsLayoutItem::geometry()}{geometry()}. This is the area that
+ \l{QGraphicsLayoutItem::}{geometry()}. This is the area that
we paint within.
\snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 3
- The reimplementation of {QGraphicsLayoutItem::setGeometry()}{setGeometry()}
+ The reimplementation of \l{QGraphicsLayoutItem::setGeometry()}{setGeometry()}
simply calls its baseclass implementation. However, since this will change
the boundingRect we must also call
- {QGraphicsItem::prepareGeometryChange()}{prepareGeometryChange()}.
+ \l{QGraphicsItem::prepareGeometryChange()}{prepareGeometryChange()}.
Finally, we move the item according to \c geom.topLeft().
\snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 4
diff --git a/doc/src/examples/combowidgetmapper.qdoc b/doc/src/examples/combowidgetmapper.qdoc
index 1a9bf5a..897d135 100644
--- a/doc/src/examples/combowidgetmapper.qdoc
+++ b/doc/src/examples/combowidgetmapper.qdoc
@@ -32,7 +32,7 @@
The Delegate Widget Mapper example shows how to use a custom delegate to
map information from a model to specific widgets on a form.
- \image combo-widget-mapper.png
+ \image combowidgetmapper-example.png
In the \l{Simple Widget Mapper Example}, we showed the basic use of a
widget mapper to relate data exposed by a model to simple input widgets
diff --git a/doc/src/examples/concentriccircles.qdoc b/doc/src/examples/concentriccircles.qdoc
index dc17871..315469b 100644
--- a/doc/src/examples/concentriccircles.qdoc
+++ b/doc/src/examples/concentriccircles.qdoc
@@ -192,7 +192,7 @@
\snippet examples/painting/concentriccircles/window.h 0
- We declare the various components of the main window, i.e the text
+ We declare the various components of the main window, i.e., the text
labels and a double array that will hold reference to the four \c
{CircleWidget}s. In addition we declare the private \c
createLabel() function to simplify the constructor.
diff --git a/doc/src/examples/drilldown.qdoc b/doc/src/examples/drilldown.qdoc
index bc45db3..8739270 100644
--- a/doc/src/examples/drilldown.qdoc
+++ b/doc/src/examples/drilldown.qdoc
@@ -444,7 +444,7 @@
Finally, we store the location ID that this particular record is
associated with as well as a z-value. In the \l {Graphics View
Framework}, an item's z-value determines its position in the item
- stack. An item of high Z-value will be drawn on top of an item
+ stack. An item of high z-value will be drawn on top of an item
with a lower z-value if they share the same parent item. We also
provide an \c updateItemPosition() function to refresh the view
when required.
diff --git a/doc/src/examples/elasticnodes.qdoc b/doc/src/examples/elasticnodes.qdoc
index d6676e8..bba6d90 100644
--- a/doc/src/examples/elasticnodes.qdoc
+++ b/doc/src/examples/elasticnodes.qdoc
@@ -77,12 +77,12 @@
function is called to calculate the forces that push and pull on this node
and its neighbors.
- The \c Node class also reimplements
- \l{QGraphicsItem::itemChange()}{itemChange()} to react to state changes (in
- this case, position changes), and
- \l{QGraphicsItem::mousePressEvent()}{mousePressEvent()} and
- \l{QGraphicsItem::mouseReleaseEvent()}{mouseReleaseEvent()} to update the
- item's visual appearance.
+ The \c Node class also reimplements
+ \l{QGraphicsItem::itemChange()}{itemChange()} to react to state changes (in
+ this case, position changes), and
+ \l{QGraphicsItem::mousePressEvent()}{mousePressEvent()} and
+ \l{QGraphicsItem::mouseReleaseEvent()}{mouseReleaseEvent()} to update the
+ item's visual appearance.
We will start reviewing the \c Node implementation by looking at its
constructor:
@@ -242,7 +242,7 @@
The \c adjust() function repositions the edge, and the item also implements
\l{QGraphicsItem::boundingRect()}{boundingRect()} and
- \{QGraphicsItem::paint()}{paint()}.
+ \l{QGraphicsItem::paint()}{paint()}.
We will now review its implementation.
diff --git a/doc/src/examples/fancybrowser.qdoc b/doc/src/examples/fancybrowser.qdoc
index 4121904..b46903d 100644
--- a/doc/src/examples/fancybrowser.qdoc
+++ b/doc/src/examples/fancybrowser.qdoc
@@ -118,7 +118,7 @@
using CSS.
\snippet examples/webkit/fancybrowser/mainwindow.cpp 8
-
+
The \c rotateImages() function rotates the images on the current
web page. Webkit supports CSS transforms and this JavaScript code
looks up all \e {img} elements and rotates the images 180 degrees
@@ -127,7 +127,7 @@
\snippet examples/webkit/fancybrowser/mainwindow.cpp 9
The remaining four methods remove different elements from the current web
- page. \c removeGifImages() removes all Gif images on the page by looking up
+ page. \c removeGifImages() removes all GIF images on the page by looking up
the \e {src} attribute of all the elements on the web page. Any element with
a \e {gif} file as its source is removed. \c removeInlineFrames() removes all
\e {iframe} or inline elements. \c removeObjectElements() removes all
diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc
index 46af110..bbea19b 100644
--- a/doc/src/examples/qml-examples.qdoc
+++ b/doc/src/examples/qml-examples.qdoc
@@ -68,7 +68,7 @@
\title Animation: States Example
\example declarative/animation/states
- These examples show how to use \l{States}{states} and \l{Transitions}{transitions}.
+ These examples show how to use \l{State}{states} and \l{Transition}{transitions}.
The \c states.qml example shows how an item can change between states, and \c transitions.qml
shows how these state changes can be animated.
@@ -270,16 +270,26 @@
*/
/*!
- \title Positioners Example
- \example declarative/positioners
+ \title Positioners: Adding and Removing Items Example
+ \example declarative/positioners/addandremove
- This example shows how to use positioner elements such as \l Row, \l Column,
- \l Grid and \l Flow.
+ This example shows how to use the positioner elements such as \l Row, \l Column,
+ \l Grid and \l Flow, in particular how to add and remove items with appropriate transitions.
\image qml-positioners-example.png
*/
/*!
+ \title Positioners: Layout Direction Example
+ \example declarative/positioners/layoutdirection
+
+ This example shows how to control the horizontal layout direction of
+ \l Row, \l Grid and \l Flow positioners.
+
+ \image qml-positioners-layoutdirection-example.png
+*/
+
+/*!
\title Key Interaction: Focus Example
\example declarative/keyinteraction/focus
@@ -664,7 +674,7 @@
This example shows how to create a tab widget. It also demonstrates how
\l {Property aliases}{property aliases} and
- \l {Default Properties}{default properties} can be used to collect and
+ \l {Introduction to the QML Language#Default Properties}{default properties} can be used to collect and
assemble the child items declared within an \l Item.
\image qml-tabwidget-example.png
diff --git a/doc/src/examples/qml-folderlistmodel.qdoc b/doc/src/examples/qml-folderlistmodel.qdoc
index c9d248e..0a01ce0 100644
--- a/doc/src/examples/qml-folderlistmodel.qdoc
+++ b/doc/src/examples/qml-folderlistmodel.qdoc
@@ -41,10 +41,15 @@ making the model available to QML.
\section1 Usage from QML
-The type we are creating can be used from QML like this:
+The FolderListModel can be used from QML like this:
\snippet doc/src/snippets/declarative/folderlistmodel.qml 0
+This displays a list of all subfolders and QML files in the current folder.
+
+The FolderListModel \c folder property can be set to change the folder that
+is currently displayed.
+
\section1 Defining the Model
We are subclassing QAbstractListModel which will allow us to give data to QML and
diff --git a/doc/src/examples/svgalib.qdoc b/doc/src/examples/svgalib.qdoc
index b69bead..e13cd7f 100644
--- a/doc/src/examples/svgalib.qdoc
+++ b/doc/src/examples/svgalib.qdoc
@@ -322,9 +322,8 @@
\snippet examples/qws/svgalib/svgalibsurface.h 0
We can implement most of the pure virtual functions inherited from
- QWSWindowSurface as trivial inline functions, except the
- \l {QWindowSurface::}{scroll()} function that actually makes use
- of some hardware acceleration:
+ QWSWindowSurface as trivial inline functions, except the scroll()
+ function that actually makes use of some hardware acceleration:
\snippet examples/qws/svgalib/svgalibsurface.cpp 0
diff --git a/doc/src/examples/textfinder.qdoc b/doc/src/examples/textfinder.qdoc
index 31fe785..e92bb98 100644
--- a/doc/src/examples/textfinder.qdoc
+++ b/doc/src/examples/textfinder.qdoc
@@ -80,7 +80,7 @@
\snippet examples/uitools/textfinder/textfinder.h 0
- The slot \c{on_find_Button_clicked()} is a slot named according to the
+ The slot \c{on_findButton_clicked()} is a slot named according to the
\l{Using a Designer UI File in Your Application#Automatic Connections}
{Automatic Connection} naming convention required
by \c uic.