Detailed Description
The QLandmarkFetchRequest class allows a client to asynchronously request a list of landmarks from a landmark manager.
For a QLandmarkFetchRequest, the resultsAvailable() signal will be emitted when the resultant landmarks (which may be retrieved by calling landmarks()) 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
QLandmarkFetchRequest::QLandmarkFetchRequest ( QLandmarkManager * manager, QObject * parent = 0 )
Creates a new landmark fetch request object with the given manager parent.
QLandmarkFetchRequest::~QLandmarkFetchRequest ()
Destroys the request object.
QLandmarkFilter QLandmarkFetchRequest::filter () const
Returns the filter which will be used to select the landmarks.
By default, the filter's type will be a QLandmarkFilter::DefaultFilter and thus match all landmarks.
See also setFilter().
QList<QLandmark> QLandmarkFetchRequest::landmarks () const
Returns the list of landmarks which matched the filter.
int QLandmarkFetchRequest::limit () const
Returns the maximum number of landmarks to be returned. By default the limit is -1 indicating that all landmarks matching the filter sould be retrieved.
See also setLimit().
int QLandmarkFetchRequest::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 to 7th landmarks inclusively. (The order of the landmarks is specified by the sorting field).
See also setOffset().
void QLandmarkFetchRequest::setFilter ( const QLandmarkFilter & filter )
Sets the filter which will be used to select landmarks.
See also filter().
void QLandmarkFetchRequest::setLimit ( int limit )
Sets the maximum number of landmarks to be returned to limit.
A limit of -1 will retrieve all landmarks that match the filter.
(A limit of 0 will retrieve no landmarks.)
See also limit().
void QLandmarkFetchRequest::setOffset ( int offset )
Sets the index offset for the request.
See also offset().
void QLandmarkFetchRequest::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 QLandmarkFetchRequest::setSorting ( const QLandmarkSortOrder & sorting )
Convenience function which sets the sort ordering of the request to a single sorting. This function will only have an effect on 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().
