summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeter Yard <peter.yard@nokia.com>2010-11-11 13:53:37 +1000
committerPeter Yard <peter.yard@nokia.com>2010-11-11 13:53:37 +1000
commitb3003fe7bd371f209321342d0b5767ba7c18844a (patch)
treec7b10eed07cf1a29f461823bb66420497b9e4e15
parentd516045734fa36f900565fd098db6e778dc03593 (diff)
Docs: Made corrections to qml-gallery plugin documentation.
-rw-r--r--doc/src/plugins/qml-gallery.qdoc26
-rw-r--r--doc/src/qml-plugins.qdoc2
2 files changed, 18 insertions, 10 deletions
diff --git a/doc/src/plugins/qml-gallery.qdoc b/doc/src/plugins/qml-gallery.qdoc
index 3b665b51a2..1bf2e8cebc 100644
--- a/doc/src/plugins/qml-gallery.qdoc
+++ b/doc/src/plugins/qml-gallery.qdoc
@@ -49,15 +49,17 @@
\section1 Overview
The QML Gallery plugin contains features that can be used to search
- and retrieve documents from the Document Gallery.
+ for and retrieve documents from the Document Gallery.
\section2 Search Filters
- Searching is performed by creating a filter based on a gallery filter
- class. Search parameters can be set by specifying property values which
- refer to meta-data relating to the documents. For example, a meta-data
- key might be "author". Then, for example, by setting the filter property to "author" and
- the value to "torvalds" the filter is ready to enable a search.
+ Searching is performed by creating a filter based on a derived gallery filter
+ class. This results in a set of Gallery QML elements for filtering.
+ The Search parameters can be set by specifying property values which
+ refer to the meta-data of the documents. For example, a meta-data
+ key might be "author". Then, for example, by setting the filter property to
+ "author" and the value to "torvalds" the filter is ready to enable a search
+ for all documents authored by "torvalds".
Available filters include
@@ -66,7 +68,7 @@
There is nothing to prevent the developer creating a number of filters.
Then she could use either a \l {GalleryFilterUnion} or a \l
{GalleryFilterIntersection} to find the result of OR-ing or AND-ing the
- criteria to create a more complex search criterion.
+ criteria respectively to create a more complex search requirement.
\section2 Gallery Item
@@ -79,8 +81,8 @@
contains the current status of the request including whether it is active
or canceled.
- Progress of the request is available through the \l qreal item property \l
- {DocumentGalleryItem::progress}{progress}.
+ Progress of the request is available through the \l qreal (floating point
+ number) item property \l {DocumentGalleryItem::progress}{progress}.
@@ -110,6 +112,12 @@
...
\endcode
+ Here we have a model using a DocumentGalleryQueryModel. Within Qt the
+ term 'model' usually refers to the Model part of a variation on the
+ Model-View-Controller design pattern. In essence it is a data-oriented
+ part of the Gallery query object, what data types are part of this query.
+ For a clearer understanding \l{http://doc.qt.nokia.com/4.7/model-view-programming.html}{see the Qt documentation}.
+
\section1 Classes
diff --git a/doc/src/qml-plugins.qdoc b/doc/src/qml-plugins.qdoc
index 4d40396b51..24d5a38b97 100644
--- a/doc/src/qml-plugins.qdoc
+++ b/doc/src/qml-plugins.qdoc
@@ -79,7 +79,7 @@
it may seem natural that moving this working script to a Symbian platform
should be uneventful. However, the version of 'qmlviewer' may not know
about this capability. If that is the case then 'qmlviewer' should be
- recompiled by the developer with the capability explicitly added.
+ recompiled by the developer with the capability explicitly added.
It should be noted that the use of a plugin, with capabilities outside
of "NetworkServices ReadUserData", and viewed on a Symbian device via