30
Velneo vDevelop
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.
Generales
Retorno
Función
void
beep()
String
calculateHash( String szCadena, AlgoritmoHash )
String
exeName()
void
String
stripHtml( String szHtml )
void
wait( Number miliSegs )
De proyectos
Retorno
Función
projectInfo( Number nProjectType, int index )
projectInfo( String szAlias )
De variables globales
Retorno
Función
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
Retorno
Función
String
constant( String szIdRefConstante )
String
constant( String szIdRefConstante, Number idioma, [Number pais] )
De mantenimiento de base de datos
Retorno
Función
Boolean
compactTable(String idRefTabla, Number nModo, Number nUmbral)
Boolean
regenComplexIndex( String szIdRefIdxComplejo, Boolean bProgressDialog )
Boolean
regenDataArea( String idRefTabla, Boolean bProgressDialog )
Boolean
regenIndexes( String idRefTabla, Boolean bProgressDialog )
Boolean
emptyTable( String idRefTabla)
De DOS: directorios
Retorno
Función
String
cleanPath( String path )
String
VFileInfo
driveAt( Number index )
Number
Array
getPaths( int nPath )
String
Boolean
String
Boolean
setCurrentPath( String path )
String
De DOS: ficheros
Retorno
Función
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
Retorno
Función
De info local del sistema
Retorno
Función
Number
String
String
Number
String
De sistema
Retorno
Función
VScreen
screen()
Boolean
startProgramDetached( String szExe, string aszArgumentos)
String
De cestas
Retorno
Función
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
Retorno
Función
String
Array
supportedPaperSizes( String szPrinterName )
De impresión de informes
Retorno
Función
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
Retorno
Función
String
Boolean
VSysInfo
sysInfo()
String
De cursor
Retorno
Función
void
setOverrideCursor( Number nCursor )
De variables globales tipo array
Retorno
Función
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
Retorno
Función
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
Retorno
Función
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
Retorno
Función
String
De vista de datos
Función
Función
De estilos
Retorno
Función
Boolean
setStyle( String szStyle )
String
style()
Array
styles()
De conexión segura TLS/SSL
Retorno
Función
VSSLInfo
sslInfo()
De cliente-servidor
Retorno
Función
De personalización
Retorno
Función
void
setFrame(String szIdRefMarco)
De API
Retorno
Función
String

Enumeraciones

AlgoritmoHash
Algoritmos estándar:
  • Md4 = 0
  • Md5 = 1
  • Sha1 = 2
  • Sha2_224 = 3
  • Sha2_256 = 4
  • Sha2_384 = 5
  • Sha2_512 = 6
  • Sha3_224 = Keccak_224 = 7
  • Sha3_256 = Keccak_256 = 8
  • Sha3_384 = Keccak_384 = 9
  • Sha3_512 = Keccak_512 = 10
  • RealSha3_224 = 11
  • RealSha3_256 = 12
  • RealSha3_384 = 13
  • RealSha3_512 = 14
Cursores
  • ArrowCursor = 0
  • UpArrowCursor = 1
  • CrossCursor = 2
  • WaitCursor = 3
  • IBeamCursor = 4
  • SizeVerCursor = 5
  • SizeHorCursor = 6
  • SizeBDialogCursor = 7
  • SizeFDialogCursor = 8
  • SizeAllCursor = 9
  • BlankCursor = 10
  • SplitVCursor = 11
  • SplitHCursor = 12
  • PointingHandCursor = 13
  • ForbiddenCursor = 14
  • WhatsThisCursor = 15
  • BusyCursor = 16
  • OpenHandCursor = 17
  • CloseHandCursor = 18
PaperSize
  • A4 = 0
  • B5 = 1
  • Letter = 2
  • Legal = 3
  • Executive = 4
  • A0 = 5
  • A1 = 6
  • A2 = 7
  • A3 = 8
  • A5 = 9
  • A6 = 10
  • A7 = 11
  • A8 = 12
  • A9 = 13
  • B0 = 14
  • B1 = 15
  • B10 = 16
  • B2 = 17
  • B3 = 18
  • B4 = 19
  • B6 = 20
  • B7 = 21
  • B8 = 22
  • B9 = 23
  • C5E = 24
  • Comm10E = 25
  • DLE = 26
  • Folio = 27
  • Ledge = 28
  • Tabloid = 29
  • Custom = 30
Paths
  • DocumentsPath = 1
  • DesktopPath = 0
  • FontsPath = 2
  • ApplicationsPath = 3
  • MusicPath = 4
  • MoviesPath = 5
  • PicturesPath = 6
  • TempPath = 7
  • HomePath = 8
  • DataPath = 9
  • CachePath = 10
  • GenericCachePath = 15
  • GenericDataPath = 11
  • RuntimePath = 12
  • ConfigPath = 13
  • DownloadPath = 14
  • GenericConfigPath = 16
  • AppDataPath = 17
  • AppLocalDataPath = DataPath
Calidad de conexión
  • Sin conexión = 0
  • Deficiente = 1
  • Mala = 2
  • Regular = 3
  • Cloud = 4
  • Wifi = 5
  • Red local = 6
Modos de compactación
  • 0 = CompactData → fichero de datos (.dat, .idx).
  • 1 = CompactContainer → contenedor (.cnd, .cni).
  • 2 = CompactAll → fichero de datos (.dat, .idx) y contenedor (.cnd, .cni).

Documentación de funciones

Funciones generales

void beep()

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

String calculateHash( String szCadena, AlgoritmoHash )

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

String exeName()

Devuelve el nombre del navegador en curso, por ejemplo: vClient, vWebClient, etc.

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:
  • nProjectType: tipo de proyecto. Ver enum de tipos de proyecto.
  • index: index dentro de la solución.

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

Boolean emptyTable( String idRefTabla)

Vacía la tabla que le pasamos por parámetro, es decir, borra todo su contenido (datos, índices y contenedor)
Parámetros:
  • idRefTabla: idRef de la tabla "ALIAS_PROYECTO/ID_TABLA" a vaciar.

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:
  • Path: 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.