Detailed Description

QPlaceSearchRequest searchRequest;
searchRequest.setSearchTerm("Fast food"); //search term for what we are interested in//set a search center
searchRequest.setSearchArea(QGeoCircle(QGeoCoordinate(2.3,48.87)));
//set a distance hint as a relevancy hint.//closer places have greater weighting in the ranking of results.
searchRequest.setRelevanceHint(QPlaceSearchRequest::DistanceHint);
//use limit to adjust pagination.//this limits the number of place results to 5 per page.
searchRequest.setLimit(5);
//provide some categories to narrow down searchQList<QPlaceCategory> categories;
categories << diner << restaurant;
searchRequest.setCategories(categories);

Note that specifying a search center can be done by setting a circular search area that has a center but no radius. The default radius is set to -1, which indicates an undefined radius. The provider will interpret this as being free to choose its own default radius.

Also be aware that providers may vary by which parameters they support for example some providers may not support paging while others do, some providers may honor relevance hints while others may completely ignore them, see the plugin documentation for more details.

Member Type Documentation

enum QPlaceSearchRequest::RelevanceHint

Defines hints to help rank place results.

Constant

Value

Description

QPlaceSearchRequest::UnspecifiedHint

0

No explicit hint has been specified.

QPlaceSearchRequest::DistanceHint

1

Distance to a search center is relevant for the user. Closer places are more highly weighted. This hint is only useful if a circular search area is used in the query.

QPlaceSearchRequest::LexicalPlaceNameHint

2

Alphabetic ordering of places according to name is relevant to the user.

Returns the relevance hint of the request. The hint is given to the provider to help but not dictate the ranking of results. For example providing a distance hint may give closer places a higher ranking but it doesn't necessarily mean that he results will be ordered strictly according to distance.

The search context is used by backends to store additional search context related to the search request. Other relevant fields should also be filled in. For example, if the search context encodes a text search the search term should also be set with setSearchTerm(). The search context allows additional search context to be kept which is not directly accessible via the Qt Location API.

The search context can be of any type storable in a QVariant. The value of the search context is not intended to be use directly by applications.

Returns the visibility scope used when searching for places. The default value is QLocation::UnspecifiedVisibility meaning that no explicit scope has been assigned. Places of any scope may be returned during the search.