VExtension

Este clase representa la extensión en Velneo vDevelop. Dispone de funciones para ver información de los proyectos, acceso a la solución, etc.

El objeto theExtension

Todos los scripts de extensiones en Velneo vDevelop están conectados a un objeto global y único que representa la extensión cuyo nombre es theExtension. Para ello, debemos incluir en nuestro código QML el import correspondiente:

import VExtensions 2.0

También está disponible el objeto theApp en Velneo vDevelop, a través de la función theApp() de esta clase, del cuál podemos usar las funciones que tienen sentido en edición.

Los grupos de funciones disponibles son: generales, proyectos, cursor, constantes, DOS: directorios, DOS: ficheros, info local actual, info local del sistema, impresoras, multimedia y la función sysInfo. Los grupos no disponibles son: variables globales, variables globales array, variables de sistema, sistema, mantenimiento de Base de datos, tablas estáticas, cestas, impresión de informes, mensajería interna, vista de datos, estilos, TLS/SSL.

También podemos hacer uso de lo siguiente para tener acceso al espacio de nombres de la API de Velneo para Javascript:

.import VExtensions 2.0 as VExtensions

Y así podemos usar por ejemplo un elemento de un enum:

VExtensions.VObjectInfo.TypeTable

Herencia

Hay que tener en cuenta que la extensión da acceso al proyecto principal con el que se ha arrancado la aplicación y todos sus objetos heredados lo que permite el acceso y uso de cualquier objeto de la aplicación desde cualquier script.

Está disponible en scripts ejecutados en Velneo vDevelop.

Indice de funciones

De aplicación

theApp theApp()

De configuración

void executeExtension( String szExtension )

String extensionDirPath()

void setAutoClose( Boolean bAutoCerrar )

void setDialog( Boolean bDialogo )

void setFixedSize( Boolean bFijo )

De ventana

void close()

void setWindowTypeFlags( flags )

De conexión

Number connectServer( String szVRL, String szUsuario, String, szContraseña )

Boolean connectServerDialog( String szVRL, String szUsuario, String, szContraseña )

Boolean isConnected()

De solución

VSolutionInfo currentSolutionInfo()

VSolutionInfo newSolution()

void openSolution( String szVRL, String szUsuario, String, szContraseña )

void openSolutionDialog()

Boolean runInstallWizard( String szSendaInstalador )

void runSolution()

Array solutionInfos()

De proyecto

VProjectInfo currentProjectInfo()

Number projectCount( Number nProjectType )

VProjectInfo projectInfo( Number nProjectType, int index)

Array projectInfos( Number nProjectType )

void openProject( VProjectInfo projectInfo, Boolean bOpenTabs )

void openProjectReadOnly( VProjectInfo projectInfo, Boolean bOpenTabs)

De objeto

VObjectInfo currentObjecInfo()

void openObject( VObjectInfo objectInfo )

Array searchObjects([Array de VProjectInfo], szTtexto, number caseSensitive)

De instancias

VInstanceList appInstances( VSolutionInfo solucion )

VInstanceList datInstances( VSolutionInfo solucion )

De directorios

VDir newDir()

De ficheros

VFile newFile( String szSenda )

VTextFile newTextFile( String szSenda )

De sistema

VClipboard clipboard()

VSettings newSettings( String szOrganizacion, String szAplicacion )

De base de datos externas

VSqlDataBase newSqlDatabase()

De webservice

XMLHttpRequest newXMLHttpRequest()

Documentación de funciones

Funciones de aplicación

theApp()

Devuelve el objeto theApp correspondiente en cada momento.

Funciones de configuración

String extensionDirPath()

Devuelve la senda en disco de la extensión en curso.

void executeExtension( String szExtension )

Ejecuta la extensión que pasemos como parámetro.

Parámetros:

• szExtension: nombre de la extensión a ejecutar.

void setAutoClose( Boolean bAutoCerrar )

Establece que la ventana de la extensión en curso se cierre cuando cambiamos de proyecto.

Parámetros:

• bAutoCerrar: true o false para definir si queremos que se cierre de forma automática al cambiar de proyecto o no.

void setDialog( Boolean bDialogo )

Establece que la ventana de la extensión en curso se muestre construya en modo diálogo.

Parámetros:

• bDialogo: true o false para definir si queremos que la extensión se construya en modo diálogo o no.

Ha de usarse en la construcción del componente QML principal para que tenga efecto.

void setFixedSize( Boolean bFijo )

Establece cuando la ventana está en diálogo si es posible redimensionarla o no.

Parámetros:

• bFijo: booleano que define si es fijo (true) o redimensionable (false).

Funciones de ventana

void close()

Cierra la ventana de la extensión, finalizando su ejecución.

void setWindowTypeFlags( flags )

Establece la configuración de la ventana cuando está en diálogo.

Parámetros:

