Detailed Description
The QLandmarkIdFetchRequest class allows a client to asynchronously request a list of landmark identifiers from a landmark manager.
For a QLandmarkIdFetchRequest, the resultsAvailable() signal will be emitted when the resultant identifiers (which may be retrieved by calling landmarkIds()), are updated, as well as if the overall operation error (which may be retrieved by calling error()) is updated.
Please see the class documentation for QLandmarkAbstractRequest for more information about the usage of request classes and ownership semantics.
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.
See also setFilter().
QList<QLandmarkId> QLandmarkIdFetchRequest::landmarkIds () const
Returns the list of identifiers of landmarks which matched the filter.
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.
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).
See also setOffset().
void QLandmarkIdFetchRequest::setFilter ( const QLandmarkFilter & filter )
Sets the filter which will be used to select landmark identifiers.
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.)
See also limit().
void QLandmarkIdFetchRequest::setOffset ( int offset )
Sets the index offset for the request.
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().
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().
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.
See also setSorting().
