Тип плагина QML

Тип плагина описывает плагин сервисов местоположения. Подробнее...

• Список всех членов, включая унаследованные

Свойства

• allowExperimental : bool
• availableServiceProviders : stringlist
• isAttached : bool
• locales : stringlist
• имя : string
• параметры : list<PluginParameter>
• предпочитаемые : stringlist
• необходимые : перечисление

Методы

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

Подробное описание

Тип плагина используется для декларативного указания того, какой доступный плагин GeoServices следует использовать для различных задач в API Location. Плагины используются типами Map, RouteModel и GeocodeModel, а также многими другими.

Плагины, распознаваемые системой, имеют свойство имя, представляющее собой строку, обычно указывающую имя сервиса, из которого плагин получает данные. Они также обладают различными функциями, которые можно проверить с помощью методов supportsRouting(), supportsGeocoding(), supportsMapping() и supportsPlaces().

При создании объекта Plugin он «откреплён» и не связан с каким-либо фактическим плагином сервиса. После получения информации путем установки свойств имя, предпочитаемые или необходимые, он выберет соответствующий плагин сервиса для присоединения. Объекты плагинов могут быть подключены только один раз; для использования нескольких плагинов создайте несколько объектов Plugin.

Пример использования

Следующий фрагмент показывает создание объекта Plugin со свойствами необходимые и предпочитаемые установленных. Этот плагин подключится к первому найденному плагину, который поддерживает как отображение, так и геокодирование, и будет отдавать предпочтение плагинам с именем «here» или «osm» перед другими.

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

Документация по свойствам

allowExperimental : bool

Это свойство указывает, можно ли использовать экспериментальные плагины.

availableServiceProviders : stringlist

Это свойство содержит список имен всех доступных плагинов сервисов. Это можно использовать для ручного перечисления доступных плагинов, если управление, предоставляемое свойствами имя и необходимые, недостаточно для ваших нужд.

isAttached : bool

Это свойство указывает, подключен ли элемент Plugin к плагину провайдера геосервисов.

locales : stringlist

Это свойство содержит упорядоченный список предпочтительных языковых локалей плагина. Если первая локаль не поддерживается, то бэкэнд использует вторую и так далее. По умолчанию свойство locales содержит системную локаль.

Локали задаются в виде строк формата "язык[_скрипт][_страна]" или "C", где:

• язык — двухбуквенный код языка в нижнем регистре, ISO 639,
• скрипт — четырехбуквенный код скрипта в верхнем регистре, ISO 15924,
• страна — двух- или трехбуквенный код страны в верхнем регистре, ISO 3166 (также «419» по определению Организации Объединенных Наций),
• локаль "C" эквивалентна по поведению английской/американской, как в QLocale

Если первая указанная локаль не поддерживается, плагин Plugin переходит к следующей и так далее. Некоторые бэкэнды плагинов Plugin могут не поддерживать набор локалей, которые строго определены. Примером является то, что некоторые Place'ы во Франции могут иметь французскую и английскую локализации, в то время как в некоторых районах Америки может быть доступна только английская локализация. В приведенном выше сценарии набор поддерживаемых локалей зависит от контекста местоположения поиска.

Если плагин Plugin не поддерживает ни одну из предпочтительных локалей, менеджер использует поддерживаемый язык, специфичный для бэкэнда.

Для плагинов Plugin, которые не поддерживают локали, список локалей всегда пуст.

Следующий код демонстрирует, как задать одну и несколько локалей:

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

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

имя : string

Это свойство содержит имя плагина. Установка этого свойства приведет к подключению плагина только к плагину с этим именем. Значение необходимые будет проигнорировано.

[по умолчанию] параметры : list<PluginParameter>

Это свойство содержит список параметров плагина.

предпочитаемые : stringlist

Это свойство содержит упорядоченный список предпочтительных имен плагинов, которые будут проверяться на наличие необходимых функций, заданных в свойстве необходимые, прежде чем будут проверены другие доступные плагины.

необходимые : перечисление

Это свойство содержит набор функций, которые будут необходимы объекту Plugin при выборе плагина сервиса для подключения. Если свойство имя установлено, это свойство не влияет.

Можно установить любое из следующих значений или произвольную комбинацию нескольких значений:

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

Документация по методам

bool supportsGeocoding(GeocodingFeatures features)

Этот метод возвращает булево значение, указывающее, поддерживает ли плагин геосервисов указанный набор features. Возвращается true, если все указанные features поддерживаются; в противном случае возвращается false.

Параметр features может быть любой комбинацией флагов:

bool supportsMapping(MappingFeatures features)

Этот метод возвращает булево значение, указывающее, поддерживает ли плагин геосервисов указанный набор features. Возвращается true, если все указанные features поддерживаются; в противном случае возвращается false.

Параметр features может быть любой комбинацией флагов:

bool supportsPlaces(PlacesFeatures features)

Этот метод возвращает булево значение, указывающее, поддерживает ли плагин геосервисов указанный набор features. Возвращается true, если все указанные features поддерживаются; в противном случае возвращается false.

Параметр features может быть любой комбинацией флагов:

bool supportsRouting(RoutingFeatures features)

Этот метод возвращает логическое значение, указывающее, поддерживается ли указанный набор функций плагином геосервиса. Возвращает true, если все указанные функции поддерживаются; в противном случае возвращает false.

Параметр features может быть любой комбинацией флагов: