PySide6.QtLocation.QPlaceSearchRequest¶

class QPlaceSearchRequest¶

The QPlaceSearchRequest class represents the set of parameters for a search request. More…

Synopsis¶

Methods¶

def __init__()
def categories()
def clear()
def limit()
def __ne__()
def __eq__()
def recommendationId()
def relevanceHint()
def searchArea()
def searchContext()
def searchTerm()
def setCategories()
def setCategory()
def setLimit()
def setRecommendationId()
def setRelevanceHint()
def setSearchArea()
def setSearchContext()
def setSearchTerm()
def swap()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

A typical search request may look like the following:

        searchRequest = QPlaceSearchRequest()
        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 search
categories = QList()
        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.

The QPlaceSearchRequest is primarily used with the QPlaceManager to search for places , however it is also used to provide parameters for generating search term suggestions . Note that in this context only some of the parameters may be relevant. For example, the search area is useful in narrowing down relevant search suggestions, while other parameters such as relevance hint are not so applicable.

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.

class RelevanceHint¶

Defines hints to help rank place results.

Constant

Description

QPlaceSearchRequest.UnspecifiedHint

No explicit hint has been specified.

QPlaceSearchRequest.DistanceHint

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

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

Constant	Description
QPlaceSearchRequest.UnspecifiedHint	No explicit hint has been specified.
QPlaceSearchRequest.DistanceHint	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	Alphabetic ordering of places according to name is relevant to the user.

__init__()¶

Default constructor. Constructs an new request object.

__init__(other)

Parameters:: other – QPlaceSearchRequest

Constructs a copy of other.

categories()¶

Return type:: .list of QPlaceCategory

Return the categories to be used in the search request. Places need only to belong to one of the categories to be considered a match by the request.

See also

setCategories()

clear()¶

Clears the search request.

limit()¶

Return type:: int

Returns the maximum number of search results to retrieve.

A negative value for limit means that it is undefined. It is left up to the backend provider to choose an appropriate number of results to return. The default limit is -1.

See also

setLimit()

__ne__(rhs)¶

Parameters:: rhs – QPlaceSearchRequest
Return type:: bool

Returns true if lhs is not equal to rhs, otherwise returns false.

__eq__(rhs)¶

Parameters:: rhs – QPlaceSearchRequest
Return type:: bool

Returns true if lhs is equal to rhs, otherwise returns false.

recommendationId()¶

Return type:: str

Returns the place id which will be used to search for recommendations for similar places.

See also

setRecommendationId()

relevanceHint()¶

Return type:: RelevanceHint

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.

See also

setRelevanceHint()

searchArea()¶

Return type:: QGeoShape

Returns the search area which will be used to limit search results. The default search area is an invalid QGeoShape, indicating that no specific search area is defined.

See also

setSearchArea()

searchContext()¶

Return type:: object

Returns backend specific additional search context associated with this place search request. The search context is typically set as part of a proposed search results .

See also

setSearchContext()

searchTerm()¶

Return type:: str

Returns the search term.

See also

setSearchTerm()

setCategories(categories)¶

Parameters:: categories – .list of QPlaceCategory

Sets the search request to search from the list of given categories. Any places returned during the search will match at least one of the categories.

See also

categories() setCategory()

setCategory(category)¶

Parameters:: category – QPlaceCategory

Sets the search request to search by a single category

See also

setCategories()

setLimit(limit)¶

Parameters:: limit – int

Set the maximum number of search results to retrieve to limit.

See also

limit()

setRecommendationId(recommendationId)¶

Parameters:: recommendationId – str

Sets the placeId which will be used to search for recommendations.

See also

recommendationId()

setRelevanceHint(hint)¶

Parameters:: hint – RelevanceHint

Sets the relevance hint to be used when searching for a place.

See also

relevanceHint()

setSearchArea(area)¶

Parameters:: area – QGeoShape

Sets the search request to search within the given area.

See also

searchArea()

setSearchContext(context)¶

Parameters:: context – object

Sets the search context to context.

Note

This method is intended to be used by geo service plugins when returning search results of type ProposedSearchResult .

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.

See also

searchContext()

setSearchTerm(term)¶

Parameters:: term – str

Sets the search term.

See also

searchTerm()

swap(other)¶

Parameters:: other – QPlaceSearchRequest