PlaceSearchSuggestionModel QML Type

検索語候補へのアクセスを提供します。詳細...

Import Statement: import QtLocation 6.8
Since: QtLocation 5.5

プロパティ

メソッド

詳細な説明

PlaceSearchSuggestionModel は、ユーザが検索語を入力する際に、検索語の候補を提供するために使用することができます。このモデルのプロパティは、実際の検索クエリに使用されるPlaceSearchModel のプロパティと一致しなければなりません。

このモデルが提供するデータにアクセスするには、suggestions プロパティを使う方法と、ビューとデリゲートを使う方法があります。後者が望ましい方法です。

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]

このプロパティはモデルの状態を保持する。以下のいずれかになります:

PlaceSearchSuggestionModel.Null検索クエリが実行されていない。モデルは空です。
PlaceSearchSuggestionModel.Ready検索クエリが完了し、結果が利用可能です。
PlaceSearchSuggestionModel.Loading検索クエリが実行中です。
PlaceSearchSuggestionModelエラー直前の検索クエリ実行時にエラーが発生しました。

suggestions : stringlist [read-only]

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


メソッドの説明

void cancel()

実行中の検索候補の操作を直ちにキャンセルし、モデルのステータスをPlaceSearchSuggestionModel.Ready に設定します。モデルは操作が開始される前に持っていた検索候補を保持します。

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

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


string errorString()

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

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


void reset()

モデルをリセットします。すべての検索候補はクリアされ、未解決のリクエストはすべて中止され、起こりうるエラーはクリアされます。モデルのステータスはPlaceSearchSuggestionModel.Null に設定されます。


void update()

指定されたクエリパラメータに基づいてモデルを更新します。モデルには、部分的なsearchTermsearchArea の検索候補のリストが入力されます。plugin がサポートしている場合、limitoffset などの他のパラメータを指定することができます。update() は、パラメータセットをplugin に送信して処理させます。

モデルの更新中、モデルのstatusPlaceSearchSuggestionModel.Loading に設定される。モデルの更新が成功した場合、statusPlaceSearchSuggestionModel.Ready に設定され、更新が失敗した場合、statusPlaceSearchSuggestionModel.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();
    }
}

より詳細な例はinPlaces (QML)の例にあります。

cancel() とstatusも参照してください


本書に含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。