Plugin QML Type

Der Plugin-Typ beschreibt ein Plugin für standortbezogene Dienste. Mehr...

• Liste aller Mitglieder, einschließlich vererbter Mitglieder

Eigenschaften

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

Methoden

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

Ausführliche Beschreibung

Der Plugin-Typ dient dazu, deklarativ festzulegen, welches der verfügbaren GeoServices-Plugins für verschiedene Aufgaben in der Location-API verwendet werden soll. Plugins werden von den Typen „ Map “, „ RouteModel “ und „ GeocodeModel “ sowie einer Vielzahl anderer Typen verwendet.

Vom System erkannte Plugins verfügen über eine „ name “-Eigenschaft – einen einfachen String, der normalerweise den Namen des Dienstes angibt, von dem das Plugin Daten abruft. Sie verfügen außerdem über eine Vielzahl von Funktionen, die mithilfe der Methoden „ supportsRouting()“, „ supportsGeocoding()“, „ supportsMapping()“, „ supportsPlaces()“ und „ supportsNavigation()“ geprüft werden können.

Wenn ein Plugin-Objekt erstellt wird, ist es „ungebunden“ und mit keinem tatsächlichen Service-Plugin verknüpft. Sobald es Informationen über die Eigenschaften ` name`, ` preferred` oder ` required ` erhalten hat, wählt es ein geeignetes Service-Plugin aus, an das es sich anknüpft. Plugin-Objekte können nur einmal angeknüpft werden; um mehrere Plugins zu verwenden, erstellen Sie mehrere Plugin-Objekte.

Anwendungsbeispiel

Der folgende Codeausschnitt zeigt die Erstellung eines Plugin-Objekts, bei dem die Eigenschaften ` required ` und ` preferred ` festgelegt sind. Dieses Plugin wird an das erste gefundene Plugin angehängt, das sowohl Mapping als auch Geokodierung unterstützt, und bevorzugt Plugins mit den Namen „here“ oder „osm“ gegenüber allen anderen.

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

Dokumentation zu den Eigenschaften

allowExperimental : bool

Diese Eigenschaft gibt an, ob experimentelle Plugins verwendet werden können.

availableServiceProviders : stringlist

Diese Eigenschaft enthält eine Liste aller Namen der verfügbaren Service-Plugins. Diese kann verwendet werden, um die verfügbaren Plugins manuell aufzulisten, falls die von name und required bereitgestellten Steuerelemente für Ihre Anforderungen nicht ausreichen.

isAttached : bool

Diese Eigenschaft gibt an, ob das Plugin-Element mit einem Geodienst-Anbieter-Plugin verknüpft ist.

locales : stringlist

Diese Eigenschaft enthält eine geordnete Liste bevorzugter Plugin-Sprachumgebungen. Kann die erste Sprachumgebung nicht verwendet werden, greift das Backend auf die zweite zurück und so weiter. Standardmäßig enthält die Eigenschaft „locales“ die System-Sprachumgebung.

Die Sprachumgebungen werden als Zeichenfolgen im Format „Sprache[_Schrift][_Land]“ oder „C“ angegeben, wobei:

• „language“ ein aus zwei Kleinbuchstaben bestehender ISO-639-Sprachcode ist,
• „script“ ein vierbuchstabiger Schriftcode nach ISO 15924 in Groß- und Kleinschreibung ist,
• „country“ ein aus zwei oder drei Großbuchstaben bestehender ISO-3166-Ländercode ist (auch „419“, wie von den Vereinten Nationen definiert),
• die Locale „C“ verhält sich identisch wie „English/UnitedStates“, gemäß QLocale

Wenn die zuerst angegebene Locale nicht unterstützt werden kann, greift „ Plugin “ auf die nächste zurück und so weiter. Einige „ Plugin “-Backends unterstützen möglicherweise keine fest definierten Locale-Sätze. Ein beliebiges Beispiel: Einige „ Place “ in Frankreich könnten über französische und englische Lokalisierungen verfügen, während in bestimmten Regionen Amerikas möglicherweise nur die englische Lokalisierung verfügbar ist. In dem oben genannten Szenario hängt die Menge der unterstützten Locales vom Suchort ab.