• flags: flags que definen las opciones disponibles. Ver enum de flags.

El soporte y correcto funcionamiento de los flags depende enteramente del sistema operativo.

Funciones de conexión

Number connectServer( String szVRL, String szUsuario, String, szContraseña )

Conecta con el servidor de Velneo cuya URL indicamos como parámetro, usando el usuario y contraseña especificados.

Parámetros:

• szVRL: VRL del servidor: "vatps://dominio_ip:puerto".

• szUsuario: nombre del usuario.

• szContraseña: contraseña del usuario.

Para retorno de errores ver enum de Errores de conexión.

Boolean connectServerDialog( String szVRL, String szUsuario, String, szContraseña )

Muestra el cuadro de diálogo estándar de conexión con el servidor de Velneo.

Parámetros:

• szVRL: VRL del servidor: "vatps://dominio_ip:puerto".

• szUsuario: nombre del usuario.

• szContraseña: contraseña del usuario.

Retorna true si se ha realizado la conexión, false si no se ha realizado y el usuario cancela.

Si tiene cubiertos los 3 parámetros se conectará directamente.

Y Si tiene cubiertos los 3 parámetros y no es posible realizar la conexión se mostrará el cuadro de diálogo con el error.

Y Si no tiene cubiertos los 3 parámetros se mostrará siempre el cuadro de diálogo con los datos recibidos.

Boolean isConnected()

Retorna true o false en función de si estamos conectados con el servidor de Velneo o no.

Funciones de solución

VSolutionInfo currentSolutionInfo()

Devuelve un objeto VSolutionInfo de la solución en curso.

VSolutionInfo newSolution()

Abre el cuadro de diálogo de nueva solución.

void openSolution( String szVRL, String szUsuario, String, szContraseña )

Abre la solución cuya VRL pasemos como parámetro.

Parámetros:

• szVRL: vrl de la solución a abrir. Debe seguir la siguiente sintaxis:

vatps://IP_SERVIDOR///NOMBRE_SOLUCION")

• szUsuario: nombre del usuario.

• szContraseña: contraseña del usuario.

Si tiene cubiertos los 3 parámetros se conectará directamente y abrirá la solución.

Y Si tiene cubiertos los 3 parámetros y no es posible realizar la conexión se mostrará el cuadro de diálogo con el error.

Y Si no tiene cubiertos los 3 parámetros se mostrará siempre el cuadro de diálogo con los datos recibidos.

Ejemplo:

theExtension.openSolution("vatps://127.0.0.1///vERP_2", "velneo", "1234")

void openSolutionDialog()

Abre el cuadro de diálogo "abrir solución" de Velneo vDevelop. En el caso de que no estemos conectados con un servidor, presentará antes la ventana de conexión con el servidor.

Boolean runInstallWizard( String szSendaInstalador )

Inicia el asistente de instalación de un fichero con extensión .vin que indiquemos como parámetro.

Parámetros:

• szSendaInstalador: senda del instalador .vin que vamos a instalar.

void runSolution()

Inicia la ejecución de la solución en curso. Debe tener instancias creadas previamente.

Array solutionsInfos()‌

Devuelve un array con los VSolutionInfo de todas las soluciones que están abiertas en Velneo vDevleop.

Funciones de proyecto

VProjectInfo currentProjectInfo()

Devuelve el objeto VProjectInfo del proyecto principal en curso.

Number projectCount( Number nProjectType )

Devuelve el número de proyectos cargados en ese momento en Velneo vDevelop del tipo que pasemos como parámetro.

Parámetros:

• nProjectType: tipo de proyecto. Ver enum de tipos de proyecto.

Sólo es funcional en extensiones de Velneo vDevelop.

VProjectInfo projectInfo( Number nProjectType, int index)

Devuelve un objeto de la clase VProjectInfo correspondiente al tipo de proyecto (datos o aplicación) y a la posición de la lista de proyectos encontrados con la función projectCount.

Parámetros:

• nProjectType: tipo de proyecto. Ver enum de tipos de proyecto.

• index: número del proyecto, se suele usar un bucle for para recorrerlos.

Array projectInfos( Number nProjectType )

‌ Devuelve un array que contiene los VProjectInfo de todos los proyectos cargados en la aplicación.

Parámetros:

• nProjectType: tipo de proyecto. Ver enum de tipos de proyecto.

void openProject( VProjectInfo projectInfo, Boolean bOpenTabs )

Abre el proyecto en el editor cuyo puntero pasamos como parámetro.

Parámetros:

• projectInfo: objeto correspondiente al proyecto.

• bOpenTabs: si se pone a false evita que se abran las pestañas del proyecto cuando se abre.

void openProjectReadOnly( VProjectInfo projectInfo, Boolean bOpenTabs)

Abre en el editor en modo de solo lectura el proyecto cuyo puntero pasamos como parámetro.

