Qt Mobility Reference Documentation

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.


Public Types

enum MatchingScheme { MatchAll, MatchSubset }

Public Functions

QLandmarkCategoryFetchRequest ( QLandmarkManager * manager, QObject * parent = 0 )
~QLandmarkCategoryFetchRequest ()
QList<QLandmarkCategory> categories () const
QList<QLandmarkCategoryId> categoryIds () const
MatchingScheme matchingScheme () const
void setCategoryId ( const QLandmarkCategoryId & categoryId )
void setCategoryIds ( const QList<QLandmarkCategoryId> & categoryIds = QList<QLandmarkCategoryId> () )
void setMatchingScheme ( QLandmarkCategoryFetchRequest::MatchingScheme matchingScheme )
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 via the callings categories()), as well as if an overall operation error occurred(which may be retrieved by calling QLandmarkAbstractRequest::error()).


Member Type Documentation

enum QLandmarkCategoryFetchRequest::MatchingScheme

Defines the matching behavior of the request when a specific set of category ids is to be retrieved.

ConstantValueDescription
QLandmarkCategoryFetchRequest::MatchAll0A category must be returned for every id assigned to the filter. Failure to match every id results in a QLandmarkManager::DoesNotExistError.
QLandmarkCategoryFetchRequest::MatchSubset1Every id does not have to be matched to a category. Matching only a subset of the assigned ids is acceptable.

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.

QList<QLandmarkCategoryId> QLandmarkCategoryFetchRequest::categoryIds () const

Returns a list of identifiers for categories which will be retrieved by the fetch request.

By default no category ids are set, this means the fetch request will fetch all categories.

See also setCategoryIds().

MatchingScheme QLandmarkCategoryFetchRequest::matchingScheme () const

Returns the matching scheme for the fetch request.

By default the matching scheme is set to to MatchSubset. The matching scheme only has an effect when a particular set of category ids are assigned to the fetch request. If all categories are to be retrieved, then the matching scheme is ignored.

See also setMatchingScheme().

void QLandmarkCategoryFetchRequest::setCategoryId ( const QLandmarkCategoryId & categoryId )

Convenience function to set a single category identified by categoryId to be fetched.

void QLandmarkCategoryFetchRequest::setCategoryIds ( const QList<QLandmarkCategoryId> & categoryIds = QList<QLandmarkCategoryId> () )

Sets the categories to be retrieved by the request as a list of categoryIds.

If categoryIds is empty, then the request will fetch all categories.

See also categoryIds().

void QLandmarkCategoryFetchRequest::setMatchingScheme ( QLandmarkCategoryFetchRequest::MatchingScheme matchingScheme )

Sets the matchingScheme of the fetch request.

See also matchingScheme().

void QLandmarkCategoryFetchRequest::setSorting ( const QLandmarkNameSort & nameSort )

Sets nameSort to specify the sorting of the returned categories.

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.

The sorting only takes effect when all categories are to be retrieved. (i.e. no category ids are assigned to the fetch request). If a particular set of categories are to be retrieved then the sorting is ignored.

See also setSorting().


Copyright © 2009-2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.1.0