En esta página

QPlaceSearchRequest Class

La clase `QPlaceSearchRequest` representa el conjunto de parámetros de una solicitud de búsqueda. Más información...

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

Tipos públicos

enum RelevanceHint { UnspecifiedHint, DistanceHint, LexicalPlaceNameHint }

Funciones públicas

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)

Descripción detallada

Una solicitud de búsqueda típica podría tener el siguiente aspecto:

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

Ten en cuenta que se puede especificar un centro de búsqueda definiendo un área de búsqueda circular que tenga un centro pero no un radio. El radio por defecto está establecido en -1, lo que indica un radio indefinido. El proveedor interpretará esto como que tiene libertad para elegir su propio radio por defecto.

La clase `QPlaceSearchRequest` se utiliza principalmente con ` QPlaceManager ` para ` search for places`, aunque también se emplea para proporcionar parámetros a ` generating search term suggestions`. Ten en cuenta que, en este contexto, es posible que solo algunos de los parámetros sean relevantes. Por ejemplo, el área de búsqueda resulta útil para filtrar las sugerencias de búsqueda relevantes, mientras que otros parámetros, como la indicación de relevancia, no son tan aplicables.

Ten en cuenta también que los proveedores pueden variar en cuanto a los parámetros que admiten; por ejemplo, algunos proveedores pueden no admitir la paginación, mientras que otros sí; algunos pueden tener en cuenta las indicaciones de relevancia, mientras que otros pueden ignorarlas por completo. Consulta la documentación del complemento para obtener más detalles.

Documentación sobre los tipos de miembro

enum QPlaceSearchRequest::RelevanceHint

Define indicaciones que ayudan a clasificar los resultados de los lugares.

ConstanteValorDescripción
QPlaceSearchRequest::UnspecifiedHint0No se ha especificado ninguna pista explícita.
QPlaceSearchRequest::DistanceHint1La distancia al centro de búsqueda es relevante para el usuario. Los lugares más cercanos tienen mayor peso. Esta indicación solo es útil si en la consulta se utiliza un área de búsqueda circular.
QPlaceSearchRequest::LexicalPlaceNameHint2El orden alfabético de los lugares según su nombre es relevante para el usuario.

Documentación de la función miembro

QPlaceSearchRequest::QPlaceSearchRequest()

Constructor por defecto. Crea un nuevo objeto de solicitud.

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

Crea una copia de other.

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

Crea una instancia de ` QPlaceSearchRequest` mediante la construcción por movimiento.

[noexcept] QPlaceSearchRequest::~QPlaceSearchRequest()

Elimina el objeto de solicitud.

QList<QPlaceCategory> QPlaceSearchRequest::categories() const

Devuelve las categorías que se utilizarán en la solicitud de búsqueda. Basta con que los lugares pertenezcan a una de las categorías para que la solicitud los considere coincidentes.

Véase también setCategories().

void QPlaceSearchRequest::clear()

Borra la consulta de búsqueda.

int QPlaceSearchRequest::limit() const

Devuelve el número máximo de resultados de búsqueda que se van a recuperar.

Un valor negativo para «limit» significa que no está definido. Se deja en manos del proveedor del backend la elección del número adecuado de resultados que se deben devolver. El límite por defecto es -1.

Véase también setLimit().

QString QPlaceSearchRequest::recommendationId() const

Devuelve el identificador del lugar, que se utilizará para buscar recomendaciones de lugares similares.

Véase también setRecommendationId().

QPlaceSearchRequest::RelevanceHint QPlaceSearchRequest::relevanceHint() const

Devuelve la indicación de relevancia de la solicitud. La indicación se proporciona al proveedor para ayudarle a establecer la clasificación de los resultados, pero sin imponerla. Por ejemplo, proporcionar una indicación de distancia puede hacer que los lugares más cercanos ocupen un puesto más alto en la clasificación, pero eso no significa necesariamente que los resultados se ordenen estrictamente según la distancia.

Véase también setRelevanceHint().

QGeoShape QPlaceSearchRequest::searchArea() const

Devuelve el área de búsqueda que se utilizará para limitar los resultados de la búsqueda. El área de búsqueda predeterminada es un QGeoShape no válido, lo que indica que no se ha definido ningún área de búsqueda específica.

Véase también setSearchArea().

QVariant QPlaceSearchRequest::searchContext() const

Devuelve el contexto de búsqueda adicional específico del backend asociado a esta solicitud de búsqueda de lugares. El contexto de búsqueda suele establecerse como parte de un proposed search results.

Véase también setSearchContext().

QString QPlaceSearchRequest::searchTerm() const

Devuelve el término de búsqueda.

Véase también setSearchTerm().

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

Establece la consulta de búsqueda para buscar en la lista proporcionada en categories. Cualquier lugar que se devuelva durante la búsqueda coincidirá con al menos uno de los que aparecen en categories.

Véanse también categories() y setCategory().

void QPlaceSearchRequest::setCategory(const QPlaceCategory &category)

Configura la solicitud de búsqueda para buscar por un único category

Véase también setCategories().

void QPlaceSearchRequest::setLimit(int limit)

Establece el número máximo de resultados de búsqueda que se van a recuperar en limit.

Véase también limit().

void QPlaceSearchRequest::setRecommendationId(const QString &placeId)

Establece el placeId que se utilizará para buscar recomendaciones.

Véase también recommendationId().

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

Establece la relevancia hint que se utilizará al buscar un lugar.

Véase también relevanceHint().

void QPlaceSearchRequest::setSearchArea(const QGeoShape &area)

Configura la solicitud de búsqueda para que se realice dentro del dominio area.

Véase también searchArea().

void QPlaceSearchRequest::setSearchContext(const QVariant &context)

Establece el contexto de búsqueda en context.

Nota: Este método está pensado para que lo utilicen los complementos de servicios geográficos al devolver resultados de búsqueda del tipo QPlaceSearchResult::ProposedSearchResult.

Los backends utilizan el contexto de búsqueda para almacenar información adicional relacionada con la solicitud de búsqueda. También deben rellenarse otros campos relevantes. Por ejemplo, si el contexto de búsqueda codifica una búsqueda de texto, el término de búsqueda también debe establecerse mediante ` setSearchTerm()`. El contexto de búsqueda permite conservar información adicional a la que no se puede acceder directamente a través de la API ` Qt Location `.

El contexto de búsqueda puede ser de cualquier tipo que se pueda almacenar en un ` QVariant`. El valor del contexto de búsqueda no está pensado para ser utilizado directamente por las aplicaciones.

Véase también searchContext().

void QPlaceSearchRequest::setSearchTerm(const QString &term)

Establece el term de búsqueda.

Véase también searchTerm().

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

Establece la visibilidad scope que se utiliza al buscar lugares.

Véase también visibilityScope().

QLocation::VisibilityScope QPlaceSearchRequest::visibilityScope() const

Devuelve el ámbito de visibilidad utilizado al buscar lugares. El valor por defecto es « QLocation::UnspecifiedVisibility », lo que significa que no se ha asignado ningún ámbito explícito. Durante la búsqueda pueden aparecer lugares de cualquier ámbito.

Véase también setVisibilityScope().

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

Asigna ` other ` a esta solicitud de búsqueda y devuelve una referencia a dicha solicitud.

Usuarios no miembros relacionados

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

Devuelve «true» si « lhs » no es igual a « rhs »; en caso contrario, devuelve «false».

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

Devuelve «true» si « lhs » es igual a « rhs »; en caso contrario, devuelve «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.