QPlaceSearchRequest Class

Die Klasse QPlaceSearchRequest repräsentiert den Satz von Parametern für eine Suchanfrage. Mehr...

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

Öffentliche Typen

enum RelevanceHint { UnspecifiedHint, DistanceHint, LexicalPlaceNameHint }

Öffentliche Funktionen

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)
bool operator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)
bool operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)

Detaillierte Beschreibung

Eine typische Suchanfrage kann wie folgt aussehen:

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);

Beachten Sie, dass Sie ein Suchzentrum angeben können, indem Sie einen kreisförmigen Suchbereich festlegen, der einen Mittelpunkt, aber keinen Radius hat. Der Standardradius ist auf -1 gesetzt, was einen undefinierten Radius bedeutet. Der Anbieter interpretiert dies so, dass er seinen eigenen Standardradius frei wählen kann.

QPlaceSearchRequest wird in erster Linie mit QPlaceManager bis search for places verwendet, dient aber auch zur Bereitstellung von Parametern für generating search term suggestions. Beachten Sie, dass in diesem Zusammenhang nur einige der Parameter relevant sein können. Beispielsweise ist der Suchbereich nützlich, um relevante Suchvorschläge einzugrenzen, während andere Parameter wie der Relevanz-Hinweis nicht so anwendbar sind.

Beachten Sie auch, dass sich die Anbieter darin unterscheiden können, welche Parameter sie unterstützen, z. B. unterstützen einige Anbieter kein Paging, während andere dies tun, und einige Anbieter berücksichtigen Relevanzhinweise, während andere sie vollständig ignorieren. Weitere Einzelheiten finden Sie in der Plugin-Dokumentation.

Dokumentation der Mitgliedstypen

enum QPlaceSearchRequest::RelevanceHint

Definiert Hinweise, um die Platzierung von Ergebnissen zu erleichtern.

KonstanteWertBeschreibung
QPlaceSearchRequest::UnspecifiedHint0Es wurde kein expliziter Hinweis angegeben.
QPlaceSearchRequest::DistanceHint1Die Entfernung zu einem Suchzentrum ist für den Benutzer relevant. Näher gelegene Orte werden höher gewichtet. Dieser Hinweis ist nur sinnvoll, wenn ein kreisförmiger Suchbereich in der Anfrage verwendet wird.
QPlaceSearchRequest::LexicalPlaceNameHint2Alphabetische Sortierung der Orte nach dem Namen ist für den Benutzer relevant.

Dokumentation der Mitgliederfunktionen

QPlaceSearchRequest::QPlaceSearchRequest()

Standard-Konstruktor. Konstruiert ein neues Anfrageobjekt.

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

Konstruiert eine Kopie von other.

[noexcept] QPlaceSearchRequest::~QPlaceSearchRequest()

Zerstört das Anfrageobjekt.

QList<QPlaceCategory> QPlaceSearchRequest::categories() const

Gibt die Kategorien zurück, die in der Suchanfrage verwendet werden sollen. Die Orte müssen nur zu einer der Kategorien gehören, damit die Anfrage als übereinstimmend betrachtet wird.

Siehe auch setCategories().

void QPlaceSearchRequest::clear()

Löscht die Suchanfrage.

int QPlaceSearchRequest::limit() const

Gibt die maximale Anzahl der abzurufenden Suchergebnisse zurück.

Ein negativer Wert für limit bedeutet, dass er nicht definiert ist. Es bleibt dem Backend-Anbieter überlassen, eine angemessene Anzahl von Ergebnissen auszuwählen, die zurückgegeben werden sollen. Der Standardwert für limit ist -1.

Siehe auch setLimit().

QString QPlaceSearchRequest::recommendationId() const

Gibt die Ortskennung zurück, die für die Suche nach Empfehlungen für ähnliche Orte verwendet wird.

Siehe auch setRecommendationId().

QPlaceSearchRequest::RelevanceHint QPlaceSearchRequest::relevanceHint() const

Gibt den Relevanz-Hinweis der Anfrage zurück. Der Hinweis wird dem Anbieter gegeben, um die Rangfolge der Ergebnisse zu unterstützen, aber nicht zu diktieren. Ein Hinweis auf die Entfernung kann beispielsweise dazu führen, dass näher gelegene Orte eine höhere Rangfolge erhalten, bedeutet aber nicht unbedingt, dass die Ergebnisse streng nach der Entfernung geordnet werden.

