PlaceSearchSuggestionModel QML Type

Permet d'accéder à des suggestions de termes de recherche. Plus d'informations...

• Liste de tous les membres, y compris les membres hérités

Propriétés

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

Méthodes

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

Description détaillée

Le modèle PlaceSearchSuggestionModel peut être utilisé pour fournir des suggestions de termes de recherche lorsque l'utilisateur saisit son terme de recherche. Les propriétés de ce modèle doivent correspondre à celles du site PlaceSearchModel, qui sera utilisé pour effectuer la recherche proprement dite, afin de garantir la pertinence des résultats de la suggestion de recherche.

Il y a deux façons d'accéder aux données fournies par ce modèle, soit par la propriété suggestions, soit par les vues et les délégués. C'est cette dernière méthode qui est privilégiée.

Les propriétés offset et limit peuvent être utilisées pour accéder aux suggestions paginées. Lorsque les propriétés offset et limit sont définies, les suggestions comprises entre offset et (offset + limit - 1) sont renvoyées. La prise en charge de la pagination peut varier d'un plugin à l'autre.

Le modèle renvoie des données pour les rôles suivants :

L'exemple suivant montre comment utiliser le modèle PlaceSearchSuggestionModel pour obtenir des suggestions de termes de recherche à partir d'un terme de recherche partiel. L'adresse searchArea est définie de manière à correspondre à ce qui serait utilisé pour effectuer une recherche de lieu avec 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 }
}

Voir également PlaceSearchModel et QPlaceManager.

Documentation sur les propriétés

limit : int

Cette propriété définit la limite du nombre d'éléments qui seront renvoyés.

Voir aussi offset.

offset : int

Cette propriété contient l'index du premier élément du modèle.

Voir aussi limit.

plugin : Plugin

Cette propriété contient le fournisseur Plugin qui sera utilisé pour effectuer la recherche.

searchArea : geoShape

Cette propriété contient la zone de recherche. Les résultats des suggestions de recherche renvoyés par le modèle seront pertinents pour la zone de recherche donnée.

Si cette propriété est attribuée à geoCircle, sa propriété radius peut être laissée non définie, auquel cas Plugin choisira un rayon approprié pour la recherche.

searchTerm : string

Cette propriété contient le terme de recherche partiel utilisé dans la requête.

status : enum [read-only]

Cette propriété contient le statut du modèle. Elle peut être l'une des suivantes

suggestions : stringlist [read-only]

Cette propriété contient la liste des termes de recherche prédits que le modèle possède actuellement.

Documentation de la méthode

void cancel()

Annule immédiatement une opération de suggestion de recherche en cours et règle l'état du modèle sur PlaceSearchSuggestionModel.Ready. Le modèle conserve toutes les suggestions de recherche qu'il avait avant le début de l'opération.

Si une opération n'est pas en cours, l'invocation de cancel() n'a aucun effet.

Voir également update() et status.

string errorString()

Cette propriété en lecture seule contient la présentation textuelle de la dernière erreur du modèle de suggestion de recherche. Si aucune erreur ne s'est produite ou si le modèle a été effacé, une chaîne vide est renvoyée.

Une chaîne vide peut également être renvoyée si une erreur s'est produite et qu'aucune représentation textuelle n'y est associée.

void reset()

Réinitialise le modèle. Toutes les suggestions de recherche sont effacées, toutes les demandes en cours sont interrompues et les erreurs éventuelles sont effacées. L'état du modèle prend la valeur PlaceSearchSuggestionModel.Null.

void update()

Met à jour le modèle sur la base des paramètres de requête fournis. Le modèle sera alimenté par une liste de suggestions de recherche pour les parties searchTerm et searchArea. Si plugin le prend en charge, d'autres paramètres tels que limit et offset peuvent être spécifiés. update() soumet l'ensemble des paramètres à plugin pour qu'il les traite.

Pendant que le modèle est mis à jour, status du modèle est défini sur PlaceSearchSuggestionModel.Loading. Si le modèle est mis à jour avec succès, status est défini sur PlaceSearchSuggestionModel.Ready, tandis que si la mise à jour échoue, status est défini sur PlaceSearchSuggestionModel.Error et le modèle est effacé.

Cet exemple montre l'utilisation du modèle

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

Un exemple plus détaillé se trouve dans l'exemple "in Places" (QML).

Voir également cancel() et status.