Класс QPlaceSearchRequest

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

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

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

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

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

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

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

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

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

QPlaceSearchRequest::QPlaceSearchRequest(const QPlaceSearchRequest &other)

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

QPlaceSearchRequest::~QPlaceSearchRequest()

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

QList<QPlaceCategory> QPlaceSearchRequest::categories() const

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

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

void QPlaceSearchRequest::clear()

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

int QPlaceSearchRequest::limit() const

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

Отрицательное значение для limit означает, что оно не определено. Зависит от провайдера backend, выбрать подходящее количество результатов для возврата. Значение по умолчанию для 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. Любые возвращённые во время поиска места будут соответствовать хотя бы одной из categories.

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

void QPlaceSearchRequest::setCategory(const QPlaceCategory &category)

Устанавливает запрос поиска для поиска по одному 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)

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

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

void QPlaceSearchRequest::setSearchContext(const QVariant &context)

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

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

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

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

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

void QPlaceSearchRequest::setSearchTerm(const QString &term)

Устанавливает поисковый 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.

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

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

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

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