Plugin QML Type

「プラグインタイプ」は、位置情報サービス用プラグインを表します。詳細...

• 継承されたメンバーを含む、すべてのメンバーの一覧

プロパティ

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

方法

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

詳細な説明

「Plugin」タイプは、Location API におけるさまざまなタスクに対して、利用可能な GeoServices プラグインのうちどれを使用すべきかを宣言的に指定するために使用されます。プラグインは、Map 、RouteModel 、GeocodeModel といったタイプをはじめ、その他多数のタイプで使用されます。

システムによって認識されるプラグインには、name プロパティがあります。これは通常、プラグインがデータを取得するサービスの名前を示す単純な文字列です。また、プラグインにはさまざまな機能があり、supportsRouting()、supportsGeocoding()、supportsMapping()、supportsPlaces()、およびsupportsNavigation() メソッドを使用して、それらの機能をテストすることができます。

Plugin オブジェクトが作成されると、それは「切り離された」状態となり、実際のサービスプラグインとは関連付けられていません。name 、preferred 、またはrequired プロパティの設定を通じて情報を受け取ると、そのオブジェクトはアタッチする適切なサービスプラグインを選択します。Plugin オブジェクトは一度しかアタッチできません。複数のプラグインを使用するには、複数の Plugin オブジェクトを作成してください。

使用例

以下のスニペットは、required およびpreferred プロパティを設定して Plugin オブジェクトを作成する例を示しています。この Plugin は、マッピングとジオコーディングの両方をサポートする最初のプラグインにアタッチされ、他のプラグインよりも「here」または「osm」という名前のプラグインを優先します。

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

プロパティのドキュメント

allowExperimental : bool

このプロパティは、実験的なプラグインを使用できるかどうかを示します。

availableServiceProviders : stringlist

このプロパティには、利用可能なすべてのサービスプラグインの名前がリストとして格納されています。name およびrequired で提供されるコントロールではニーズを満たせない場合、これを使用して利用可能なプラグインを手動で列挙することができます。

isAttached : bool

このプロパティは、プラグイン項目がジオサービスプロバイダープラグインに紐付けられているかどうかを示します。

locales : stringlist

このプロパティには、優先順位付きのプラグインロケールのリストが含まれています。最初のロケールが使用できない場合、バックエンドは2番目のロケールに切り替わり、以下同様となります。デフォルトでは、locales プロパティにはシステムのロケールが設定されています。

ロケールは、「language[_script][_country]」または「C」という形式の文字列として指定されます。ここで、

• language は小文字の 2 文字からなる ISO 639 言語コード、
• script は、大文字と小文字を区別する 4 文字の ISO 15924 文字体系コードです。
• country は、大文字の 2 文字または 3 文字の ISO 3166 国コード（国連で定義された「419」も含む）です。
• 「C」ロケールの動作は、QLocale

最初に指定されたロケールに対応できない場合、Plugin は次のロケールにフォールバックし、以下同様に処理されます。一部のPlugin バックエンドでは、厳密に定義されたロケールのセットをサポートしていない場合があります。 一例として、フランスのPlace ではフランス語と英語のローカライズが利用可能である一方、アメリカの一部の地域では英語のローカライズしか利用できない場合があります。上記のシナリオでは、サポートされるロケールのセットは検索場所のコンテキストに依存します。

Plugin が優先ロケールのいずれにも対応できない場合、マネージャーはバックエンド固有のサポートされている言語の使用に切り替えます。

ロケールをサポートしていないPlugin の場合、ロケール一覧は常に空になります。

以下のコードは、単一および複数のロケールを設定する方法を示しています：

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

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

name : string

このプロパティにはプラグインの名前が格納されます。このプロパティを設定すると、プラグインは名前がこれと完全に一致するプラグインにのみアタッチされるようになります。「required 」の値は無視されます。

parameters : list<PluginParameter> [default]

このプロパティには、プラグインのパラメータのリストが格納されています。

preferred : stringlist

このプロパティには、優先順位付きのプラグイン名のリストが含まれており、required で設定された必須機能について、他の利用可能なプラグインがチェックされる前に、まずこのリスト内のプラグインがチェックされます。

required : enumeration

このプロパティには、Pluginオブジェクトがどのサービスプラグインをアタッチするかを選択する際に必要となる機能のセットが含まれます。name プロパティが設定されている場合、このプロパティは効果を持ちません。

以下のいずれかの値、または複数の値のビット単位の組み合わせを設定できます：

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

メソッドのドキュメント

bool supportsGeocoding(GeocodingFeatures features)

このメソッドは、指定されたfeatures のセットがジオサービスプロバイダプラグインでサポートされているかどうかを示すブール値を返します。指定されたすべてのfeatures がサポートされている場合はTrue が返され、そうでない場合はfalse が返されます。

features パラメータには、以下のフラグの任意の組み合わせを指定できます。

bool supportsMapping(MappingFeatures features)

このメソッドは、指定されたfeatures のセットがジオサービスプロバイダプラグインによってサポートされているかどうかを示すブール値を返します。指定されたすべてのfeatures がサポートされている場合はTrueが返され、そうでない場合はfalseが返されます。

features パラメータには、以下のフラグの任意の組み合わせを指定できます：

bool supportsNavigation(NavigationFeatures features)

このメソッドは、指定されたfeatures のセットがジオサービスプロバイダプラグインによってサポートされているかどうかを示すブール値を返します。指定されたすべてのfeatures がサポートされている場合はTrueが返され、そうでない場合はfalseが返されます。

features パラメータには、以下のフラグの任意の組み合わせを指定できます。

bool supportsPlaces(PlacesFeatures features)

このメソッドは、指定されたfeatures のセットがジオサービスプロバイダプラグインによってサポートされているかどうかを示すブール値を返します。指定されたすべてのfeatures がサポートされている場合はTrueが返され、そうでない場合はfalseが返されます。

features パラメータには、以下のフラグの任意の組み合わせを指定できます：

bool supportsRouting(RoutingFeatures features)

このメソッドは、指定されたfeatures のセットがジオサービスプロバイダプラグインによってサポートされているかどうかを示すブール値を返します。指定されたすべてのfeatures がサポートされている場合はTrueが返され、そうでない場合はfalseが返されます。

features パラメータには、以下のフラグの任意の組み合わせを指定できます：