MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QLandmarkCategoryFetchRequest Class Reference

The QLandmarkCategoryFetchRequest class allows a client to asynchronously request a list of categories from a landmark manager. More...

 #include <QLandmarkCategoryFetchRequest>

Inherits: QLandmarkAbstractRequest.

This class was introduced in Qt Mobility 1.1.

Public Functions

QLandmarkCategoryFetchRequest ( QLandmarkManager * manager, QObject * parent = 0 )
~QLandmarkCategoryFetchRequest ()
QList<QLandmarkCategory> categories () const
int limit () const
int offset () const
void setLimit ( int limit )
void setOffset ( int offset )
void setSorting ( const QLandmarkNameSort & nameSort )
QLandmarkNameSort sorting () const

Additional Inherited Members

Detailed Description

The QLandmarkCategoryFetchRequest class allows a client to asynchronously request a list of categories from a landmark manager.

For a QLandmarkCategoryFetchRequest, the resultsAvailable() signal will be emitted as resultant categories are found (these are retrievable by calling categories()), as well as if an overall operation error occurred(which may be retrieved by calling QLandmarkAbstractRequest::error()).

Please see the class documentation for QLandmarkAbstractRequest for more information about the usage of request classes and ownership semantics.

Member Function Documentation

QLandmarkCategoryFetchRequest::QLandmarkCategoryFetchRequest ( QLandmarkManager * manager, QObject * parent = 0 )

Creates a new category fetch request object with the given manager and parent.

QLandmarkCategoryFetchRequest::~QLandmarkCategoryFetchRequest ()

Destroys the request object.

QList<QLandmarkCategory> QLandmarkCategoryFetchRequest::categories () const

Returns the list of categories that have been found during the request.

This function was introduced in Qt Mobility 1.1.

int QLandmarkCategoryFetchRequest::limit () const

Returns the maximum number of categories to be returned. By default the limit is -1 indicating that all categories should be retrieved.

This function was introduced in Qt Mobility 1.1.

See also setLimit().

int QLandmarkCategoryFetchRequest::offset () const

Returns the index offset for the request. By default the offset is 0. The offset determines the first index which is retrieved, it is generally used in conjunction with limit() to facilitate paging.

For example, if there are 10 categories in the landmark store, setting the offset to 2 and limit to 5 will retrieve the 3rd to 7th categories inclusively. (The order of categories is specified by the sorting field).

This function was introduced in Qt Mobility 1.1.

See also setOffset().

void QLandmarkCategoryFetchRequest::setLimit ( int limit )

Sets the maximum number of categories to be returned to limit. A limit of -1 will retrieve all categories.

(A limit of 0 will retrieve no categories.)

This function was introduced in Qt Mobility 1.1.

See also limit().

void QLandmarkCategoryFetchRequest::setOffset ( int offset )

Sets the index offset for the request.

This function was introduced in Qt Mobility 1.1.

See also offset().

void QLandmarkCategoryFetchRequest::setSorting ( const QLandmarkNameSort & nameSort )

Sets nameSort to specify the sorting of the returned categories.

This function was introduced in Qt Mobility 1.1.

See also sorting().

QLandmarkNameSort QLandmarkCategoryFetchRequest::sorting () const

Returns the sorting of the categories. By default the sorting is case insensitive and in ascending order according to the category name.

This function was introduced in Qt Mobility 1.1.

See also setSorting().

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.