Documentación de Velneo
34
Buscar
⌃K
Comment on page

VApp

Este clase representa a la aplicación. Dispone de funciones para ver información de sus proyectos, acceso a variables globales, constantes, utilidades de base de datos, disco, etc.

El objeto theApp

Se trata de un objeto de esta clase.
Todos los scripts están conectados a un objeto global y único que representa a la aplicación cuyo nombre es theApp. Este objeto está disponible en ejecución de scripts en Velneo vClient, pero también en extensiones en Velneo vDevelop, aunque no aquellas funciones que tienen sentido únicamente en ejecución (Ver documentación de VExtension).

Herencia

Hay que tener en cuenta que la aplicació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.

Indice de funciones

Generales

void beep()
String calculateHash( String szAlgoritmoHash, String szTextCodec )
String exeName()
void notify( String szMensaje, vImage icon type message, VImage icon close, int secondsDuration)
String stripHtml( String szHtml )
void wait( Number miliSegs )

De proyectos

VProjectInfo mainProjectInfo()
VProjectInfo projectInfo( Number nProjectType, int index )
VProjectInfo projectInfo( String szAlias )

De variables globales

Boolean globalVarToBool( String szIdRefVar )
QDate globalVarToDate( String szIdRefVar )
QDateTime globalVarToDateTime( String szIdRefVar )
Number globalVarToDouble( String szIdRefVar )
Number globalVarToInt( String szIdRefVar )
String globalVarToString( String szIdRefVar )
QTime globalVarToTime( String szIdRefVar )
Boolean isGlobalVarEmpty( String szIdRefVar )
void setGlobalVar( String szIdRefVar, String szValue )
void setGlobalVar( String szIdRefVar, Number nValue )
void setGlobalVar( String szIdRefVar, Boolean bValue )
void setGlobalVar( String szIdRefVar, QDateTime dtValue )
void setGlobalVar( String szIdRefVar, QDate dValue )
void setGlobalVar( String szIdRefVar, QTime tValue )

De constantes

String constant( String szIdRefConstante )
String constant( String szIdRefConstante, Number idioma, [Number pais] )

De mantenimiento de base de datos

Boolean compactTable(String idRefTabla, Number nModo, Number nUmbral)
Boolean emptyTable( String idRefTabla)
Boolean regenComplexIndex( String szIdRefIdxComplejo, Boolean bProgressDialog )
Boolean regenDataArea( String idRefTabla, Boolean bProgressDialog )
Boolean regenIndexes( String idRefTabla, Boolean bProgressDialog )

De DOS: directorios

String cleanPath( String path )
String currentPath()
VFileInfo driveAt( Number index )
Number drivesCount()
Array getPaths( int nPath )
String homePath()
Boolean loadDrives()
String rootPath()
Boolean setCurrentPath( String path )
String tempPath()

De DOS: ficheros

Boolean copyFile( String szFileName, String szNewName )
Boolean existsFile( String szFileName )
Boolean linkFile( String szFileName, String szLinkName )
Boolean removeFile( String szFileName )
Boolean renameFile( String szFileName, String szNewName )

De info local actual

void setCurrentLocale( const QString& szLocale )

De info local del sistema

De sistema

VClipboard clipboard()
VScreen screen()
Boolean startProgramDetached( String szExe, string aszArgumentos)

De cestas

void appendToBasket( String szIdRefCesta, VRegister reg )
void appendToBasket( String szIdRefCesta, VRegisterList regList )
Boolean getBasket( String szIdRefCesta, VRegisterList regList )
void removeFromBasket( String szIdRefCesta, VRegister reg )
void removeFromBasket( String szIdRefCesta, VRegisterList regList )
Boolean setBasket( String szIdRefCesta, VRegisterList regList )

De impresoras del sistema

Array supportedPaperSizes( String szPrinterName )

De impresión de informes

