Sur cette page

QPlaceSearchRequest Class

La classe `QPlaceSearchRequest` représente l'ensemble des paramètres d'une requête de recherche. En savoir plus...

Header: #include <QPlaceSearchRequest>
qmake: QT += location

Types publics

enum RelevanceHint { UnspecifiedHint, DistanceHint, LexicalPlaceNameHint }

Fonctions publiques

QPlaceSearchRequest()
QPlaceSearchRequest(const QPlaceSearchRequest &other)
QPlaceSearchRequest(QPlaceSearchRequest &&other)
~QPlaceSearchRequest()
QList<QPlaceCategory> categories() const
void clear()
int limit() const
QString recommendationId() const
QPlaceSearchRequest::RelevanceHint relevanceHint() const
QGeoShape searchArea() const
QVariant searchContext() const
QString searchTerm() const
void setCategories(const QList<QPlaceCategory> &categories)
void setCategory(const QPlaceCategory &category)
void setLimit(int limit)
void setRecommendationId(const QString &placeId)
void setRelevanceHint(QPlaceSearchRequest::RelevanceHint hint)
void setSearchArea(const QGeoShape &area)
void setSearchContext(const QVariant &context)
void setSearchTerm(const QString &term)
void setVisibilityScope(QLocation::VisibilityScope scope)
QLocation::VisibilityScope visibilityScope() const
QPlaceSearchRequest &operator=(const QPlaceSearchRequest &other)
bool operator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)
bool operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)

Description détaillée

Une requête de recherche typique peut se présenter comme suit :

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 search
QList<QPlaceCategory> categories;
categories << diner << restaurant;
searchRequest.setCategories(categories);

Notez que la spécification d’un centre de recherche peut se faire en définissant une zone de recherche circulaire dotée d’un centre mais sans rayon. Le rayon par défaut est défini sur -1, ce qui indique un rayon indéfini. Le fournisseur interprétera cela comme une liberté de choisir son propre rayon par défaut.

L'objet `QPlaceSearchRequest` est principalement utilisé avec la méthode ` QPlaceManager ` vers search for places, mais il sert également à fournir des paramètres à la méthode ` generating search term suggestions`. Notez que dans ce contexte, seuls certains paramètres peuvent être pertinents. Par exemple, la zone de recherche est utile pour affiner les suggestions de recherche pertinentes, tandis que d'autres paramètres, tels que les indications de pertinence, ne sont pas vraiment applicables.

Sachez également que les fournisseurs peuvent varier en fonction des paramètres qu’ils prennent en charge : par exemple, certains fournisseurs peuvent ne pas prendre en charge la pagination alors que d’autres le font, certains peuvent tenir compte des indications de pertinence tandis que d’autres peuvent les ignorer complètement. Consultez la documentation du plugin pour plus de détails.

Documentation sur les types de membres

enum QPlaceSearchRequest::RelevanceHint

Définit des indications permettant de classer les résultats par lieu.

ConstanteValeurDescription
QPlaceSearchRequest::UnspecifiedHint0Aucun indice explicite n’a été spécifié.
QPlaceSearchRequest::DistanceHint1La distance par rapport à un centre de recherche est pertinente pour l'utilisateur. Les lieux les plus proches sont mieux classés. Cette indication n'est utile que si une zone de recherche circulaire est utilisée dans la requête.
QPlaceSearchRequest::LexicalPlaceNameHint2Le classement alphabétique des lieux en fonction de leur nom est pertinent pour l'utilisateur.

Documentation des fonctions membres

QPlaceSearchRequest::QPlaceSearchRequest()

Constructeur par défaut. Crée un nouvel objet « request ».

[noexcept] QPlaceSearchRequest::QPlaceSearchRequest(const QPlaceSearchRequest &other)

Crée une copie de other.

[constexpr noexcept default] QPlaceSearchRequest::QPlaceSearchRequest(QPlaceSearchRequest &&other)

Crée par « move » une instance de ` QPlaceSearchRequest`.

[noexcept] QPlaceSearchRequest::~QPlaceSearchRequest()

Supprime l'objet de requête.

QList<QPlaceCategory> QPlaceSearchRequest::categories() const

Renvoie les catégories à utiliser dans la requête de recherche. Il suffit qu'un lieu appartienne à l'une de ces catégories pour être considéré comme correspondant à la requête.

Voir également setCategories().

void QPlaceSearchRequest::clear()

Efface la requête de recherche.

int QPlaceSearchRequest::limit() const

Renvoie le nombre maximal de résultats de recherche à récupérer.

Une valeur négative pour « limit » signifie que ce paramètre n'est pas défini. Il appartient au fournisseur du backend de choisir un nombre approprié de résultats à renvoyer. La limite par défaut est -1.

Voir également setLimit().

