QLandmarkIdFetchRequest Class Reference

 #include <QLandmarkIdFetchRequest>

Member Function Documentation

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

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

QLandmarkIdFetchRequest::~QLandmarkIdFetchRequest ()

Destroys the request object.

QLandmarkFilter QLandmarkIdFetchRequest::filter () const

Returns the filter which will be used to select the landmarks whose identifiers will be returned.

By default, the filter's type will be a QLandmarkFilter::DefaultFilter and thus match all landmarks.

This function was introduced in Qt Mobility 1.1.

See also setFilter().

QList<QLandmarkId> QLandmarkIdFetchRequest::landmarkIds () const

Returns the list of identifiers of landmarks which matched the filter.

This function was introduced in Qt Mobility 1.1.

int QLandmarkIdFetchRequest::limit () const

Returns the maximum number of landmark IDs to be returned. By default the limit is set to -1 indicating that IDs of all landmarks are to be retrieved.

This function was introduced in Qt Mobility 1.1.

See also setLimit().

int QLandmarkIdFetchRequest::offset () const

Returns the index offset for the request. By default the offset is set to 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 landmarks in the landmark store, setting the offset to 2 and limit to 5 will retrieve the 3rd and 7th landmark ids inclusively. (The order of the landmark ids is sepecified by the sorting field).

This function was introduced in Qt Mobility 1.1.

See also setOffset().

void QLandmarkIdFetchRequest::setFilter ( const QLandmarkFilter & filter )

Sets the filter which will be used to select landmark identifiers.

This function was introduced in Qt Mobility 1.1.

See also filter().

void QLandmarkIdFetchRequest::setLimit ( int limit )

Sets the maximum number of landmarks to be returned to limit.

A limit of -1 indicates that IDs of all landmarks are to be retrieved.

(A limit of 0 will retrieve no landmark IDs.)

This function was introduced in Qt Mobility 1.1.

See also limit().

void QLandmarkIdFetchRequest::setOffset ( int offset )

Sets the index offset for the request.

This function was introduced in Qt Mobility 1.1.

See also offset().

void QLandmarkIdFetchRequest::setSorting ( const QList<QLandmarkSortOrder> & sorting )

Sets the sort ordering of the request to sorting. This function will only have an effect on the results if invoked prior to calling QLandmarkAbstractRequest::start().

This function was introduced in Qt Mobility 1.1.

See also sorting().

void QLandmarkIdFetchRequest::setSorting ( const QLandmarkSortOrder & sorting )

Convenience function to set the sort ordering of the request to a single sorting. This function will only have an effect on the results if invoked prior to calling QLandmarkAbstractRequest::start().

This function was introduced in Qt Mobility 1.1.

QList<QLandmarkSortOrder> QLandmarkIdFetchRequest::sorting () const

Returns the sort ordering which is used to sort the result. By default the sort order list is empty, thus no sorting will take place.

This function was introduced in Qt Mobility 1.1.

See also setSorting().