Тип плагина QML

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

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

Свойства

• allowExperimental : bool
• availableServiceProviders : stringlist
• isAttached : bool
• locales : stringlist
• name : string
• parameters : list<PluginParameter>
• preferred : stringlist
• required : перечисление

Методы

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

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

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

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

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

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

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

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

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

allowExperimental : bool

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

availableServiceProviders : stringlist

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

isAttached : bool

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

locales : stringlist

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

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

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

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

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

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

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

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

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

name : string

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

[default] parameters : list<PluginParameter>

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

preferred : stringlist

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

required : enumeration

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

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

• 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 supportsNavigation(NavigationFeatures features)

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

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

bool supportsPlaces(PlacesFeatures features)

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

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

bool supportsRouting(RoutingFeatures features)

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

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