QString QPlaceSearchRequest::recommendationId() const

Renvoie l'identifiant du lieu qui sera utilisé pour rechercher des recommandations de lieux similaires.

Voir également setRecommendationId().

QPlaceSearchRequest::RelevanceHint QPlaceSearchRequest::relevanceHint() const

Renvoie l'indicateur de pertinence de la requête. Cet indicateur est fourni au fournisseur afin de l'aider à établir le classement des résultats, sans toutefois l'imposer. Par exemple, fournir un indicateur de distance peut attribuer un meilleur classement aux lieux les plus proches, mais cela ne signifie pas nécessairement que les résultats seront classés strictement en fonction de la distance.

Voir également setRelevanceHint().

QGeoShape QPlaceSearchRequest::searchArea() const

Renvoie la zone de recherche qui sera utilisée pour limiter les résultats de recherche. La zone de recherche par défaut est une valeur non valide de type QGeoShape, ce qui indique qu’aucune zone de recherche spécifique n’est définie.

Voir également setSearchArea().

QVariant QPlaceSearchRequest::searchContext() const

Renvoie le contexte de recherche supplémentaire spécifique au backend associé à cette requête de recherche de lieu. Le contexte de recherche est généralement défini dans le cadre d'une requête de recherche de lieu ( proposed search results).

Voir également setSearchContext().

QString QPlaceSearchRequest::searchTerm() const

Renvoie le terme recherché.

Voir aussi setSearchTerm().

void QPlaceSearchRequest::setCategories(const QList<QPlaceCategory> &categories)

Configure la requête de recherche pour effectuer une recherche dans la liste des categories fournie. Tous les lieux renvoyés lors de la recherche correspondront à au moins l'un des categories.

Voir également categories() et setCategory().

void QPlaceSearchRequest::setCategory(const QPlaceCategory &category)

Définit la requête de recherche pour effectuer une recherche à partir d’un seul category

Voir aussi setCategories().

void QPlaceSearchRequest::setLimit(int limit)

Définissez le nombre maximal de résultats de recherche à afficher sur limit.

Voir également limit().

void QPlaceSearchRequest::setRecommendationId(const QString &placeId)

Définit l'placeId qui sera utilisé pour rechercher des recommandations.

Voir aussi recommendationId().

void QPlaceSearchRequest::setRelevanceHint(QPlaceSearchRequest::RelevanceHint hint)

Définit l'hint de pertinence à utiliser lors de la recherche d'un lieu.

Voir aussi relevanceHint().

void QPlaceSearchRequest::setSearchArea(const QGeoShape &area)

Configure la requête de recherche pour qu'elle porte sur le site area.

Voir également searchArea().

void QPlaceSearchRequest::setSearchContext(const QVariant &context)

Définit le contexte de recherche sur context.

Remarque : cette méthode est destinée à être utilisée par les plugins de services géographiques lors du renvoi de résultats de recherche de type QPlaceSearchResult::ProposedSearchResult.

Le contexte de recherche est utilisé par les backends pour stocker des informations supplémentaires liées à la requête de recherche. D’autres champs pertinents doivent également être renseignés. Par exemple, si le contexte de recherche encode une recherche textuelle, le terme de recherche doit également être défini à l’aide de setSearchTerm(). Le contexte de recherche permet de conserver des informations supplémentaires qui ne sont pas directement accessibles via l’API Qt Location.

Le contexte de recherche peut être de n’importe quel type pouvant être stocké dans un QVariant. La valeur du contexte de recherche n’est pas destinée à être utilisée directement par les applications.

Voir également searchContext().

void QPlaceSearchRequest::setSearchTerm(const QString &term)

Définit l'term s de recherche.

Voir également searchTerm().

void QPlaceSearchRequest::setVisibilityScope(QLocation::VisibilityScope scope)

Définit l'scope de visibilité utilisée lors de la recherche de lieux.

Voir aussi visibilityScope().

QLocation::VisibilityScope QPlaceSearchRequest::visibilityScope() const

Renvoie la portée de visibilité utilisée lors de la recherche de lieux. La valeur par défaut est « QLocation::UnspecifiedVisibility », ce qui signifie qu'aucune portée n'a été explicitement attribuée. La recherche peut renvoyer des lieux de n'importe quelle portée.

Voir également setVisibilityScope().

[noexcept] QPlaceSearchRequest &QPlaceSearchRequest::operator=(const QPlaceSearchRequest &other)

Attribue la variable ` other ` à cette requête de recherche et renvoie une référence à celle-ci.

Personnes non membres associées

[noexcept] bool operator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)

Renvoie « true » si lhs n'est pas égal à rhs; sinon, renvoie « false ».

[noexcept] bool operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)

Renvoie « true » si lhs est égal à rhs; sinon, renvoie « false ».

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.