void printReport( VRegisterList list, String idRefReport, [String idRefLogicPr])
void printReportToFile( VRegisterList list, String idRefReport, String path )
void printReportToPrinter( VRegisterList list, String idRefReport, String printerName, [Boolean bHighRes=false])

De variables de sistema

Boolean isAdministrator()
VSysInfo sysInfo()
String userName()

De cursor

void setOverrideCursor( Number nCursor )

De variables globales tipo array

Number globalVarArraySize( String szIdRefVar )
Boolean globalVarArrayToBool( String szIdRefVar, Number nSubindex )
Date globalVarArrayToDate( String szIdRefVar, Number nSubindex )
DateTime globalVarArrayToDateTime( String szIdRefVar, Number nSubindex )
Number globalVarArrayToInt( String szIdRefVar, Number nSubindex )
Number globalVarArrayToSDouble( String szIdRefVar, Number nSubindex )
String globalVarArrayToString( String szIdRefVar, Number nSubindex )
Time globalVarArrayToTime( String szIdRefVar, Number nSubindex )
Boolean isGlobalVarArrayEmpty( String szIdRefVar, Number nSubindex )
void setGlobalVarArray( QString szIdRefVar, Number nSubindex, Variant var)

De mensajería interna

void sendUserAlert( String szUser, String szAsunto, String szMsg )
void sendUserMessage( String szUser, String szAsunto, String szMsg )
void sendUserWarning( String szUser, String szAsunto, String szMsg )

De tablas estáticas

Number staticTableItemCount( String szIdRefTable )
String staticTableItemId( String szIdRefTable, Number nIndex )
VImage staticTableItemImage( String szIdRefTable, Number nIndex )
String staticTableItemName( String szIdRefTable, Number nIndex )
String staticTableItemName( String szIdRefTable, Number nIndex, Number nLenguaje, Number nPais )

Multimedia

String defaultCamera()

De vista de datos

VAbstractDataView focusDataView()

De estilos

Boolean setStyle( String szStyle )
String style()
Array styles()

De aspecto

Number currentAspect()
Number aspect()
void setAspect (AspectMode mode)

De conexión segura TLS/SSL

VSSLInfo sslInfo()

De cliente-servidor

De personalización

void setFrame(String szIdRefMarco)

De API

String getCurrentURL()

De JSON Web Token (JWT)

Object jwtDecode( String szToken, String szKey )
String jwtEncode( Object jsonPayload, String szKey, String szAlgorithm )

Documentación de funciones

Funciones generales

void beep()

Emite un pitido a través del altavoz del sistema.

String calculateHash( String szAlgoritmoHash, String szTextCodec )

Devuelve en minúsculas el hash de una cadena en función del parámetro.
Parámetros:

String exeName()

Devuelve el nombre del ejecutable en curso como vClient, vDataClient, vAdmin, vDevelop, vClient (Agente), vServer, vModApache.

void notify( String szMensaje, vImage icon type message, VImage icon close, int secondsDuration)

Muestra una ventana de notificación sin bloqueo de la interfaz.
Parámetros:
  • szMensaje: cadena con el texto a presentar en la notificación. Icono del mensaje
  • icon type message: permite mostrar un objeto VImage que se mostrará a la izquierda del texto de la notificación; por ejemplo, un icono de advertencia, peligro, información. Este parámetro es opcional.
  • icon close: permite personalizar el icono de cierre que se usa por defecto para las notificaciones. Para ello usaremos un objeto VImage. Este parámetro es opcional.
  • secondsDuration: permite configurar el tiempo que la notificación permanecerá en pantalla antes de cerrarse automáticamente. Si no se especifica durará 7 segundos, que es el tiempo por defecto. Si se pone un 0, la notificación debe ser cerrada por el usuario. Este parámetro es opcional.

void processEvents()