Wenn die Plugin keine der bevorzugten Sprachumgebungen unterstützen, greift der Manager auf eine unterstützte Sprache zurück, die backend-spezifisch ist.

Bei „ Plugin “, die keine Locales unterstützen, ist die Locale-Liste immer leer.

Der folgende Code veranschaulicht, wie eine einzelne und mehrere Locales festgelegt werden:

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

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

name : string

Diese Eigenschaft enthält den Namen des Plugins. Wird diese Eigenschaft festgelegt, wird das Plugin nur an ein Plugin mit genau diesem Namen angehängt. Der Wert von „ required “ wird ignoriert.

parameters : list<PluginParameter> [default]

Diese Eigenschaft enthält die Liste der Plugin-Parameter.

preferred : stringlist

Diese Eigenschaft enthält eine geordnete Liste bevorzugter Plugin-Namen, die auf die unter required festgelegten erforderlichen Funktionen überprüft werden, bevor andere verfügbare Plugins geprüft werden.

required : enumeration

Diese Eigenschaft enthält die Menge der Merkmale, die vom Plugin-Objekt benötigt werden, um zu entscheiden, an welches Service-Plugin es angehängt werden soll. Wenn die Eigenschaft „ name “ gesetzt ist, hat dies keine Auswirkung.

Es kann einer der folgenden Werte oder eine bitweise Kombination mehrerer Werte festgelegt werden:

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

Methodendokumentation

bool supportsGeocoding(GeocodingFeatures features)

Diese Methode gibt einen booleschen Wert zurück, der angibt, ob die angegebene Menge an „ features “ vom Plugin des Geodienstanbieters unterstützt wird. „ True “ wird zurückgegeben, wenn alle angegebenen „ features “ unterstützt werden; andernfalls wird „ false “ zurückgegeben.

Der Parameter „ features “ kann eine beliebige Kombination der folgenden Flags sein:

bool supportsMapping(MappingFeatures features)

Diese Methode gibt einen booleschen Wert zurück, der angibt, ob die angegebene Gruppe von „ features “ vom Plugin des Geodienstanbieters unterstützt wird. „True“ wird zurückgegeben, wenn alle angegebenen „ features “ unterstützt werden; andernfalls wird „false“ zurückgegeben.

Der Parameter „ features “ kann eine beliebige Kombination der folgenden Flags sein:

bool supportsNavigation(NavigationFeatures features)

Diese Methode gibt einen booleschen Wert zurück, der angibt, ob die angegebene Gruppe von „ features “ vom Plugin des Geodienstanbieters unterstützt wird. „True“ wird zurückgegeben, wenn alle angegebenen „ features “ unterstützt werden; andernfalls wird „false“ zurückgegeben.

Der Parameter „ features “ kann eine beliebige Kombination der folgenden Flags sein:

bool supportsPlaces(PlacesFeatures features)

Diese Methode gibt einen booleschen Wert zurück, der angibt, ob die angegebene Gruppe von „ features “ vom Plugin des Geodienstanbieters unterstützt wird. „True“ wird zurückgegeben, wenn alle angegebenen „ features “ unterstützt werden; andernfalls wird „false“ zurückgegeben.

Der Parameter „ features “ kann eine beliebige Kombination der folgenden Flags sein:

bool supportsRouting(RoutingFeatures features)

Diese Methode gibt einen booleschen Wert zurück, der angibt, ob die angegebene Menge an „ features “ vom Plugin des Geodienstanbieters unterstützt wird. „True“ wird zurückgegeben, wenn alle angegebenen „ features “ unterstützt werden; andernfalls wird „false“ zurückgegeben.

Der Parameter „ features “ kann eine beliebige Kombination der folgenden Flags sein: