Класс QPlaceSearchRequest

Класс QPlaceSearchRequest представляет набор параметров для запроса поиска. Подробнее...

Этот класс был представлен в Qt 5.6.

• Список всех членов, включая унаследованные

Типы публичного доступа

Функции публичного доступа

Подробное описание

Типичный запрос поиска может выглядеть следующим образом:

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

Обратите внимание, что определение центра поиска может быть выполнено путем задания круговой области поиска, имеющей центр, но не радиус. Значение по умолчанию для радиуса равно -1, что указывает на неопределенный радиус. Провайдер интерпретирует это как свободу выбора собственного значения радиуса по умолчанию.

Класс QPlaceSearchRequest в основном используется с QPlaceManager для поиска мест, но также он используется для предоставления параметров для генерации предложений по поисковым запросам. Обратите внимание, что в этом контексте некоторые параметры могут быть нерелевантными. Например, область поиска полезна для сужения соответствующих предложений поиска, в то время как другие параметры, такие как подсказка релевантности, менее применимы.

Также следует учитывать, что провайдеры могут отличаться по поддерживаемым параметрам. Например, некоторые провайдеры могут не поддерживать постраничный вывод, в то время как другие поддерживают. Некоторые провайдеры могут учитывать подсказки релевантности, а другие могут их игнорировать. См. документацию по плагинам для получения дополнительной информации.

Документация по типам членов

Перечисление QPlaceSearchRequest::RelevanceHint

Определяет подсказки для сортировки результатов поиска мест.

Документация по функциям членов

QPlaceSearchRequest::QPlaceSearchRequest(const QPlaceSearchRequest &other)

Создает копию other.

QPlaceSearchRequest::QPlaceSearchRequest()

Конструктор по умолчанию. Создает новый объект запроса.

QPlaceSearchRequest &QPlaceSearchRequest::operator=(const QPlaceSearchRequest &other)

Присваивает other этому запросу поиска и возвращает ссылку на этот запрос поиска.

QPlaceSearchRequest::~QPlaceSearchRequest()

Удаляет объект запроса.

QList<QPlaceCategory> QPlaceSearchRequest::categories() const

Возвращает категории, используемые в запросе поиска. Места должны принадлежать только одной из категорий, чтобы считаться совпадением по запросу.

См. также setCategories().

void QPlaceSearchRequest::clear()

Очищает запрос поиска.

int QPlaceSearchRequest::limit() const

Возвращает максимальное количество результатов поиска.

Отрицательное значение для limit означает, что оно не определено. Провайдеру предоставляется право выбора подходящего количества возвращаемых результатов. Значение по умолчанию для limit равно -1.

См. также setLimit().

QString QPlaceSearchRequest::recommendationId() const

Возвращает идентификатор места, который будет использоваться для поиска рекомендаций по похожим местам.

См. также setRecommendationId().

QPlaceSearchRequest::RelevanceHint QPlaceSearchRequest::relevanceHint() const

Возвращает подсказку релевантности запроса. Подсказка предоставляется провайдеру, чтобы помочь, но не диктовать сортировку результатов. Например, предоставление подсказки расстояния может присвоить ближайшим местам более высокий рейтинг, но это не обязательно означает, что результаты будут отсортированы строго по расстоянию.

См. также setRelevanceHint().

QGeoShape QPlaceSearchRequest::searchArea() const

Возвращает область поиска, которая будет использоваться для ограничения результатов поиска. По умолчанию область поиска — недействительная QGeoShape, что означает, что никакая конкретная область поиска не определена.

См. также setSearchArea().

QVariant QPlaceSearchRequest::searchContext() const

Возвращает дополнительный контекст поиска, специфичный для бэкенда, связанный с этим запросом поиска места. Контекст поиска обычно устанавливается как часть предлагаемых результатов поиска.

См. также setSearchContext().

QString QPlaceSearchRequest::searchTerm() const

Возвращает поисковый запрос.

См. также setSearchTerm().

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

Устанавливает запрос поиска для поиска по списку указанных категорий. Любые возвращённые во время поиска места будут соответствовать по крайней мере одной из категорий.

См. также categories() и setCategory().

void QPlaceSearchRequest::setCategory(const QPlaceCategory &category)

Устанавливает запрос поиска для поиска по одной категории

См. также setCategories().

void QPlaceSearchRequest::setLimit(int limit)

Устанавливает максимальное количество результатов поиска на limit.

См. также limit().

void QPlaceSearchRequest::setRecommendationId(const QString &placeId)

Устанавливает placeId, который будет использоваться для поиска рекомендаций.

См. также recommendationId().

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

Устанавливает релевантность hint для использования при поиске места.

См. также relevanceHint().

void QPlaceSearchRequest::setSearchArea(const QGeoShape &area)

Устанавливает запрос поиска для поиска в заданной области.

См. также searchArea().

void QPlaceSearchRequest::setSearchContext(const QVariant &context)

Устанавливает контекст поиска в context.

Примечание: Этот метод предназначен для использования плагинами геосервисов при возвращении результатов поиска типа QPlaceSearchResult::ProposedSearchResult.

Контекст поиска используется бэкендами для хранения дополнительного контекста поиска, связанного с запросом поиска. Также должны быть заполнены другие соответствующие поля. Например, если контекст поиска кодирует текстовый поиск, поисковый запрос также должен быть задан с помощью setSearchTerm(). Контекст поиска позволяет сохранить дополнительный контекст поиска, который напрямую недоступен через API Qt Location.

Контекст поиска может быть любого типа, сохраняемого в QVariant. Значение контекста поиска не предназначено для прямого использования приложениями.

См. также searchContext().

void QPlaceSearchRequest::setSearchTerm(const QString &term)

Устанавливает поисковый термин.

См. также searchTerm().

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

Устанавливает область видимости scope, используемую при поиске мест.

См. также visibilityScope().

QLocation::VisibilityScope QPlaceSearchRequest::visibilityScope() const

Возвращает область видимости, используемую при поиске мест. Значение по умолчанию — QLocation::UnspecifiedVisibility, что означает, что явная область видимости не была назначена. При поиске могут быть возвращены места любой области видимости.

См. также setVisibilityScope().

bool QPlaceSearchRequest::operator!=(const QPlaceSearchRequest &other) const

Возвращает true, если other не равно этому запросу поиска, иначе возвращает false.

bool QPlaceSearchRequest::operator==(const QPlaceSearchRequest &other) const

Возвращает true, если other равно этому запросу поиска, иначе возвращает false.