Procesa los eventos que haya en la cola de la aplicación, excluyendo los de entrada de usuario (teclado, ratón...). Debe usarse donde se consuma mucho tiempo o bucles largos para que se refresque el interfaz. Solo actúa en procesos en primer plano ya que es en estos donde estamos ocupando el hilo principal que es el que atiende la cola de eventos. En los demás no hace nada.

String stripHtml( String szHtml )

Retorna la cadena que pasamos como parámetro sin etiquetas html. El código html debe estar bien conformado para que retorne contenido.
Parámetros:
  • szHtml: cadena de texto que contiene el código Html correctamente conformado del que queremos extraer el texto sin etiquetas html.

void wait( Number miliSegs )

El proceso queda detenido en este punto durante el tiempo especificado en el parámetro.
Parámetros:
  • miliSegs: número de milisegundos de espera, por ejemplo: 1000 = 1 segundo.

Funciones de proyectos

VProjectInfo mainProjectInfo()

Devuelve el objeto VProjectInfo del proyecto principal.
Si la usamos en un proceso ejecutado en 4º plano, esta función devolverá el proyecto donde esté declarado el proceso, tenga proyectos o no por encima, el motivo de esto es que cuando se ejecuta el proceso el servidor crea un enganche temporal para gestionarlo, en ese momento, conoce el proyecto donde está el objeto y lo que hereda, pero no conoce todo lo que tiene por encima.

VProjectInfo projectInfo( Number nProjectType, int index )

Esta función es de uso exclusivo en las extensiones de Velneo vDevelop (clase vExtension).Devuelve un objeto VProjectInfo con la información del proyecto cuyo tipo e index dentro de la solución hayamos pasado como parámetro.
Parámetros:

VProjectInfo projectInfo( String szAlias )

Devuelve un objeto VProjectInfo del proyecto con el alias especificado.
Parámetros:
  • szAlias: alias del proyecto.

Funciones de variables globales

Boolean globalVarToBool( String szIdRefVar )

Devuelve el valor de una variable global de tipo booleano.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.

QDate globalVarToDate( String szIdRefVar )

Devuelve el valor de una variable global de tipo fecha.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.

QDateTime globalVarToDateTime( String szIdRefVar )

Devuelve el valor de una variable global de tipo tiempo, fecha y hora.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.

Number globalVarToDouble( String szIdRefVar )

Devuelve el valor de una variable global de tipo numérico, con decimales.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.

Number globalVarToInt( String szIdRefVar )

Devuelve el valor de una variable global de tipo numérico, entero.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.

String globalVarToString( String szIdRefVar )

Devuelve el valor de una variable global de tipo alfabética.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.

QTime globalVarToTime( String szIdRefVar )

Devuelve el valor de una variable global de tipo hora.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.

Boolean isGlobalVarEmpty( String szIdRefVar )

Devuelve true si la variable global está vacía. Las numéricas se asumen vacías con el valor 0.
Parámetros:
  • szIdRefVar: idRef de la variable "ALIASPROYECTO/IDVARIABLE".

void setGlobalVar( String szIdRefVar, String szValue )

Asigna el valor a la variable global de tipo alfabética.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.
  • szValue: valor alfabético.

void setGlobalVar( String szIdRefVar, Number nValue )

Asigna el valor a la variable global de tipo numérica.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.
  • nValue: valor numérico.

void setGlobalVar( String szIdRefVar, Boolean bValue )

Asigna el valor a la variable global de tipo booleano.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.
  • bValue: valor booleano.

void setGlobalVar( String szIdRefVar, QDateTime dtValue )

Asigna el valor a la variable global de tipo tiempo, fecha y hora.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.
  • dtValue: valor de tipo tiempo, fecha y hora.

void setGlobalVar( String szIdRefVar, QDate dValue )

Asigna el valor a la variable global de tipo fecha.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.
  • dValue: valor de tipo fecha.

void setGlobalVar( String szIdRefVar, QTime tValue )

