PlaceSearchSuggestionModel QML Type

Bietet Zugang zu Vorschlägen für Suchbegriffe. Mehr...

• Liste aller Mitglieder, einschließlich geerbter 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()

Detaillierte Beschreibung

Das PlaceSearchSuggestionModel kann verwendet werden, um Vorschläge für Suchbegriffe zu machen, während der Benutzer seinen Suchbegriff eingibt. Die Eigenschaften dieses Modells sollten mit denen des PlaceSearchModel übereinstimmen, mit dem die eigentliche Suchanfrage durchgeführt 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 Delegierte. Letzteres ist die bevorzugte Methode.

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

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

Das folgende Beispiel zeigt, wie das PlaceSearchSuggestionModel verwendet wird, um vorgeschlagene Suchbegriffe aus einem partiellen Suchbegriff zu erhalten. searchArea ist so eingestellt, dass es dem entspricht, was für die eigentliche Ortssuche mit PlaceSearchModel verwendet werden würde.

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 der Eigenschaft

limit : int

Diese Eigenschaft gibt die Obergrenze für die Anzahl der zurückzugebenden Elemente an.

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 für die Durchführung der Suche verwendet wird.

searchArea : geoShape

Diese Eigenschaft enthält das Suchgebiet. Die vom Modell zurückgegebenen Suchvorschläge sind für den angegebenen Suchbereich relevant.

Wenn diese Eigenschaft auf geoCircle gesetzt ist, kann die Eigenschaft radius nicht gesetzt werden. In diesem Fall wählt Plugin einen geeigneten Radius für die Suche.

searchTerm : string

Diese Eigenschaft enthält den in der Abfrage verwendeten Teilsuchbegriff.

status : enum [read-only]

Diese Eigenschaft enthält den Status des Modells. Sie kann eine der folgenden sein:

suggestions : stringlist [read-only]

Diese Eigenschaft enthält die Liste der vorausgesagten Suchbegriffe, die das Modell derzeit hat.

Dokumentation der Methode

void cancel()

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

Wenn ein Vorgang nicht im Gange ist, hat der Aufruf von cancel() keine Wirkung.

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 Zeichenfolge zurückgegeben.

Eine leere Zeichenkette kann auch zurückgegeben werden, wenn ein Fehler aufgetreten ist, dem keine textuelle Darstellung zugeordnet ist.

void reset()

Setzt das Modell zurück. Alle Suchvorschläge werden gelöscht, alle ausstehenden Anfragen werden abgebrochen und mögliche Fehler werden gelöscht. 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 Teilbereiche searchTerm und searchArea gefüllt. Wenn plugin dies unterstützt, können weitere Parameter wie limit und offset angegeben werden. update() übergibt den Satz von Parametern an plugin zur Verarbeitung.

Während das Modell aktualisiert wird, wird status des Modells auf PlaceSearchSuggestionModel.Loading gesetzt. Wenn das Modell erfolgreich aktualisiert wird, wird status auf PlaceSearchSuggestionModel.Ready gesetzt, während, wenn die Aktualisierung nicht erfolgreich abgeschlossen wird, status auf PlaceSearchSuggestionModel.Error gesetzt und das Modell gelöscht wird.

Dieses Beispiel zeigt 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 in Places (QML).

Siehe auch cancel() und status.