Тип PlaceSearchSuggestionModel QML

Предоставляет доступ к предложениям по поисковым запросам. Подробнее...

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

Свойства

• limit : int
• offset : int
• plugin : Модуль
• searchArea : geoshape
• searchTerm : строка
• status : перечисление
• suggestions : stringlist

Методы

• void cancel()
• string errorString()
• void reset()
• void update()

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

Модель PlaceSearchSuggestionModel может использоваться для предоставления предложений по поисковым запросам по мере ввода пользователем своего поискового запроса. Свойства этой модели должны соответствовать свойствам модели PlaceSearchModel, которая будет использоваться для выполнения фактического поискового запроса, чтобы гарантировать, что результаты предложений по поиску релевантны.

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

Свойства offset и limit могут использоваться для доступа к странированным предложениям. Когда свойства offset и limit установлены, будут возвращены предложения между offset и (offset + limit - 1). Поддержка постраничного отображения может различаться в зависимости от модуля.

Модель возвращает данные для следующих ролей:

Следующий пример показывает, как использовать модель PlaceSearchSuggestionModel для получения предложенных поисковых запросов из частичного поискового запроса. Свойство searchArea устанавливается для соответствия тому, что использовалось бы для выполнения фактического поиска места с помощью PlaceSearchModel.

import QtQuick 2.0
import QtPositioning 5.5
import QtLocation 5.6

PlaceSearchSuggestionModel {
    id: suggestionModel

    plugin: myPlugin

    // Brisbane
    searchArea: QtPositioning.circle(QtPositioning.coordinate(-27.46778, 153.02778))

    onSearchTermChanged: update()
}

ListView {
    model: suggestionModel
    delegate: Text { text: suggestion }
}

См. также PlaceSearchModel и QPlaceManager.

Документация по свойствам

limit : int

Это свойство хранит ограничение на количество элементов, которые будут возвращены.

См. также offset.

offset : int

Это свойство хранит индекс первого элемента в модели.

См. также limit.

plugin : Модуль

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

searchArea : geoshape

Это свойство хранит область поиска. Результаты предложений по поиску, возвращаемые моделью, будут релевантны заданной области поиска.

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

searchTerm : строка

Это свойство хранит частичный поисковый запрос, используемый в запросе.

status : перечисление

Это свойство хранит состояние модели. Оно может быть одним из следующих:

suggestions : stringlist

Это свойство хранит список предсказанных поисковых запросов, которые в настоящее время имеет модель.

Документация по методам

void cancel()

Немедленно отменяет текущую операцию предложения по поиску и устанавливает состояние модели в PlaceSearchSuggestionModel.Ready. Модель сохраняет все предложения по поиску, которые у неё были до начала операции.

Если операция не выполняется, вызов cancel() не оказывает никакого эффекта.

См. также update() и status.

строка errorString() const

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

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

void reset()

Сбрасывает модель. Все предложения по поиску очищаются, все ожидающие запросы прерываются, и возможные ошибки очищаются. Состояние модели будет установлено в PlaceSearchSuggestionModel.Null.

void update()

Обновляет модель на основе предоставленных параметров запроса. Модель будет заполнена списком предложений по поиску для частичного searchTerm и searchArea. Если модуль поддерживает это, могут быть указаны другие параметры, такие как limit и offset. update() передает набор параметров для обработки модулю.

Пока модель обновляется, состояние модели status устанавливается в PlaceSearchSuggestionModel.Loading. Если модель успешно обновляется, состояние status устанавливается в PlaceSearchSuggestionModel.Ready, в то время как, если обновление завершается неудачно, состояние status устанавливается в PlaceSearchSuggestionModel.Error, а модель очищается.

Этот пример демонстрирует использование модели

PlaceSeachSuggestionModel {
    id: model
    plugin: backendPlugin
    searchArea: QtPositioning.circle(QtPositioning.coordinate(10, 10))
    ...
}

MouseArea {
    ...
    onClicked: {
        model.searchTerm = "piz"
        model.searchArea.center.latitude = -27.5;
        model.searchArea.cetner.longitude = 153;
        model.update();
    }
}

Более подробный пример можно найти в примере Places (QML).

См. также cancel() и status.