Asigna el valor a la variable global de tipo hora.
Parámetros:
  • szIdRefVar: identificador de referencia de la variable global.
  • tValue: valor de tipo hora.

Funciones de constantes

String constant( String szIdRefConstante )

Devuelva el contenido de una constante.
Parámetros:
  • szIdRefConstante: idRef del objeto constante "ALIAS_PROYECTO/ID_OBJETO".

String constant( String szIdRefConstante, Number idioma, [Number pais] )

Devuelve el contenido de una constante en el idioma y país especificado en los parámetros. El país es un parámetro opcional, si no se especifica asume el más genérico de los existentes para ese idioma.
Parámetros:
  • szIdRefConstante: idRef del objeto constante "ALIAS_PROYECTO/ID_OBJETO".
  • idioma: código numérico del idioma, por ejemplo: English = 31. Ver enum de idiomas​
  • país: código numérico del país, por ejemplo: UnitedKingdom = 224. Este es un parámetro opcional. Ver enum de países.

Funciones de mantenimiento de base de datos

Estas funciones es recomendable usarlas solamente en modo mantenimiento.

Boolean compactTable(String idRefTabla, Number nModo, Number nUmbral)

Esta función permite compactar datos (dat/idx) y/o cotenedor (cnd/cni) de una o varias tablas.
Debe ser ejecutada en el servidor, por lo que no puede ser usada en procesos lanzados en primer o segundo plano.
Parámetros:
  • idRefTabla: identificador de referencia de la tabla a compactar. Si se deja en vacío se compactarán todas las tablas de todos los proyectos cargados.
  • Modo: modo de compactación. Ver enum de modos de compactación.
  • Umbral mínimo: valor numérico entero y positivo (entre 0 y 100).

Boolean emptyTable( String idRefTabla)

Vacía la tabla que le pasamos por parámetro, es decir, borra todo su contenido (datos, índices y contenedor).
Esta función no transacciona y no debe estar incluida en ninguna transacción, o no haber comenzado ésta hasta que se haya usado la función. En cuanto comienza transacción ya no se puede usar.
Parámetros:
  • idRefTabla: idRef de la tabla "ALIAS_PROYECTO/ID_TABLA" a vaciar.

Boolean regenComplexIndex( String szIdRefIdxComplejo, Boolean bProgressDialog )

Regenera un índice complejo. Si indicamos true en el 2º parámetro se mostrará la barra de progreso.
Parámetros:
  • idRefIdxComplejo: idRef del índice complejo "ALIAS_PROYECTO/ID_INDICE_COMPLEJO".
  • bProgressDialog: true para indicar que sea visible la barra de progreso.

Boolean regenDataArea( String idRefTabla, Boolean bProgressDialog )

Hace una regeneración del área de datos de la tabla seleccionada en el primer parámetro, de su contenedor y también la regeneración de los índices de tabla y contenedor. Si indicamos true en el 2º parámetro se mostrará la barra de progreso. Esta función lanzada sobre tablas en memoria siempre devuelve false.
Parámetros:
  • idRefTabla: idRef de la tabla "ALIAS_PROYECTO/ID_TABLA".
  • bProgressDialog: true para indicar que sea visible la barra de progreso.

Boolean regenIndexes( String idRefTabla, Boolean bProgressDialog )

Regenera los índices de tabla indicada en el primer parámetro y su contenedor. Si indicamos true en el 2º parámetro se mostrará la barra de progreso.
Parámetros:
  • idRefTabla: idRef de la tabla "ALIAS_PROYECTO/ID_TABLA".
  • bProgressDialog: true para indicar que sea visible la barra de progreso.

Funciones DOS: directorios

String applicationDirPath()

Devuelve el directorio de la aplicación en el que está siendo ejecutado el script.

String applicationFilePath()

Devuelve la senda de la aplicación en el que está siendo ejecutado el script.

String cleanPath( String path )

