En esta página

qt_query_qml_module

Recuperar información sobre un módulo QML.

El comando está definido en el componente « Qml » del paquete « Qt6 », que se puede cargar de la siguiente manera:

find_package(Qt6 REQUIRED COMPONENTS Qml)

Este comando se introdujo en Qt 6.3.

Sinopsis

qt_query_qml_module(
    target
    [URI uri_var]
    [VERSION version_var]
    [PLUGIN_TARGET plugin_target_var]
    [TARGET_PATH target_path_var]
    [MODULE_RESOURCE_PATH module_resource_path_var]
    [QMLDIR qmldir_var]
    [TYPEINFO typeinfo_var]
    [QML_FILES qml_files_var]
    [QML_FILES_DEPLOY_PATHS qml_files_deploy_paths_var]
    [QML_FILES_PREFIX_OVERRIDES qml_files_prefix_overrides_var]
    [RESOURCES resources_var]
    [RESOURCES_DEPLOY_PATHS resources_deploy_paths_var]
    [RESOURCES_PREFIX_OVERRIDES resources_prefix_overrides_var]
)

Si los comandos sin versión están desactivados, utiliza en su lugar qt6_query_qml_module(). Admite el mismo conjunto de argumentos que este comando.

Descripción

Este comando se utiliza para obtener información sobre un módulo QML target. Dicho target debe haber sido creado previamente o pasado a una llamada anterior a qt_add_qml_module(). El target no puede ser un objetivo importado.

La información proporcionada por este comando permite al usuario desplegar todas las partes de un único módulo QML. El proyecto debe instalar el target y el objetivo de complemento asociado (si el módulo tiene uno y está separado del target subyacente) utilizando el comando estándar install(TARGETS). Todo lo demás se puede desplegar con install(FILES).

Argumentos

Cada uno de los argumentos opcionales especifica el nombre de una variable en la que se almacenará la propiedad correspondiente del módulo QML.

URI y ` VERSION ` proporcionan la URI y la versión del módulo, respectivamente.

PLUGIN_TARGET se puede utilizar para obtener el nombre del destino del complemento para el módulo QML. No todos los módulos QML tienen un complemento, por lo que el valor devuelto para esta opción podría ser una cadena vacía. Si el módulo QML no tiene un destino de respaldo independiente, entonces target será el mismo que el destino del complemento.

TARGET_PATH es el URI con los puntos (.) sustituidos por barras (/). Representa la ruta situada bajo el directorio de instalación base del módulo QML donde debe implementarse el archivo qmldir de este módulo QML (y posiblemente otros). El directorio de instalación del módulo QML sirve como ruta de importación de QML donde el motor QML buscará los módulos QML. El directorio base predeterminado de instalación de módulos QML utilizado por qt_generate_deploy_qml_app_script() es qml. Un proyecto que utilice un script de implementación puede emplear QT_DEPLOY_QML_DIR en lugar de codificar esta ubicación de forma fija (véase también QT_DEPLOY_PREFIX).

MODULE_RESOURCE_PATH Proporciona la ruta de recursos en la que se pueden encontrar los archivos compilados del módulo QML. Se forma a partir de ` RESOURCE_PREFIX ` de ` qt_add_qml_module()` concatenado con ` TARGET_PATH` del módulo. El valor consultado no debe utilizarse para el despliegue, pero puede resultar útil para relacionar las rutas de recursos con las ubicaciones del sistema de archivos, si fuera necesario.

QMLDIR Proporciona la ruta al archivo ` qmldir `. Al implementar el módulo QML, este archivo debe copiarse en la ruta de destino. En un script de implementación, esta ubicación puede obtenerse utilizando ` ${QT_DEPLOY_PREFIX}/${QT_DEPLOY_QML_DIR}`.

TYPEINFO Proporciona la ruta al archivo «typeinfo» del módulo, si lo tiene. Será una cadena vacía si el módulo no tiene ningún archivo «typeinfo». El archivo «typeinfo» debe implementarse en la misma ruta que el archivo « qmldir ».

QML_FILES Proporciona una lista de todos los archivos añadidos al módulo QML mediante uno de los siguientes métodos:

Todos los archivos se registrarán con rutas absolutas.

QML_FILES_DEPLOY_PATHS Proporciona una lista con exactamente el mismo número de elementos que ` QML_FILES`. Cada elemento de la lista ` QML_FILES_DEPLOY_PATHS ` es la ruta situada por debajo de la ruta de destino donde debe implementarse el elemento correspondiente de ` QML_FILES `. Las rutas de ` QML_FILES_DEPLOY_PATHS ` incluyen el nombre del archivo, ya que este podría ser diferente al nombre del archivo de ` QML_FILES ` debido al uso de alias de recursos (véase QT_RESOURCE_ALIAS).

