PlaceSearchSuggestionModel QML Type

Bietet Zugriff auf Vorschläge für Suchbegriffe. Mehr...

• Liste aller Mitglieder, einschließlich vererbter Mitglieder

Eigenschaften

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

Methoden

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

Ausführliche Beschreibung

Das „PlaceSearchSuggestionModel“ kann verwendet werden, um Suchbegriffvorschläge anzubieten, während der Benutzer seinen Suchbegriff eingibt. Die Eigenschaften dieses Modells sollten mit denen des „ PlaceSearchModel “ übereinstimmen, das zur Durchführung der eigentlichen Suchabfrage verwendet wird, um sicherzustellen, dass die Suchvorschläge relevant sind.

Es gibt zwei Möglichkeiten, auf die von diesem Modell bereitgestellten Daten zuzugreifen: entweder über die Eigenschaft „ suggestions “ oder über Ansichten und Delegaten. Letzteres ist die bevorzugte Methode.

Die Eigenschaften „ offset “ und „ limit “ können verwendet werden, um auf paginierte Vorschläge zuzugreifen. Wenn die Eigenschaften „ offset “ und „ limit “ festgelegt sind, werden die Vorschläge zwischen „ offset “ und „(offset + limit - 1)“ zurückgegeben. Die Unterstützung für die Paginierung kann von Plugin zu Plugin variieren.

Das Modell gibt Daten für die folgenden Rollen zurück:

Das folgende Beispiel zeigt, wie man mit dem `PlaceSearchSuggestionModel` Suchvorschläge auf der Grundlage eines Teilsuchbegriffs abruft. Das ` searchArea ` ist so eingestellt, dass es mit den Einstellungen übereinstimmt, die für die eigentliche Ortssuche mit ` PlaceSearchModel` verwendet würden.

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 }
}

Siehe auch „ PlaceSearchModel “ und „ QPlaceManager “.

Dokumentation zu den Eigenschaften

limit : int

Diese Eigenschaft legt die Obergrenze für die Anzahl der zurückgegebenen Elemente fest.

Siehe auch „ offset “.

offset : int

Diese Eigenschaft enthält den Index des ersten Elements im Modell.

Siehe auch „ limit “.

plugin : Plugin

Diese Eigenschaft enthält den Anbieter- Plugin, der zur Durchführung der Suche verwendet wird.

searchArea : geoShape

Diese Eigenschaft enthält den Suchbereich. Die vom Modell zurückgegebenen Suchvorschläge beziehen sich auf den angegebenen Suchbereich.

Wenn diese Eigenschaft auf „ geoCircle “ gesetzt ist, kann die Eigenschaft „ radius “ ungesetzt bleiben; in diesem Fall wählt das „ Plugin “ einen geeigneten Suchradius aus.

searchTerm : string

Diese Eigenschaft enthält den in der Abfrage verwendeten Teil des Suchbegriffs.

status : enum [read-only]

Diese Eigenschaft gibt den Status des Modells an. Mögliche Werte sind:

suggestions : stringlist [read-only]

Diese Eigenschaft enthält die Liste der vom Modell aktuell vorgeschlagenen Suchbegriffe.

Methodendokumentation

void cancel()

Bricht einen laufenden Suchvorschlagsvorgang sofort ab und setzt den Modellstatus auf „ PlaceSearchSuggestionModel.Ready“. Das Modell behält alle Suchvorschläge bei, die es vor Beginn des Vorgangs hatte.

Wenn kein Vorgang läuft, hat der Aufruf von `cancel()` keine Auswirkung.

Siehe auch „ update()“ und „ status “.

string errorString()

Diese schreibgeschützte Eigenschaft enthält die textuelle Darstellung des letzten Fehlers des Suchvorschlagsmodells. Wenn kein Fehler aufgetreten ist oder das Modell gelöscht wurde, wird eine leere Zeichenkette zurückgegeben.

Eine leere Zeichenkette kann auch zurückgegeben werden, wenn ein Fehler aufgetreten ist, für den keine textuelle Darstellung vorhanden ist.

void reset()

Setzt das Modell zurück. Alle Suchvorschläge werden gelöscht, alle ausstehenden Anfragen werden abgebrochen und eventuelle Fehler werden behoben. Der Modellstatus wird auf „ PlaceSearchSuggestionModel.Null“ gesetzt.

void update()

Aktualisiert das Modell auf der Grundlage der angegebenen Abfrageparameter. Das Modell wird mit einer Liste von Suchvorschlägen für die Teil searchTerm und searchArea gefüllt. Sofern das plugin dies unterstützt, können weitere Parameter wie limit und offset angegeben werden. update() übermittelt den Parametersatz zur Verarbeitung an das plugin.

Während das Modell aktualisiert wird, wird die „ status “ des Modells auf „ PlaceSearchSuggestionModel.Loading “ gesetzt. Wird das Modell erfolgreich aktualisiert, wird die „ status “ auf „ PlaceSearchSuggestionModel.Ready “ gesetzt; wird der Vorgang hingegen nicht erfolgreich abgeschlossen, wird die „ status “ auf „ PlaceSearchSuggestionModel.Error “ gesetzt und das Modell gelöscht.

Dieses Beispiel veranschaulicht die Verwendung des Modells

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

Ein ausführlicheres Beispiel finden Sie im Beispiel „Places (QML) “.

Siehe auch „ cancel “ () und „ status “.