Elimina del path los separadores "/" o "" redundantes y los unifica a "/".

String currentPath()

Devuelve el path del directorio en curso, por defecto donde se ejecuta vClient.

VFileInfo driveAt( Number index )

Devuelve un objeto VFileInfo para el dispositivo del índice cargado.
Parámetros:
  • index: número ordinal correspondiente al dispositivo de disco.

Number drivesCount()

Devuelve el número de dispositivos de disco del sistema.

Array getPaths( int nPath )

Devuelve un array de cadenas con las sendas estándar del sistema para la localización que indicamos como parámetro.
Devuelve un array ya que puede haber más de una senda para un mismo path.
Parámetros:
Los valores posibles son:
Windows
========
DesktopPath "C:/Users/<USER>/Desktop"
DocumentsPath "C:/Users/<USER>/Documents"
FontsPath "C:/Windows/Fonts" (not writable)
ApplicationsPath "C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Start Menu/Programs"
MusicPath "C:/Users/<USER>/Music"
MoviesPath "C:/Users/<USER>/Videos"
PicturesPath "C:/Users/<USER>/Pictures"
TempPath "C:/Users/<USER>AppData/Local/Temp"
HomePath "C:/Users/"
DataPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/", "", "/data"
CachePath "C:/Users/<USER>/AppData/Local/<USER>/cache"
GenericDataPath "C:/Users/<USER>/AppData/Local", "C:/ProgramData", "", "/data"
RuntimePath "C:/Users/"
ConfigPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/"
GenericConfigPath "C:/Users/<USER>/AppData/Local", "C:/ProgramData"
DownloadPath "C:/Users/<USER>/Documents"
GenericCachePath "C:/Users/<USER>/AppData/Local/cache"
AppDataPath "C:/Users/<USER>/AppData/Roaming/", "C:/ProgramData/", "", "/data"
AppLocalDataPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/", "", "/data"
AppConfigPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/"
OS X
========
DesktopPath "~/Desktop"
DocumentsPath "~/Documents"
FontsPath "/System/Library/Fonts" (not writable)
ApplicationsPath "/Applications" (not writable)
MusicPath "~/Music"
MoviesPath "~/Movies"
PicturesPath "~/Pictures"
TempPath Generado aleatoriamente por el sistema operativo
HomePath "~"
DataPath "~/Library/Application Support/", "/Library/Application Support/". "/../Resources"
CachePath "~/Library/Caches/", "/Library/Caches/"
GenericDataPath "~/Library/Application Support", "/Library/Application Support"
RuntimePath "~/Library/Application Support"
ConfigPath "~/Library/Preferences"
GenericConfigPath "~/Library/Preferences"
DownloadPath "~/Downloads"
GenericCachePath "~/Library/Caches", "/Library/Caches"
AppDataPath "~/Library/Application Support/", "/Library/Application Support/". "/../Resources"
AppLocalDataPath "~/Library/Application Support/", "/Library/Application Support/". "/../Resources"
AppConfigPath "~/Library/Preferences/"
Linux
========
DesktopPath "~/Desktop"
DocumentsPath "~/Documents"
FontsPath "~/.fonts"
ApplicationsPath "~/.local/share/applications", "/usr/local/share/applications", "/usr/share/applications"
MusicPath "~/Music"
MoviesPath "~/Videos"
PicturesPath "~/Pictures"
TempPath "/tmp"
HomePath "~"
DataPath "~/.local/share/", "/usr/local/share/", "/usr/share/"
CachePath "~/.cache/"
GenericDataPath "~/.local/share", "/usr/local/share", "/usr/share"
RuntimePath "/run/user/"
ConfigPath "~/.config", "/etc/xdg"
GenericConfigPath "~/.config", "/etc/xdg"
DownloadPath "~/Downloads"
GenericCachePath "~/.cache"
AppDataPath "~/.local/share/", "/usr/local/share/", "/usr/share/"
AppLocalDataPath "~/.local/share/", "/usr/local/share/", "/usr/share/"
AppConfigPath "~/.config/", "/etc/xdg/"
Android
========
DesktopPath "/files"
DocumentsPath "/Documents", "/<USER>/Documents"
FontsPath "/system/fonts" (no se puede escribir)
ApplicationsPath No soportado (el directorio no se puede leer)
MusicPath "/Music", "/<USER>/Music"
MoviesPath "/Movies", "/<USER>/Movies"
PicturesPath "/Pictures", "/<USER>/Pictures"
TempPath "/cache"
HomePath "/files"
DataPath "/files", "/<USER>/files"
CachePath "/cache", "/<USER>/cache"
GenericDataPath ""
RuntimePath "/cache"
ConfigPath "/files/settings"
GenericConfigPath "/files/settings" (no hay settings compartidos)
DownloadPath "/Downloads", "/<USER>/Downloads"
GenericCachePath "/cache" (no hay cache compartida)
AppDataPath "/files", "/<USER>/files"
AppConfigPath "/files/settings"
AppLocalDataPath "/files", "/<USER>/files"
iOS
========
DesktopPath "/Documents/Desktop"
DocumentsPath "/Documents"
FontsPath "/Library/Fonts"
ApplicationsPath No soportado
MusicPath "/Documents/Music"
MoviesPath "/Documents/Movies"
PicturesPath "/Documents/Pictures", "assets-library://"
TempPath "/tmp"
HomePath "" (not writable)
DataPath "/Library/Application Support"
CachePath "/Library/Caches"
GenericDataPath "/Documents"
RuntimePath No soportado
ConfigPath "/Library/Preferences"
GenericConfigPath "/Library/Preferences"
DownloadPath "/Documents/Downloads"
GenericCachePath "/Library/Caches"
AppDataPath "/Library/Application Support"
AppConfigPath "/Library/Preferences/"
AppLocalDataPath "/Library/Application Support"

