Importación de directorios de documentos QML

Se puede importar un directorio local de archivos QML sin ninguna configuración adicional. También se puede importar un directorio remoto de archivos QML, pero es necesario que exista un directorio que enumere el archivo qmldir. Un directorio local puede contener opcionalmente un archivo de listado de directorios qmldir para definir los nombres de tipo que deben proporcionarse a los clientes que importen el directorio y para especificar los recursos JavaScript que deben ponerse a disposición de los importadores.

Importación de directorios locales

Cualquier archivo QML del sistema de archivos local puede importar un directorio local mediante una sentencia import que haga referencia a la ruta absoluta o relativa del sistema de archivos del directorio, lo que permite al archivo utilizar los tipos de objeto definidos en ese directorio.

Si el directorio local contiene un archivo qmldir de listado de directorios, los tipos estarán disponibles con los nombres de tipo especificados en el archivo qmldir; de lo contrario, estarán disponibles con nombres de tipo derivados de los nombres de archivo de los documentos QML. Sólo se expondrán como tipos los nombres de archivo que empiecen por mayúscula y terminen en ".qml" si no se especifica ningún archivo qmldir en el directorio.

Las importaciones de directorios tienen prioridad sobre las importaciones de módulos. Si se define el mismo nombre en un módulo y en un directorio, ambos importados en el mismo espacio de nombres, sólo estará disponible el tipo del módulo.

Un ejemplo

Considere la siguiente estructura de directorios del proyecto QML. Bajo el directorio de nivel superior myapp, hay un conjunto de componentes comunes de interfaz de usuario en un subdirectorio denominado mycomponents, y el código principal de la aplicación en un subdirectorio denominado main, de la siguiente manera:

myapp
    |- mycomponents
        |- CheckBox.qml
        |- DialogBox.qml
        |- Slider.qml
    |- main
        |- application.qml

El archivo main/application.qml puede importar el directorio mycomponents utilizando la ruta relativa a ese directorio, lo que le permite utilizar los tipos de objeto QML definidos dentro de ese directorio:

import "../mycomponents"

DialogBox {
    CheckBox {
        // ...
    }
    Slider {
        // ...
    }
}

El directorio puede importarse en un espacio de nombres local cualificado, en cuyo caso los usos de cualquier tipo proporcionado en el directorio deben ser cualificados:

import "../mycomponents" as MyComponents

MyComponents.DialogBox {
    // ...
}

La posibilidad de importar un directorio local es conveniente para casos como los conjuntos de componentes dentro de la aplicación y la creación de prototipos de aplicaciones, aunque cualquier código que importe dichos módulos debe actualizar sus declaraciones import pertinentes si el directorio de módulos se traslada a otra ubicación. Esto puede evitarse si en su lugar se utilizan módulos QML, ya que un módulo instalado se importa con una cadena de identificador único en lugar de una ruta del sistema de archivos.

Importación implícita

El directorio en el que reside un documento QML se importa automáticamente. No es necesario importar explícitamente "." o similares.

Directorios ubicados remotamente

Un directorio de archivos QML también puede importarse desde una ubicación remota si el directorio contiene un archivo qmldir de listado de directorios.

Por ejemplo, si el directorio myapp del ejemplo anterior estuviera alojado en "http://www.my-example-server.com", y el directorio mycomponents contuviera un archivo qmldir definido como sigue:

CheckBox CheckBox.qml
DialogBox DialogBox.qml
Slider Slider.qml

Entonces, el directorio podría importarse utilizando la URL del directorio remoto mycomponents:

import "http://www.my-example-server.com/myapp/mycomponents"

DialogBox {
    CheckBox {
        // ...
    }
    Slider {
        // ...
    }
}

Tenga en cuenta que cuando un archivo importa un directorio a través de una red, sólo puede acceder a los archivos QML y JavaScript especificados en el archivo qmldir ubicado en el directorio.

Archivos qmldir de listado de directorios

Un archivo qmldir de listado de directorios es claramente diferente de un archivo qmldir de definición de módulo. Un archivo de listado de directorios qmldir permite compartir rápida y fácilmente un grupo de documentos QML, pero no define un espacio de nombres de tipos en el que se registren los tipos de objetos QML definidos por los documentos, ni admite el control de versiones de dichos tipos de objetos QML.

La sintaxis de un archivo de listado de directorios qmldir es la siguiente:

RoundedButton RoundedBtn.qml

internal HighlightedButton HighlightedBtn.qml

MathFunctions mathfuncs.js

Un directorio del sistema de archivos local puede incluir opcionalmente un archivo qmldir. Esto permite que el motor sólo exponga determinados tipos de QML a los clientes que importen el directorio. Además, los recursos JavaScript del directorio no se exponen a los clientes a menos que se declaren en un archivo qmldir.