Las entradas de QML_FILES_DEPLOY_PATHS también pueden ser una cadena vacía. Cualquier archivo añadido mediante qt_target_qml_sources() con un prefijo personalizado PREFIX no tendrá ruta de implementación, ya que el uso de un prefijo personalizado suele significar que el archivo se encuentra fuera de la ruta de destino del módulo QML.

QML_FILES_PREFIX_OVERRIDES proporciona otra lista con exactamente el mismo número de elementos que QML_FILES. Cuando se haya añadido un archivo con un prefijo personalizado, tal y como se describe en el párrafo anterior, su entrada correspondiente en la lista QML_FILES_PREFIX_OVERRIDES contendrá el prefijo personalizado utilizado. Para el resto de archivos, sus entradas en la lista serán una cadena vacía.

Nota: Como caso especial, si solo hay un archivo en la lista QML_FILES, entonces QML_FILES_DEPLOY_PATHS o QML_FILES_PREFIX_OVERRIDES pueden ser una cadena vacía, dependiendo de si ese archivo tiene un prefijo personalizado. Esto se debe a que la forma en que CMake representa las listas y las cadenas hace que sea imposible distinguir entre una cadena vacía y una lista con un único elemento vacío.

Las opciones RESOURCES, RESOURCES_DEPLOY_PATHS y RESOURCES_PREFIX_OVERRIDES son análogas a las de QML_FILES mencionadas anteriormente. RESOURCES proporciona una lista de todos los archivos añadidos al módulo QML como argumentos de RESOURCES para qt_add_qml_module() o qt_target_qml_sources(). Todas las rutas serán absolutas. El significado y el uso de RESOURCES_DEPLOY_PATHS y RESOURCES_PREFIX_OVERRIDES siguen los mismos patrones que QML_FILES_DEPLOY_PATHS y QML_FILES_PREFIX_OVERRIDES, respectivamente.

Ejemplo

cmake_minimum_required(VERSION 3.16...3.22)
project(MyThings)

find_package(Qt6 6.3 REQUIRED COMPONENTS Core Qml)

set(module_name "MyThings")
qt_add_qml_module(${module_name}
    URI My.Things
    VERSION 1.3
    RESOURCE_PREFIX org.mycompany/imports
    QML_FILES
        First.qml
        Second.qml
    RESOURCES
        Third.txt
)

qt_query_qml_module(${module_name}
    URI module_uri
    VERSION module_version
    PLUGIN_TARGET module_plugin_target
    TARGET_PATH module_target_path
    QMLDIR module_qmldir
    TYPEINFO module_typeinfo
    QML_FILES module_qml_files
    QML_FILES_DEPLOY_PATHS qml_files_deploy_paths
    RESOURCES module_resources
    RESOURCES_DEPLOY_PATHS resources_deploy_paths
)

message("My QML module URI is: ${module_uri}")
message("My QML module version is: ${module_version}")

# Install the QML module backing library
set(staging_prefix "staging")
install(TARGETS ${module_name}
    ARCHIVE DESTINATION "${staging_prefix}/${CMAKE_INSTALL_LIBDIR}"
    LIBRARY DESTINATION "${staging_prefix}/${CMAKE_INSTALL_LIBDIR}"
    RUNTIME DESTINATION "${staging_prefix}/${CMAKE_INSTALL_BINDIR}"
)
set(module_dir "${staging_prefix}/qml/${module_target_path}")

# Install the QML module runtime loadable plugin
install(TARGETS "${module_plugin_target}"
    LIBRARY DESTINATION "${module_dir}"
    RUNTIME DESTINATION "${module_dir}"
)

# Install the QML module meta information.
install(FILES "${module_qmldir}"   DESTINATION "${module_dir}")
install(FILES "${module_typeinfo}" DESTINATION "${module_dir}")

# Install QML files, possibly renamed.
list(LENGTH module_qml_files num_files)
math(EXPR last_index "${num_files} - 1")
foreach(i RANGE 0 ${last_index})
    list(GET module_qml_files       ${i} src_file)
    list(GET qml_files_deploy_paths ${i} deploy_path)
    get_filename_component(dst_name "${deploy_path}" NAME)
    get_filename_component(dest_dir "${deploy_path}" DIRECTORY)
    install(FILES "${src_file}" DESTINATION "${module_dir}/${dest_dir}" RENAME "${dst_name}")
endforeach()

# Install resources, possibly renamed.
list(LENGTH module_resources num_files)
math(EXPR last_index "${num_files} - 1")
foreach(i RANGE 0 ${last_index})
    list(GET module_resources       ${i} src_file)
    list(GET resources_deploy_paths ${i} deploy_path)
    get_filename_component(dst_name "${deploy_path}" NAME)
    get_filename_component(dest_dir "${deploy_path}" DIRECTORY)
    install(FILES "${src_file}" DESTINATION "${module_dir}/${dest_dir}" RENAME "${dst_name}")
endforeach()

© 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.