String homePath()

Devuelve el path del directorio home, por defecto el del usuario.

Boolean loadDrives()

Carga los dispositivos de disco del sistema. Devuelve true si finaliza correctamente.
Devuelve el path del directorio raíz, por ejemplo "C:/".

Boolean setCurrentPath( String path )

Cambia el path en curso. Devuelve true si el cambio finaliza correctamente.
Parámetros:
  • path: nueva senda.

String tempPath()

Devuelve el path de del directorio temporal.

Funciones DOS: ficheros

Boolean copyFile( String szFileName, String szNewName )

Copia un fichero. Devuelve true si la copia finaliza correctamente.
Parámetros:
  • szFileName: senda de origen del fichero con el nombre antiguo.
  • szNewName: senda de destino del fichero con el nuevo nombre.

Boolean existsFile( String szFileName )

Devuelve true si el fichero existe y está legible.
Parámetros:
  • szFileName: senda del fichero.

Boolean linkFile( String szFileName, String szLinkName )

Crea un enlace simbólico, acceso directo o shortcut, a un fichero o directorio.
Parámetros:
  • szFileName: senda del fichero.
  • szLinkName: nombre del acceso directo o shorcut.

Boolean removeFile( String szFileName )

Elimina un fichero del disco. Devuelve true si finaliza correctamente.
Parámetros:
  • szFileName: senda del fichero.

Boolean renameFile( String szFileName, String szNewName )

Renombra un fichero del disco. Devuelve true si finaliza correctamente.
Parámetros:
  • szFileName: senda del fichero a renombrar.
  • szNewName: senda del fichero con el nuevo nombre.

Funciones de info local actual

Number currentCountryCode()

Devuelve el código de país en curso. Ver enun de códigos de países.

String currentCountryIsoCode()

Devuelve el código ISO (3166) del país en curso.

String currentCountryName()

Devuelve el nombre del país en curso, en inglés.

String currentDecimalPoint()