Plugin QML Type
El tipo de complemento describe un complemento de servicios basados en la ubicación. Más información...
| Import Statement: | import QtLocation 6.12 |
| Since: | QtLocation 5.5 |
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é complemento de GeoServices disponible debe utilizarse para diversas tareas en la API de ubicación. Los complementos son utilizados por los tipos « Map », « RouteModel » y « GeocodeModel », así como por muchos otros.
Los complementos reconocidos por el sistema tienen una propiedad ` name `, una cadena simple que normalmente indica el nombre del servicio del que el complemento recupera datos. También cuentan con diversas características, que pueden comprobarse mediante los métodos ` supportsRouting()`, ` supportsGeocoding()`, ` supportsMapping()`, ` supportsPlaces()` y ` supportsNavigation()`.
Cuando se crea un objeto «Plugin», este está «desvinculado» y no está asociado a ningún complemento de servicio real. Una vez que haya recibido información mediante la configuración de sus propiedades « name », « preferred » o « required », elegirá un complemento de servicio adecuado al que vincularse. Los objetos «Plugin» solo pueden vincularse una vez; para utilizar varios complementos, crea varios objetos «Plugin».
Ejemplo de uso
El siguiente fragmento de código muestra la creación de un objeto Plugin con las propiedades required y preferred configuradas. Este Plugin se asociará al primer complemento que encuentre que admita tanto el mapeo como la geocodificación, y dará preferencia a los complementos denominados «here» u «osm» frente a cualquier otro.
Plugin {
id: plugin
preferred: ["here", "osm"]
required: Plugin.AnyMappingFeatures | Plugin.AnyGeocodingFeatures
}Documentación de las propiedades
allowExperimental : bool
Esta propiedad indica si se pueden utilizar complementos experimentales.
availableServiceProviders : stringlist
Esta propiedad contiene una lista con los nombres de todos los complementos de servicio disponibles. Se puede utilizar para enumerar manualmente los complementos disponibles si el control que ofrecen name y required no es suficiente para tus necesidades.
isAttached : bool
Esta propiedad indica si el elemento «Plugin» está asociado a un complemento de proveedor de geoservicios.
locales : stringlist
Esta propiedad contiene una lista ordenada de configuraciones regionales preferidas para los complementos. Si no es posible utilizar la primera configuración regional, el backend recurre a la segunda, y así sucesivamente. Por defecto, la propiedad «locales» contiene la configuración regional del sistema.
Las configuraciones regionales se especifican como cadenas con el formato «idioma[_alfabeto][_país]» o «C», donde:
- «language» es un código de idioma ISO 639 de dos letras en minúsculas,
- script es un código de escritura ISO 15924 de cuatro letras, con la primera letra mayúscula,
- país es un código de país ISO 3166 de dos o tres letras en mayúsculas (también «419», tal y como lo definen las Naciones Unidas),
- la configuración regional «C» tiene un comportamiento idéntico al de English/UnitedStates, según QLocale
Si no se puede atender la primera configuración regional especificada, el servidor de localizaciones ( Plugin ) recurre a la siguiente y así sucesivamente. Es posible que algunos servidores de localizaciones ( Plugin ) no admitan un conjunto de configuraciones regionales definidas de forma rígida. Un ejemplo arbitrario es que algunos Place en Francia podrían tener localizaciones en francés e inglés, mientras que en determinadas zonas de América quizá solo esté disponible la localización en inglés. En el escenario anterior, el conjunto de configuraciones regionales admitidas depende del contexto de la ubicación de la búsqueda.
Si el Plugin no puede adaptarse a ninguna de las configuraciones regionales preferidas, el gestor recurre a utilizar un idioma compatible específico del backend.
En el caso de los « Plugin » que no admiten configuraciones regionales, la lista de configuraciones regionales siempre estará vacía.
El siguiente código muestra cómo configurar una o 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 complemento. Al configurar esta propiedad, el complemento solo se asociará a un complemento que tenga exactamente este nombre. Se ignorará el valor de « required ».
parameters : list<PluginParameter> [default]
Esta propiedad contiene la lista de parámetros del complemento.
preferred : stringlist
Esta propiedad contiene una lista ordenada de nombres de complementos preferidos, que se comprobarán para ver si cumplen con el conjunto de características requeridas establecido en required antes de comprobar cualquier otro complemento disponible.
required : enumeration
Esta propiedad contiene el conjunto de características que el objeto Plugin requerirá a la hora de elegir a qué complemento de servicio se va a asociar. Si se establece la propiedad « name », esto no tiene ningún efecto.
Se puede establecer cualquiera de los siguientes valores o una combinación bit a bit de varios de ellos:
- Plugin.NoFeatures
- Plugin.GeocodingFeature
- Plugin.ReverseGeocodingFeature
- Plugin.RoutingFeature
- Plugin.MappingFeature
- Plugin.CualquierLugar
Documentación de métodos
bool supportsGeocoding(GeocodingFeatures features)
Este método devuelve un valor booleano que indica si el complemento del proveedor de servicios geográficos admite el conjunto especificado de « features ». Se devuelve « True » si se admiten todos los « features » especificados; en caso contrario, se devuelve « false ».
El parámetro features puede ser cualquier combinación de los siguientes indicadores:
| Característica | Descripción |
|---|---|
| Plugin.NoGeocodingFeatures | No se admite ninguna función de geocodificación. |
| Plugin.OnlineGeocodingFeature | Se admite la geocodificación en línea. |
| Plugin.OfflineGeocodingFeature | Se admite la geocodificación sin conexión. |
| Plugin.ReverseGeocodingFeature | Se admite la geocodificación inversa. |
| Plugin.LocalizedGeocodingFeature | Admite la devolución de resultados de geocodificación con direcciones localizadas. |
| Plugin.AnyGeocodingFeatures | Coincide con un proveedor de servicios geográficos que ofrezca cualquier función de geocodificación. |
bool supportsMapping(MappingFeatures features)
Este método devuelve un valor booleano que indica si el complemento del proveedor de servicios geográficos admite el conjunto especificado de « features ». Se devuelve «true» si se admiten todos los « features » especificados; en caso contrario, se devuelve «false».
El parámetro « features » puede ser cualquier combinación de los siguientes indicadores:
| Feature | Descripción |
|---|---|
| Plugin.NoMappingFeatures | No se admiten elementos de mapeo. |
| Plugin.OnlineMappingFeature | Se admite la cartografía en línea. |
| Plugin.OfflineMappingFeature | Se admite el mapeo sin conexión. |
| Plugin.LocalizedMappingFeature | Admite la devolución de datos de mapas localizados. |
| Plugin.AnyMappingFeatures | Coincide con un proveedor de servicios geográficos que ofrece cualquier función de mapas. |
bool supportsNavigation(NavigationFeatures features)
Este método devuelve un valor booleano que indica si el complemento del proveedor de servicios geográficos admite el conjunto especificado de « features ». Se devuelve «true» si se admiten todos los « features » especificados; en caso contrario, se devuelve «false».
El parámetro features puede ser cualquier combinación de los siguientes indicadores:
| Feature | Descripción |
|---|---|
| Plugin.NoNavigationFeatures | No se admiten funciones de navegación. |
| Plugin.OnlineNavigationFeature | Se admite la navegación en línea. |
| Plugin.OfflineNavigationFeature | Se admite la navegación sin conexión. |
| Plugin.AnyNavigationFeatures | Coincide con un proveedor de servicios geográficos que ofrece cualquier función de navegación. |
bool supportsPlaces(PlacesFeatures features)
Este método devuelve un valor booleano que indica si el complemento del proveedor de servicios geográficos admite el conjunto especificado de « features ». Se devuelve «True» si se admiten todas las « features » especificadas; en caso contrario, se devuelve «False».
El parámetro « features » puede ser cualquier combinación de los siguientes indicadores:
| Feature | Descripción |
|---|---|
| Plugin.NoPlacesFeatures | No se admiten características de lugares. |
| Plugin.OnlinePlacesFeature | Se admiten lugares en línea. |
| Plugin.OfflinePlacesFeature | Se admiten las funciones de lugares sin conexión. |
| Plugin.SavePlaceFeature | Se admite el guardado de categorías. |
| Plugin.RemovePlaceFeature | Se admite la eliminación de lugares. |
| Plugin.PlaceRecommendationsFeature | Se admite la búsqueda de lugares recomendados similares a otro lugar. |
| Plugin.SearchSuggestionsFeature | Se admiten las sugerencias de búsqueda. |
| Plugin.LocalizedPlacesFeature | Admite la devolución de datos de lugares localizados. |
| Plugin.NotificationsFeature | Se admiten notificaciones de cambios en lugares y categorías. |
| Plugin.PlaceMatchingFeature | Admite la coincidencia de lugares de dos proveedores de servicios geográficos diferentes. |
| Plugin.AnyPlacesFeatures | Busca un proveedor de servicios geográficos que ofrezca cualquier tipo de características de lugares. |
bool supportsRouting(RoutingFeatures features)
Este método devuelve un valor booleano que indica si el complemento del proveedor de servicios geográficos admite el conjunto especificado de « features ». Se devuelve «True» si se admiten todos los « features » especificados; en caso contrario, se devuelve «False».
El parámetro ` features ` puede ser cualquier combinación de los siguientes indicadores:
| Feature | Descripción |
|---|---|
| Plugin.NoRoutingFeatures | No se admiten funciones de cálculo de rutas. |
| Plugin.OnlineRoutingFeature | Se admite el cálculo de rutas en línea. |
| Plugin.OfflineRoutingFeature | Se admite el cálculo de rutas sin conexión. |
| Plugin.LocalizedRoutingFeature | Admite la devolución de rutas con direcciones e instrucciones localizadas. |
| Plugin.RouteUpdatesFeature | Se admite la actualización de una ruta existente en función de la posición actual. |
| Plugin.AlternativeRoutesFeature | Permite devolver rutas alternativas. |
| Plugin.ExcludeAreasRoutingFeature | Permite especificar áreas por las que la ruta devuelta no debe pasar. |
| Plugin.AnyRoutingFeatures | Coincide con un proveedor de servicios geográficos que ofrezca cualquier función de cálculo de rutas. |
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.