Plugin QML Type

Le type de plugin correspond à un plugin de services de localisation. En savoir plus...

• 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 permet de spécifier de manière déclarative quel plugin GeoServices disponible doit être utilisé pour diverses tâches dans l'API Location. Les plugins sont utilisés par les types Map, RouteModel et GeocodeModel, ainsi que par divers autres.

Les plugins reconnus par le système possèdent une propriété « name », une simple chaîne de caractères indiquant généralement le nom du service à partir duquel le plugin récupère des données. Ils disposent également de diverses fonctionnalités, 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 via la configuration de ses propriétés name, preferred ou required, il choisira un plugin de service approprié auquel se lier. Les objets Plugin ne peuvent être liés qu’une seule fois ; pour utiliser plusieurs plugins, créez plusieurs objets Plugin.

Exemple d’utilisation

L'extrait de code suivant montre la création d'un objet Plugin dont les propriétés required et preferred sont définies. Ce Plugin s'associera au premier plugin trouvé prenant en charge à la fois le mappage et le géocodage, et privilégiera les plugins nommés « here » ou « osm » par rapport à tous les autres.

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

Documentation des propriétés

allowExperimental : bool

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

availableServiceProviders : stringlist

Cette propriété contient la liste de tous les noms des plugins de service disponibles. Elle peut être utilisée pour répertorier manuellement les plugins disponibles si le contrôle fourni par name et required ne répond pas à vos besoins.

isAttached : bool

Cette propriété indique si l'élément « Plugin » est associé à un plugin de fournisseur de géoservices.

locales : stringlist

Cette propriété contient une liste ordonnée des paramètres régionaux préférés pour les plugins. Si le premier paramètre régional ne peut pas être pris en charge, le backend utilise alors le deuxième, et ainsi de suite. Par défaut, la propriété « locales » contient le paramètre régional du système.

Les paramètres régionaux sont spécifiés sous forme de chaînes de caractères au format « langue[_script][_pays] » ou « C », où :

• « language » est un code de langue ISO 639 à deux lettres en minuscules,
• script est un code de script ISO 15924 de quatre lettres en majuscules et minuscules,
• « country » est un code de pays ISO 3166 en majuscules, à deux ou trois lettres (également « 419 » selon la définition des Nations Unies),
• la locale « C » se comporte de manière identique à « English/UnitedStates », conformément à QLocale

Si la première locale spécifiée ne peut pas être prise en charge, l’ Plugin e se rabat sur la suivante, et ainsi de suite. Certains backends d’ Plugin peuvent ne pas prendre en charge un ensemble de locales défini de manière rigide. À titre d’exemple, certains sites Place en France pourraient proposer des localisations en français et en anglais, tandis que certaines régions des États-Unis ne disposeraient que de la localisation en anglais. Dans le scénario ci-dessus, l’ensemble des locales prises en charge dépend du contexte, c’est-à-dire de l’emplacement de la recherche.

Si l’ Plugin ne peut prendre en charge aucune des locales préférées, le gestionnaire se rabat sur une langue prise en charge spécifique au backend.

Pour les « Plugin » qui ne prennent pas en charge les paramètres régionaux, la liste des paramètres régionaux est toujours vide.

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

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

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

name : string

Cette propriété contient le nom du plugin. Si vous définissez cette propriété, le plugin ne s’associera 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 des noms de plugins préférés, qui seront vérifiés pour s'assurer qu'ils disposent des fonctionnalités requises définies dans required avant que tout autre plugin disponible ne soit pris en compte.

required : enumeration

Cette propriété contient l'ensemble des caractéristiques dont l'objet Plugin aura besoin pour choisir le plugin de service auquel il doit se connecter. Si la propriété « name » est définie, cette propriété n'a aucun effet.

L'une des valeurs suivantes, ou une combinaison binaire 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 une valeur booléenne indiquant si l'ensemble spécifié d'features est pris en charge par le plugin du fournisseur de services géographiques. La valeur « True » est renvoyée si toutes les features spécifiées sont prises en charge ; dans le cas contraire, la valeur « false » est renvoyée.

Le paramètre « features » peut prendre n'importe quelle combinaison des indicateurs suivants :

bool supportsMapping(MappingFeatures features)

Cette méthode renvoie une valeur booléenne indiquant si l'ensemble spécifié d'features s est pris en charge par le plugin du fournisseur de services géographiques. La valeur « true » est renvoyée si toutes les features s spécifiées sont prises en charge ; dans le cas contraire, la valeur « false » est renvoyée.

Le paramètre « features » peut être n'importe quelle combinaison des indicateurs suivants :

bool supportsNavigation(NavigationFeatures features)

Cette méthode renvoie une valeur booléenne indiquant si l'ensemble spécifié d'features s est pris en charge par le plugin du fournisseur de services géographiques. La valeur « true » est renvoyée si toutes les features s spécifiées sont prises en charge ; dans le cas contraire, la valeur « false » est renvoyée.

Le paramètre « features » peut être n’importe quelle combinaison des indicateurs suivants :

bool supportsPlaces(PlacesFeatures features)

Cette méthode renvoie une valeur booléenne indiquant si l'ensemble spécifié d'features s est pris en charge par le plugin du fournisseur de services géographiques. La valeur « true » est renvoyée si toutes les features s spécifiées sont prises en charge ; dans le cas contraire, la valeur « false » est renvoyée.

Le paramètre « features » peut être n’importe quelle combinaison des indicateurs suivants :

bool supportsRouting(RoutingFeatures features)

Cette méthode renvoie une valeur booléenne indiquant si l'ensemble spécifié d'features s est pris en charge par le plugin du fournisseur de services géographiques. La valeur « true » est renvoyée si toutes les features s spécifiées sont prises en charge ; dans le cas contraire, la valeur « false » est renvoyée.

Le paramètre « features » peut être n’importe quelle combinaison des indicateurs suivants :