Plugin QML Type

Le type de plugin décrit un plugin de services basés sur la localisation. Plus d'informations...

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

Propriétés

• allowExperimental : bool
• availableServiceProviders : stringlist
• isAttached : bool
• locales : stringlist
• name : string
• parameters : list<PluginParameter>
• preferred : stringlist
• required : enumeration

Méthodes

• bool supportsGeocoding(GeocodingFeatures features)
• bool supportsMapping(MappingFeatures features)
• bool supportsNavigation(NavigationFeatures features)
• bool supportsPlaces(PlacesFeatures features)
• bool supportsRouting(RoutingFeatures features)

Description détaillée

Le type Plugin est utilisé pour spécifier de manière déclarative quel plugin GeoServices disponible doit être utilisé pour diverses tâches dans l'API de localisation. Les plugins sont utilisés par les types Map, RouteModel, et GeocodeModel, ainsi que par une variété d'autres.

Les plugins reconnus par le système ont une propriété name, une simple chaîne de caractères indiquant normalement le nom du service auprès duquel le plugin récupère des données. Ils possèdent également diverses caractéristiques, qui peuvent être testées à l'aide des méthodes supportsRouting(), supportsGeocoding(), supportsMapping(), supportsPlaces() et supportsNavigation().

Lorsqu'un objet Plugin est créé, il est "détaché" et n'est associé à aucun plugin de service réel. Une fois qu'il a reçu des informations en définissant ses propriétés name, preferred, ou required, il choisit un plugin de service approprié auquel s'attacher. Les objets Plugin ne peuvent être attachés qu'une seule fois ; pour utiliser plusieurs plugins, il faut créer plusieurs objets Plugin.

Exemple d'utilisation

L'extrait suivant montre un objet Plugin créé avec les propriétés required et preferred. Ce plugin s'attachera au premier plugin trouvé qui supporte à la fois la cartographie et le géocodage, et préférera les plugins nommés "here" ou "osm" à tous les autres.

Plugin {
    id: plugin
    preferred: ["here", "osm"]
    required: Plugin.AnyMappingFeatures | Plugin.AnyGeocodingFeatures
}

Documentation sur les propriétés

allowExperimental : bool

Cette propriété indique si des plugins expérimentaux peuvent être utilisés.

availableServiceProviders : stringlist

Cette propriété contient une liste des noms de tous les plugins de service disponibles. Elle peut être utilisée pour énumérer manuellement les plugins disponibles si le contrôle fourni par name et required n'est pas suffisant pour vos besoins.

isAttached : bool

Cette propriété indique si l'élément de plugin est attaché à un plugin de fournisseur de géoservices.

locales : stringlist

Cette propriété contient une liste ordonnée des paramètres locaux préférés du plugin. Si la première locale ne peut être prise en compte, le backend se rabat sur la deuxième, et ainsi de suite. Par défaut, la propriété locales contient la locale du système.

Les locales sont spécifiées sous forme de chaînes de caractères ayant le format "language[_script][_country]" ou "C", où :

• language est un code de langue ISO 639 à deux lettres minuscules,
• script est un code de script en minuscules, à quatre lettres, de la norme ISO 15924,
• country est un code de pays en majuscules, à deux ou trois lettres, de la norme ISO 3166 (également "419" selon la définition des Nations unies),
• la locale "C" a un comportement identique à celui de l'anglais/États-Unis, conformément à la règle de base. QLocale

Si la première locale spécifiée ne peut être prise en compte, Plugin passe à la suivante, et ainsi de suite. Certains backends de Plugin peuvent ne pas prendre en charge un ensemble de paramètres régionaux définis de manière rigide. Un exemple arbitraire est que certains sites Place en France pourraient avoir des localisations en français et en anglais, alors que certaines régions d'Amérique pourraient n'avoir que la localisation en anglais. Dans le scénario ci-dessus, l'ensemble des langues prises en charge dépend du contexte de l'emplacement de la recherche.

Si le site Plugin ne peut prendre en charge aucune des langues préférées, le gestionnaire se rabat sur l'utilisation d'une langue prise en charge qui est spécifique au backend.

Pour les sites Plugin qui ne prennent pas en charge les langues locales, la liste des langues locales est toujours vide.

Le code suivant montre comment définir une ou plusieurs langues :

//single locale
Plugin {
    locales: "en_US"
}

//multiple locales
Plugin {
    locales: ["fr_FR","en_US"]
}

name : string

Cette propriété contient le nom du plugin. En définissant cette propriété, le plugin ne s'attachera qu'à un plugin portant exactement ce nom. La valeur de required sera ignorée.

parameters : list<PluginParameter> [default]

Cette propriété contient la liste des paramètres du plugin.

preferred : stringlist

Cette propriété contient une liste ordonnée de noms de plugins préférés, qui seront vérifiés pour les fonctionnalités requises définies dans required avant que tout autre plugin disponible ne soit vérifié.

required : enumeration

Cette propriété contient l'ensemble des caractéristiques qui seront exigées par l'objet Plugin lorsqu'il choisira le plugin de service auquel s'attacher. Si la propriété name est définie, cela n'a aucun effet.

L'une des valeurs suivantes ou une combinaison bit à bit de plusieurs valeurs peut être définie :

• Plugin.NoFeatures
• Plugin.GeocodingFeature
• Plugin.ReverseGeocodingFeature
• Plugin.RoutingFeature
• Plugin.MappingFeature
• Plugin.AnyPlacesFeature

Documentation des méthodes

bool supportsGeocoding(GeocodingFeatures features)

Cette méthode renvoie un booléen indiquant si l'ensemble spécifié de features est pris en charge par le plugin de fournisseur de services géographiques. True est renvoyé si tous les features spécifiés sont pris en charge, sinon false est renvoyé.

Le paramètre features peut être n'importe quelle combinaison de drapeaux :

bool supportsMapping(MappingFeatures features)

Cette méthode renvoie un booléen indiquant si l'ensemble spécifié de features est pris en charge par le plugin de fournisseur de services géographiques. True est renvoyé si tous les features spécifiés sont pris en charge, sinon false est renvoyé.

Le paramètre features peut être n'importe quelle combinaison de drapeaux :

bool supportsNavigation(NavigationFeatures features)

Cette méthode renvoie un booléen indiquant si l'ensemble spécifié de features est pris en charge par le plugin de fournisseur de services géographiques. True est renvoyé si tous les features spécifiés sont pris en charge, sinon false est renvoyé.

Le paramètre features peut être n'importe quelle combinaison de drapeaux :

bool supportsPlaces(PlacesFeatures features)

Cette méthode renvoie un booléen indiquant si l'ensemble spécifié de features est pris en charge par le plugin de fournisseur de services géographiques. True est renvoyé si tous les features spécifiés sont pris en charge, sinon false est renvoyé.

Le paramètre features peut être une combinaison de drapeaux :

bool supportsRouting(RoutingFeatures features)

Cette méthode renvoie un booléen indiquant si l'ensemble spécifié de features est pris en charge par le plugin de fournisseur de services géographiques. True est renvoyé si tous les features spécifiés sont pris en charge, sinon false est renvoyé.

Le paramètre features peut être une combinaison de drapeaux :