Parámetros:

projectInfo: objeto correspondiente al proyecto.

bOpenTabs: si se pone a false evita que se abran las pestañas del proyecto cuando se abre.

Funciones de objeto

VObjectInfo currentObjectInfo()

Permite acceder al objeto seleccionado en el editor en el proyecto en curso, retornando el correspondiente VObjectInfo.

void openObject( VObjectInfo objectInfo )

Abre el objeto en el editor cuyo puntero pasamos como parámetro.

Parámetros:

• objectInfo: VObjetoInfo del objeto que queremos abrir.

Array searchObjects([Array de VProjectInfo], szTexto, nCaseSensitive)

‌Permite buscar un texto en las propiedades de los objetos de los proyectos que se le pasen como parámetro y retorna un array de objetos JavaScript. Cada elemento del array retornado contiene los elementos siguientes:

objectInfo: el VObjectInfo del objeto encontrado.

‌parentObjectInfo: el VObjectInfo del objeto padre del objeto encontrado.‌

mainObjectInfo: el VObjectInfo del objeto principal del objeto encontrado.

‌solutionInfo: la solución (VSolutionInfo) a la que pertenece el objeto encontrado.

‌project: el proyecto (VProjectInfo) al que pertenece el objeto encontrado

‌propertyNumber (Number): número de la propiedad, dentro del árbol de propiedades del objeto, que contiene el texto buscado.‌

propertyName (String): nombre de la propiedad, dentro del árbol de propiedades del objeto, que contiene el texto buscado.‌

propertyData (String): contenido completo de la propiedad, dentro del árbol de propiedades del objeto, donde está el texto buscado.

‌Parámetros:‌

• Array de VProjectInfo: pasaremos un array con los VProjectInfo en los que queramos hacer la búsqueda.

• szTexto: cadnea de texto a buscar.

• Number caseSensitive: especificaremos un 1 si queremos que la búsqueda se haga respetando mayúsculas y minúsculas y un 0 en caso contrario.

Funciones de instancias

VInstanceList appInstances( VSolutionInfo solucion )

Retorna un objeto VInstanceList que contiene la lista de instancias de aplicación de la solución en curso.

Parámetros:

• solucion: objeto VSolutionInfo que representa la solución de la que queremos conocer las instancias disponibles.

Solo disponible para extensiones de Velneo vDevelop

VInstanceList datInstances( VSolutionInfo solucion )

Retorna un objeto VInstanceList que contiene la lista de instancias de datos de la solución en curso.

Parámetros:

• solucion: objeto VSolutionInfo que representa la solución de la que queremos conocer las instancias disponibles.

Solo disponible para extensiones de Velneo vDevelop.

Funciones de directorios

VDir newDir()

Crea un objeto VDir para la gestión de un directorio que pasemos como parámetro.

Funciones de ficheros

VFile newFile( String szSenda )

Crea un objeto VFile para la gestión del fichero en disco que especificamos como parámetro.

Parámetros:

• szSenda: senda del fichero en disco.

VTextFile newTextFile( String szSenda )

Crea un objeto VTextFile para la gestión del fichero del texto en disco que especificamos como parámetro.

Parámetros:

• szSenda: senda del fichero de texto en disco.

Funciones de sistema

VClipboard clipboard()

Devuelve un objeto del tipo VClipboard que nos permite acceder al portapapeles en curso o establecer un nuevo contenido en el portapapeles.

VSettings newSettings( String szOrganizacion, String szAplicacion )

Crea un objeto VSettings para la gestión de una rama de configuración del sistema correspondiente a la Organización y la aplicación que pasemos como parámetro.

Parámetros:

• szOrganizacion: rama de la organizacion en la que queremos establecer o leer un valor.

• szAplicacion: rama de la aplicación en la que queremos establecer o leer un valor.

En Windows se accede al registro, en linux a ficheros con extensión .ini y en mac a ficheros con extensión .plist.

Funciones de base de datos externas

VSqlDataBase newSqlDatabase()

Inicializa un acceso a base de datos externa. Devuelve el puntero al acceso a base de datos externa.

Debemos hacer uso del subapi de Bases de datos externas para configurar el acceso y conectarnos para operar.

Funciones de webservice

XMLHttpRequest newXMLHttpRequest()

Crea un nuevo objeto XMLHttpRequest para la obtención de URL's para el acceso a webservices.

Ejemplos

Ejemplo de uso de las funciones de configuración de extensión

Rectangle
{
    id: componentePrincipal

    width: 800
    height: 600

    Component.onCompleted:
    {
        theExtension.setDialog( true );
        theExtension.setWindowTypeFlags( VExtension.WindowTypeDialog | VExtension.WindowTypeCustomizeWindowHint | VExtension.WindowTypeWindowTitleHint );
        theExtension.setFixedSize(true);    
    }
}