QPlaceSearchRequest Class
La classe QPlaceSearchRequest représente l'ensemble des paramètres d'une demande de recherche. Plus d'informations...
| Header: | #include <QPlaceSearchRequest> |
| qmake: | QT += location |
Types publics
| enum | RelevanceHint { UnspecifiedHint, DistanceHint, LexicalPlaceNameHint } |
Fonctions publiques
| QPlaceSearchRequest() | |
| QPlaceSearchRequest(const 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) |
Non-membres apparentés
| bool | operator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs) |
| bool | operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs) |
Description détaillée
Une demande de recherche typique peut ressembler à ce qui 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 ayant un centre mais pas de rayon. Le rayon par défaut est fixé à -1, ce qui indique un rayon non défini. Le fournisseur interprétera cela comme étant libre de choisir son propre rayon par défaut.
Le QPlaceSearchRequest est principalement utilisé avec les QPlaceManager à search for places, mais il est également utilisé pour fournir des paramètres à generating search term suggestions. Il convient de noter que dans ce contexte, seuls certains des paramètres peuvent être pertinents. Par exemple, la zone de recherche est utile pour restreindre les suggestions de recherche pertinentes, tandis que d'autres paramètres, tels que l'indice de pertinence, ne le sont pas.
Sachez également que les paramètres pris en charge par les fournisseurs peuvent varier. Par exemple, certains fournisseurs ne prennent pas en charge la pagination alors que d'autres le font, certains fournisseurs prennent en compte les indices de pertinence alors que d'autres les ignorent complètement, voir la documentation du plugin pour plus de détails.
Documentation sur les types de membres
enum QPlaceSearchRequest::RelevanceHint
Définit des conseils pour aider à classer les résultats.
| Constante | Valeur | Description |
|---|---|---|
QPlaceSearchRequest::UnspecifiedHint | 0 | Aucun indice explicite n'a été spécifié. |
QPlaceSearchRequest::DistanceHint | 1 | La distance par rapport à un centre de recherche est importante pour l'utilisateur. Les lieux les plus proches sont mieux pondérés. Cet indice n'est utile que si une zone de recherche circulaire est utilisée dans la requête. |
QPlaceSearchRequest::LexicalPlaceNameHint | 2 | L'ordre alphabétique des lieux en fonction de leur nom est pertinent pour l'utilisateur. |
Documentation des fonctions membres
QPlaceSearchRequest::QPlaceSearchRequest()
Constructeur par défaut. Construit un nouvel objet de requête.
[noexcept] QPlaceSearchRequest::QPlaceSearchRequest(const QPlaceSearchRequest &other)
Construit une copie de other.
[noexcept] QPlaceSearchRequest::~QPlaceSearchRequest()
Détruit l'objet de la demande.
QList<QPlaceCategory> QPlaceSearchRequest::categories() const
Renvoie les catégories à utiliser dans la demande de recherche. Il suffit que les lieux appartiennent à l'une des catégories pour que la requête soit considérée comme correspondante.
Voir aussi setCategories().
void QPlaceSearchRequest::clear()
Efface la demande de recherche.
int QPlaceSearchRequest::limit() const
Renvoie le nombre maximum de résultats de recherche à extraire.
Une valeur négative pour limite signifie qu'elle n'est pas définie. C'est au fournisseur du backend de choisir le nombre approprié de résultats à renvoyer. La limite par défaut est -1.
Voir aussi setLimit().
QString QPlaceSearchRequest::recommendationId() const
Renvoie l'identifiant du lieu qui sera utilisé pour rechercher des recommandations pour des lieux similaires.
Voir aussi setRecommendationId().
QPlaceSearchRequest::RelevanceHint QPlaceSearchRequest::relevanceHint() const
Renvoie l'indice de pertinence de la demande. L'indice est donné au fournisseur pour l'aider à classer les résultats, mais il ne lui est pas imposé. Par exemple, l'indication de la distance peut permettre de mieux classer les 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 la recherche. La zone de recherche par défaut est un QGeoShape invalide, indiquant 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 demande de recherche de lieu. Le contexte de recherche est généralement défini dans le cadre d'une proposed search results.
Voir aussi setSearchContext().
QString QPlaceSearchRequest::searchTerm() const
Renvoie le terme de recherche.
Voir aussi setSearchTerm().
void QPlaceSearchRequest::setCategories(const QList<QPlaceCategory> &categories)
Définit la requête de recherche à partir de la liste de categories. Tous les lieux renvoyés au cours de la recherche doivent correspondre à au moins un des categories.
Voir aussi categories() et setCategory().
void QPlaceSearchRequest::setCategory(const QPlaceCategory &category)
Définit la demande de recherche en fonction d'un seul critère. category
Voir aussi setCategories().
void QPlaceSearchRequest::setLimit(int limit)
Définissez le nombre maximum de résultats de recherche à extraire sur limit.
Voir aussi limit().
void QPlaceSearchRequest::setRecommendationId(const QString &placeId)
Définit le site placeId qui sera utilisé pour rechercher des recommandations.
Voir également recommendationId().
void QPlaceSearchRequest::setRelevanceHint(QPlaceSearchRequest::RelevanceHint hint)
Définit la pertinence hint à utiliser lors de la recherche d'un lieu.
Voir également relevanceHint().
void QPlaceSearchRequest::setSearchArea(const QGeoShape &area)
Définit la demande de recherche à l'intérieur de l'adresse area.
Voir aussi searchArea().
void QPlaceSearchRequest::setSearchContext(const QVariant &context)
Définit le contexte de recherche à context.
Remarque : cette méthode est destinée à être utilisée par les plugins de services géographiques lorsqu'ils renvoient des résultats de recherche de type QPlaceSearchResult::ProposedSearchResult.
Le contexte de recherche est utilisé par les backends pour stocker un contexte de recherche supplémentaire lié à la demande de recherche. D'autres champs pertinents doivent également être remplis. 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 un contexte de recherche supplémentaire qui n'est pas directement accessible via l'API Qt Location.
Le contexte de recherche peut être de n'importe quel type stocké dans un fichier 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 la recherche term.
Voir aussi searchTerm().
void QPlaceSearchRequest::setVisibilityScope(QLocation::VisibilityScope scope)
Définit la visibilité scope utilisée lors de la recherche de lieux.
Voir aussi visibilityScope().
QLocation::VisibilityScope QPlaceSearchRequest::visibilityScope() const
Renvoie l'étendue de la visibilité utilisée lors de la recherche de lieux. La valeur par défaut est QLocation::UnspecifiedVisibility, ce qui signifie qu'aucune portée explicite n'a été attribuée. Des lieux de n'importe quelle portée peuvent être renvoyés lors de la recherche.
Voir aussi setVisibilityScope().
[noexcept] QPlaceSearchRequest &QPlaceSearchRequest::operator=(const QPlaceSearchRequest &other)
Attribue other à cette demande de recherche et renvoie une référence à cette demande de recherche.
Non-membres apparentés
[noexcept] bool operator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)
Retourne vrai si lhs n'est pas égal à rhs, sinon retourne faux.
[noexcept] bool operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)
Retourne vrai si lhs est égal à rhs, sinon retourne faux.
© 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.