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 プロパティを使う方法と、ビューとデリゲートを使う方法があります。後者が望ましい方法です。

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

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

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