Plugin QML Type

El tipo Plugin describe un plugin de servicios basados en la localización. Más...

Import Statement:	`import QtLocation 6.11`
Since:	QtLocation 5.5

Lista de todos los miembros, incluidos los heredados

Propiedades

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

Métodos

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

Descripción detallada

El tipo Plugin se utiliza para especificar de forma declarativa qué plugin de GeoServices disponible debe utilizarse para diversas tareas en la API de Localización. Los plugins son utilizados por los tipos Map, RouteModel, y GeocodeModel, así como por una variedad de otros.

Los plugins reconocidos por el sistema tienen una propiedad name, una simple cadena que normalmente indica el nombre del servicio del que el plugin recupera datos. También tienen una variedad de características, que pueden comprobarse mediante los métodos supportsRouting(), supportsGeocoding(), supportsMapping(), supportsPlaces() y supportsNavigation().

Cuando se crea un objeto Plugin, es "independiente" y no está asociado a ningún plugin de servicio real. Una vez que haya recibido información a través de sus propiedades name, preferred, o required, elegirá un plugin de servicio apropiado al que asociarse. Los objetos Plugin sólo pueden adjuntarse una vez; para utilizar varios plugins, cree varios objetos Plugin.

Ejemplo de uso

El siguiente fragmento muestra la creación de un objeto Plugin con las propiedades required y preferred. Este Plugin se adjuntará al primer plugin encontrado que soporte tanto mapeo como geocodificación, y preferirá los plugins llamados "here" u "osm" a cualquier otro.

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

Documentación de propiedades

allowExperimental : bool

Esta propiedad indica si se pueden utilizar plugins experimentales.

availableServiceProviders : stringlist

Esta propiedad contiene una lista de todos los nombres de los plugins de servicio disponibles. Se puede utilizar para enumerar manualmente los plugins disponibles si el control proporcionado por name y required no es suficiente para sus necesidades.

isAttached : bool

Esta propiedad indica si el elemento Plugin está unido a un plugin proveedor de geoservicios.

locales : stringlist

Esta propiedad contiene una lista ordenada de las configuraciones regionales preferidas. Si no se puede utilizar la primera configuración regional, el servidor pasa a utilizar la segunda, y así sucesivamente. Por defecto, la propiedad locales contiene la configuración regional del sistema.

Las configuraciones regionales se especifican como cadenas que tienen el formato "language[_script][_country]" o "C", donde:

language es un código de idioma ISO 639 de dos letras en minúscula,
script es un código de escritura ISO 15924, de cuatro letras y en mayúsculas,
country es un código de país ISO 3166 de dos o tres letras en mayúscula (también "419" según la definición de las Naciones Unidas),
la configuración regional "C" tiene un comportamiento idéntico al de English/UnitedStates según la norma QLocale

Si no se puede utilizar la primera configuración regional especificada, Plugin pasa a la siguiente y así sucesivamente. Es posible que algunos backends de Plugin no admitan un conjunto de configuraciones regionales definidas de forma rígida. Un ejemplo arbitrario es que algunos Place en Francia pueden tener localizaciones en francés e inglés, mientras que ciertas áreas en América pueden tener sólo disponible la localización en inglés. En el escenario anterior, el conjunto de localizaciones admitidas depende del contexto de la ubicación de búsqueda.

Si Plugin no puede acomodar ninguna de las localizaciones preferidas, el gestor vuelve a utilizar un idioma soportado que es específico del backend.

Para Plugin's que no soportan locales, la lista de locales está siempre vacía.

El siguiente código muestra cómo establecer una y varias configuraciones regionales:

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

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

name : string

Esta propiedad contiene el nombre del plugin. Establecer esta propiedad hará que el plugin sólo se adjunte a un plugin con exactamente este nombre. El valor de required será ignorado.

parameters : list<PluginParameter> `[default]`

Esta propiedad contiene la lista de parámetros del plugin.

preferred : stringlist

Esta propiedad contiene una lista ordenada de nombres de plugins preferidos, que se comprobarán para las características requeridas establecidas en required antes de comprobar cualquier otro plugin disponible.

required : enumeration

Esta propiedad contiene el conjunto de características que serán requeridas por el objeto Plugin cuando elija a qué plugin de servicio adjuntarlo. Si la propiedad name está establecida, esto no tiene efecto.

Puede establecerse cualquiera de los siguientes valores o una combinación bit a bit de múltiples valores:

Plugin.NoFeatures
Plugin.GeocodingFeature
Plugin.ReverseGeocodingFeature (función de geocodificación inversa)
Plugin.RoutingFeature
Plugin.MappingFeature
Plugin.AnyPlacesFeature

Documentación de métodos

bool supportsGeocoding(GeocodingFeatures features)

Este método devuelve un booleano que indica si el conjunto especificado de features es compatible con el complemento de proveedor de servicios geográficos. Se devuelve True si todos los features especificados son compatibles; en caso contrario, se devuelve false.