Siehe auch setRelevanceHint().

QGeoShape QPlaceSearchRequest::searchArea() const

Gibt den Suchbereich zurück, der zur Einschränkung der Suchergebnisse verwendet wird. Der Standardsuchbereich ist ein ungültiger QGeoShape, der anzeigt, dass kein bestimmter Suchbereich definiert ist.

Siehe auch setSearchArea().

QVariant QPlaceSearchRequest::searchContext() const

Gibt den Backend-spezifischen zusätzlichen Suchkontext zurück, der mit dieser Ortssuchanfrage verbunden ist. Der Suchkontext wird normalerweise als Teil einer proposed search results gesetzt.

Siehe auch setSearchContext().

QString QPlaceSearchRequest::searchTerm() const

Gibt den Suchbegriff zurück.

Siehe auch setSearchTerm().

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

Legt fest, dass die Suchanfrage in der Liste der angegebenen categories gesucht wird. Alle Orte, die bei der Suche zurückgegeben werden, müssen mit mindestens einem der categories übereinstimmen.

Siehe auch categories() und setCategory().

void QPlaceSearchRequest::setCategory(const QPlaceCategory &category)

Setzt die Suchanfrage auf die Suche nach einem einzelnen category

Siehe auch setCategories().

void QPlaceSearchRequest::setLimit(int limit)

Setzen Sie die maximale Anzahl der abzurufenden Suchergebnisse auf limit.

Siehe auch limit().

void QPlaceSearchRequest::setRecommendationId(const QString &placeId)

Legt die placeId fest, die für die Suche nach Empfehlungen verwendet wird.

Siehe auch recommendationId().

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

Legt die Relevanz hint fest, die bei der Suche nach einem Ort verwendet werden soll.

Siehe auch relevanceHint().

void QPlaceSearchRequest::setSearchArea(const QGeoShape &area)

Stellt die Suchanfrage so ein, dass innerhalb der angegebenen area gesucht wird.

Siehe auch searchArea().

void QPlaceSearchRequest::setSearchContext(const QVariant &context)

Setzt den Suchkontext auf context.

Hinweis: Diese Methode soll von Geodienst-Plugins verwendet werden, wenn sie Suchergebnisse des Typs QPlaceSearchResult::ProposedSearchResult zurückgeben.

Der Suchkontext wird von Backends verwendet, um zusätzlichen Suchkontext im Zusammenhang mit der Suchanfrage zu speichern. Andere relevante Felder sollten ebenfalls ausgefüllt werden. Wenn der Suchkontext zum Beispiel eine Textsuche kodiert, sollte der Suchbegriff auch mit setSearchTerm() angegeben werden. Der Suchkontext ermöglicht die Speicherung von zusätzlichem Suchkontext, der nicht direkt über die Qt Location API zugänglich ist.

Der Suchkontext kann von jedem Typ sein, der in einer QVariant gespeichert werden kann. Der Wert des Suchkontextes ist nicht zur direkten Verwendung durch Anwendungen gedacht.

Siehe auch searchContext().

void QPlaceSearchRequest::setSearchTerm(const QString &term)

Legt die Suche term fest.

Siehe auch searchTerm().

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

Legt die Sichtbarkeit scope fest, die bei der Suche nach Orten verwendet wird.

Siehe auch visibilityScope().

QLocation::VisibilityScope QPlaceSearchRequest::visibilityScope() const

Gibt den Sichtbarkeitsbereich zurück, der bei der Suche nach Orten verwendet wird. Der Standardwert ist QLocation::UnspecifiedVisibility, was bedeutet, dass kein expliziter Bereich zugewiesen wurde. Bei der Suche können Orte mit beliebigem Geltungsbereich zurückgegeben werden.

Siehe auch setVisibilityScope().

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

Weist other dieser Suchanfrage zu und gibt einen Verweis auf diese Suchanfrage zurück.

Verwandte Nicht-Mitglieder

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

Gibt true zurück, wenn lhs nicht gleich rhs ist, andernfalls wird false zurückgegeben.

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

Gibt true zurück, wenn lhs gleich rhs ist, andernfalls wird false zurückgegeben.

© 2025 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.