summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2014-01-22 13:32:36 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-02-04 16:09:14 +0100
commit84ec21da364e2648e3de6fb84606072fe7d6fab4 (patch)
treed0b6a3e47cb2ce53c75a1b01cda2075a60ff483b
parente047831fd5f8d8fcb39a087d9bdcbf868ee8b6cd (diff)
downloadqtlocation-84ec21da364e2648e3de6fb84606072fe7d6fab4.tar.gz
Remove offset from PlaceSearchModel documentation
The offset property was removed by 1d0966c6924876655c52725e779a7aa24866ff60. Change-Id: Id46e1b6f97e70d38eaef8813be2543293f423fab Reviewed-by: Aaron McCarthy <mccarthy.aaron@gmail.com> Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp27
1 files changed, 13 insertions, 14 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
index f36f1d78..ed97e93e 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
@@ -157,18 +157,17 @@ QT_USE_NAMESPACE
\section1 Paging
The PlaceSearchModel API has some limited support
- for paging. The \l offset and \l limit properties can be used to access
- paged search results. When the \l offset and \l limit properties are set
- the search results between \l offset and (\l offset + \l limit - 1) will be
- returned. For example, if the backend has 5 search results in total
- [a,b,c,d,e], an offset of 0 specifies that the first item returned in the
- model will be 'a'. An offset of 1 secifies that the first item in the model
- will be 'b' and so on. The limit specifies the maximum number of items to
- be returned. For example, assuming an offset of 0 and limit of 3 then a,b,c is
- returned. If the offset exceeds (or equals) the total number of items, then
- 0 results are returned in the model. Note that the API currently does not
- support a means to retrieve the total number of items available from the
- backed. Also note that support for \l offset and \l limit can vary
+ for paging. The \l nextPage() and \l previousPage() functions as well as
+ the \l limit property can be used to access
+ paged search results. When the \l limit property is set
+ the search result page contains at most \l limit entries (of type place result).
+ For example, if the backend has 5 search results in total
+ [a,b,c,d,e], and assuming the first page is shown and limit of 3 has been set
+ then a,b,c is returned. The \l nextPage() would return d,e. The
+ \l nextPagesAvailable and \l previousPagesAvailable properties
+ can be used to check for further pages. At the moment the API does not
+ support the means to retrieve the total number of items available from the
+ backed. Note that support for \l nextPage(), previousPage() and \l limit can vary
according to the \l plugin.
*/
@@ -270,8 +269,8 @@ QT_USE_NAMESPACE
Updates the model based on the provided query parameters. The model will be populated with a
list of places matching the search parameters specified by the type's properties. Search
- criteria is specified by setting properties such as the \l searchTerm, \l categories, \l limit
- and \l offset. Support for these properties may vary according to \l plugin. \c update() then
+ criteria is specified by setting properties such as the \l searchTerm, \l categories, \l searchArea and \l limit.
+ Support for these properties may vary according to \l plugin. \c update() then
submits the set of criteria to the \l plugin to process.
While the model is updating the \l status of the model is set to