PlaceSearchSuggestionModel QML Type

検索用語の候補を表示します。詳細...

• 継承されたメンバーを含む、すべてのメンバーの一覧

プロパティ

• limit : int
• offset : int
• plugin : Plugin
• searchArea : geoShape
• searchTerm : string
• status : enum
• suggestions : stringlist

方法

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

詳細な説明

PlaceSearchSuggestionModel を使用すると、ユーザーが検索語句を入力する際に、検索語句の候補を表示することができます。検索候補の結果が関連性の高いものとなるよう、このモデルのプロパティは、実際の検索クエリの実行に使用されるPlaceSearchModel のプロパティと一致している必要があります。

このモデルが提供するデータにアクセスするには、suggestions プロパティを介する方法と、ビューおよびデリゲートを介する方法の2つがあります。後者の方法が推奨されます。

offset およびlimit プロパティを使用すると、ページ分けされた候補にアクセスできます。offset およびlimit プロパティが設定されている場合、offset から (offset +limit - 1) までの候補が返されます。ページングのサポート状況はプラグインによって異なる場合があります。

このモデルは、以下のロールに関するデータを返します：

以下の例は、PlaceSearchSuggestionModel を使用して、部分的な検索語句から検索候補を取得する方法を示しています。searchArea は、PlaceSearchModel を使用して実際の場所検索を実行する際に使用されるものと一致するように設定されています。

import QtQuick
import QtPositioning
import QtLocation

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 : Plugin

このプロパティには、検索の実行に使用されるプロバイダー「Plugin 」が格納されています。

searchArea : geoShape

このプロパティは検索範囲を保持します。モデルによって返される検索候補の結果は、指定された検索範囲に関連するものとなります。

このプロパティが `geoCircle ` に設定されている場合、`radius ` プロパティは未設定のままにしておくことができます。その場合、Plugin が検索に適切な半径を選択します。

searchTerm : string

このプロパティには、クエリで使用された検索語の一部が格納されます。

status : enum [read-only]

このプロパティはモデルのステータスを保持します。以下のいずれかになります：

suggestions : stringlist [read-only]

このプロパティには、モデルが現在保持している予測検索語句のリストが格納されています。

メソッドのドキュメント

void cancel()

進行中の検索候補生成操作を直ちに中止し、モデルのステータスをPlaceSearchSuggestionModel.Readyに設定します。モデルは、操作が開始される前に保持していた検索候補をすべて保持します。

操作が実行中でない場合、cancel() を呼び出しても何の効果もありません。

update() およびstatusも参照してください 。

string errorString()

この読み取り専用プロパティには、最新の検索候補モデルのエラーがテキスト形式で格納されます。エラーが発生していない場合、またはモデルがクリアされた場合は、空の文字列が返されます。

また、エラーが発生したものの、それに対応するテキスト表現がない場合にも、空の文字列が返されることがあります。

void reset()

モデルをリセットします。すべての検索候補がクリアされ、未処理のリクエストはすべて中止され、発生しているエラーがあれば解消されます。モデルのステータスは「PlaceSearchSuggestionModel.Null」に設定されます。

void update()

指定されたクエリパラメータに基づいてモデルを更新します。モデルには、部分的なsearchTerm およびsearchArea に対する検索候補のリストが格納されます。plugin が対応している場合、limit やoffset などの他のパラメータを指定することも可能です。update() は、一連のパラメータをplugin に送信して処理を行います。

モデルの更新中は、モデルの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も参照してください 。