-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.html
20 lines (17 loc) · 19.1 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!DOCTYPE html><html><head><meta charset="utf-8" />
<title>gambas-extra-functions</title>
</head><body>
<style>
.center {
text-align: center;
}
</style>
<div class="center">
<img src="logo.png" alt="Logo" width="200" height="200">
</div>
<h2>Wiki de Gambas Extra Functions</h2>
<p>GEF es una recopilación de funciones que en general son comunes a muchos proyectos de gambas. Esto permite agilizar y estandarizar la programación e intenta mejorar la colaboración en equipo.</p>
<h2>Organizadas las funciones</h2>
<p>Las funciones están contenidas en archivos .module y de acuerdo a la finalidad del proyecto en que se usen estas funciones aplicaran algunos de estos módulos u otros. por ejemplo si se hace un proyecto web o de terminal de ordenes este no podra usar MDesk.module puesto que este tiene funciones que trabajan con componentes de escritorio como gb.gui.</p>
<h2>Cantidad total de funciones: 93</h2><h2>MData.module</h2><h3>DBSqlite</h3><ul><li><b>stxDB</b><i> As String[]</i></li><li><b>Opt.strMod</b><i> As String</i></li></ul><p>Inicia una base de datos o la crea y la inicia. Devuelve una conexion y como parametro de entrada requiere una matriz con los parametros de la base. Si la base de datos no existe, entonces crea una y la inicia. ' Si la base de datos si existe, entonces puede hacer dos cosas, iniciarla o crear una copia de respaldo y crear una base nueva. stxDB contiene los paramentros de la base. 0 - DBHost. 1 - DBName. 2 - DBPath</p><h3>RecordNew</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strTable</b><i> As String</i></li><li><b>stxDBFields</b><i> As String[][]</i></li><li><b>stxValues</b><i> As String[]</i></li></ul><p> Inserta un registro nuevo en la base de datos. Si este es insertado correctamente la funcion devuelve la clave de dicho registro, de lo contratio devuelve -1</p><h3>RecordKey</h3><ul><li><b>strTable</b><i> As String</i></li><li><b>stxDBFields</b><i> As String[][]</i></li></ul><p> Devuelve el nombre del campo clave de la tabla. connDB As Connection es laq conxión a la base de datos. strTable As String es el nombre de la tabla sobre la que intenta saber que tipo de campo es. strFieldCheck As String Es el campo a verificar. strValueCheck As String Es el valor del registro para el campo a verificar. stxDBFields As String[] Es la lista de todos los campos de la base de datos.</p><h3>RecordForeign</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strTable</b><i> As String</i></li><li><b>strFieldCheck</b><i> As String</i></li><li><b>strValueCheck</b><i> As String</i></li><li><b>stxDBFields</b><i> As String[][]</i></li></ul><p> Devuelve la clave en la tabla foránea para un valor de texto si el campo es referenciado o -1 si el campo no es referenciado o no existe el valor en el campo a mostrar.</p><h3>RecordNewRef</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strTable</b><i> As String</i></li><li><b>stxDBFields</b><i> As String[][]</i></li><li><b>stxValues</b><i> As String[]</i></li></ul><p> Inserta un registro nuevo en la base de datos, ctnVal es una coleccion opcional del pares de campo:valor.</p><h3>getFields</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strTbl</b><i> As String</i></li><li><b>strMod</b><i> As String</i></li><li><b>Opt.stxFTitles</b><i> As String[][]</i></li></ul><p>Extraccion de la lista de campos de la tabla que se pasa como parametro.</p><h3>GetForeignKey</h3><ul><li><b>strValue</b><i> As String</i></li><li><b>conRef</b><i> As Connection</i></li><li><b>strTable</b><i> As String</i></li><li><b>strFieldKey</b><i> As String</i></li><li><b>strFieldName</b><i> As String</i></li></ul><p> Devuelve la clave del registro referenciado en otra tabla</p><h3>GetForeignKey</h3><ul><li><b>strValue</b><i> As String</i></li><li><b>conRef</b><i> As Connection</i></li><li><b>strTable</b><i> As String</i></li><li><b>strFieldKey</b><i> As String</i></li><li><b>strFieldName</b><i> As String</i></li></ul><p> Devuelve la clave del registro referenciado en otra tabla</p><h3>Chek4SQL</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p>Devuelve un texto apto para consulatas SQL, quita los saltos del línea y los caracteres no compatibles con sentencias SQL.</p><h3>getTables</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>Opt.strMod</b><i> As String</i></li></ul><p>Extraccion de la lista de tablas de la conexión. s ele pasan dos parametros, la conexión a la base de datos y el tipo view|table</p><h3>getFieldInfo</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strTab</b><i> As String</i></li><li><b>strFld</b><i> As String</i></li></ul><p></p><h3>getIndex</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strTab</b><i> As String</i></li></ul><p></p><h3>getTableFields</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strTab</b><i> As String</i></li></ul><p>Extraccion de la informacion de la estructura de una tabla.</p><h3>getViewFields</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strView</b><i> As String</i></li></ul><p>Extraccion de la informacion de la estructura de una vista.</p><h3>getViewFields</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strView</b><i> As String</i></li></ul><p>Extraccion de la informacion de la estructura de una vista.</p><h3>getViewFields</h3><ul><li><b>connDB</b><i> As Connection</i></li><li><b>strView</b><i> As String</i></li></ul><p>Extraccion de la informacion de la estructura de una vista.</p><h3>SqlMake</h3><ul><li><b>strTbl</b><i> As String</i></li><li><b>stxFld</b><i> As String[][]</i></li></ul><p></p><h3>TableMake1</h3><ul><li><b>cnx</b><i> As Connection</i></li><li><b>stxParam</b><i> As String[]</i></li></ul><p><p>Crea una tabla en la conexion que se le pasa como parametro. Donde el orden de los paramentros dentro de la matriz debe ser el siguiente:</p><ul><li>0 Nombre de la tabla</li><li>1 Nombre del campo clave</li><li>2 Nombre del resto de los campos</li><li>N Nombre del ultimo campo</li></ul></p><h3>TableMake2</h3><ul><li><b>cnx</b><i> As Connection</i></li><li><b>stxParam</b><i> As String[]</i></li></ul><p><p>Crea una tabla de combinacion de otras dos tablas en la conexion que se le pasa como parametro. Donde el orden de los paramentros dentro de la matriz debe ser el siguiente:</p><ul><li>0 Nombre de la tabla 1</li><li>1 Nombre del campo clave 1</li><li>2 Nombre del campo a mostrar 1</li><li>3 Nombre de la tabla 21</li><li>4 Nombre del campo clave 2</li><li>5 Nombre del campo a mostrar 2</li></ul></p><h3>ViewMake1</h3><ul><li><b>cnx</b><i> As Connection</i></li><li><b>stxParam</b><i> As String[]</i></li></ul><p>Crea una Vista en la conexion que se le pasa como parametro. La funcion trabaja con campos que se llaman TABLA+i y TABLA+n donde n es un numero correlativo. Todos los vinculas seran left join y el orden sera por la segunda columna. Por ejemplo para una tabla de productos donde hay un campo color y otro clase y ambos son tablas relacionadas. Donde el orden de los paramentros dentro de la matriz debe ser el siguiente: <ul><li>0 Nombre de la tabla base</li><li>1 Este y en adelante, nombre las tablas secundarias</li></ul>Para el ejemplo<ul><li>0 productos</li><li>1 color</li><li>2 clase</li></ul><p>Donde color tendra los campos colori, color1 y clase tendrá los campos clasei, clase1. La tabla principal tendra los campos productosi, productos1, productos2</p><h3>RecordNewTest</h3><ul><li><b>cnx</b><i> As Connection</i></li><li><b>strTbl</b><i> As String</i></li><li><b>stxIns</b><i> As String[][]</i></li></ul><p> Inserta un registro nuevo en la base de datos.</p><h3>RecordNewRefTest</h3><ul><li><b>cnx</b><i> As Connection</i></li><li><b>stxTbl</b><i> As String[]</i></li><li><b>stxIns</b><i> As String[][]</i></li></ul><p> Inserta un registro nuevo en la base de datos.</p><h2>MDesk.module</h2><h3>FileChooser</h3><ul><li><b>Opt.strInputPath</b><i> As String</i></li><li><b>Opt.strFilter</b><i> As String</i></li></ul><p>Selecciona la ruta completa de un archivo, con el nombre y las extensiones. Como opcional se puede pasar un directorio que es a donde se dirigira el filechooser cuando se abra. También como opcional se pued epasar un filtro de tipos de archivos separados por :, por ejemolo "txt:csv"</p><h3>DirChooser</h3><ul><li><b>Opt.stInputPath</b><i> As String</i></li></ul><p>Selecciona la ruta de un directorio mediante una caja de dialogo.</p><h2>MUtility.module</h2><h3>DirParent</h3><ul><li><b>strPath</b><i> As String</i></li></ul><p>Devuelve el directorio padre de otro que se pasa como parámetro.</p><h3>DokuHtml</h3><ul><li><b>strPath</b><i> As String</i></li></ul><p>Devuelve un html con las funciones de un módulo y todos los datos de estas, comoparametro de entrada requiere el directorio raiz a partir del cual buscar los módulos.</p><h3>Dokuwiki</h3><ul><li><b>strPath</b><i> As String</i></li></ul><p>Devuelve un wiki con las funciones de un módulo y todos los datos de estas, comoparametro de entrada requiere el directorio raiz a partir del cual buscar los módulos.</p><h3>FilesNew</h3><ul><li><b>strDirectory</b><i> As String</i></li><li><b>Opt.stxFilesOpt</b><i> As String[]</i></li><li><b>Opt.strFilterOpt</b><i> As String</i></li></ul><p> Devuelve una lista de archivos de un directorio que se pasa como parametro. Opcionalmente se puede pasar como parametro una lista de archivos existentes los cuales seran omitidos de la lista de salida si es que son encontrados y un filtro de extensiones de archivo de l estilo mp3:ods:txt</p><h3>FilesExist</h3><ul><li><b>strDirectory</b><i> As String</i></li><li><b>Opt.stxFilesOpt</b><i> As String[]</i></li><li><b>Opt.strFilterOpt</b><i> As String</i></li></ul><p> Devuelve una lista de archivos de un directorio que coinciden con los de la lista que se le pasa como parametro, es decir verifica que existen. Opcionalmente se le puede pasar un parametro de filtro de extensiones para acotar la busqueda.</p><h3>FilesNone</h3><ul><li><b>strDirectory</b><i> As String</i></li><li><b>Opt.stxFilesOpt</b><i> As String[]</i></li><li><b>Opt.strFilterOpt</b><i> As String</i></li></ul><p> Devuelve una lista de archivos que no existen en el directorio, es necesario parar una lista de archivos para contrastar.</p><h3>FilesList</h3><ul><li><b>strPath</b><i> As String</i></li></ul><p> Devuelve una lista de archivos.</p><h3>FileNospace</h3><ul><li><b>stxParam</b><i> As String[]</i></li><li><b>Opt.strDelim</b><i>
As String</i></li><li><b>Opt.strExt</b><i> As String</i></li></ul><p>Devuelve un texto, nombre de arcivo concatenando todos los fragmentos que se le pase y pone todo en minusculas quita los caracteres fuera del rango 97-122 de ascci.</p><h3>FileVersion</h3><ul><li><b>strInputPath</b><i> As String</i></li></ul><p>Devuelve un texto con la versión del archivo que se le pasa como ruta. Usa el comando file de la terminal.</p><h3>FileLoad</h3><ul><li><b>strPath</b><i> As String</i></li></ul><p> Devuelve una matriz de texto con los valores listados en un archivo de texto desl cual se pasa su ruta como parametro.</p><h3>FileTemplate</h3><ul><li><b>strFileSeed</b><i> As String</i></li><li><b>strFileProduct</b><i> As String</i></li><li><b>stxTag</b><i> As String[]</i></li><li><b>stxDat</b><i> As String[]</i></li></ul><p> Tomando un archivo template reemplaza las etiquetas por valores. Retorna una matriz con una lista de archivos, primero el producto y luego el pdf, en cas que alguno de estos no exista en la posicion de la matriz hara una cadena vacia.</p><h3>FileReplace</h3><ul><li><b>strFileName</b><i> As String</i></li><li><b>strSearch</b><i> As String</i></li><li><b>strReplace</b><i> As String</i></li></ul><p> Busca una cadena de texto en un archivo de entrada y la reemplaza por otra y luego pone todo en un archivo de salida. Archivos en modo input</p><h3>ArrangePath</h3><ul><li><b>strPathRaw</b><i> As String</i></li></ul><p>Devuelve una ruta sin los saltos del línea ni caracteres problemáticos</p><h3>FileCRC32</h3><ul><li><b>stInputPath</b><i> As String</i></li><li><b>Opt.strCase</b><i> As String</i></li></ul><p> Obtencion del crc32 de un archivo del que se pasa como parametro la ruta completa, como parametro opcional strCase puede ser U o L que parara todo a Ucase o Lcase.</p><h3>FileExifPages</h3><ul><li><b>strPath</b><i> As String</i></li></ul><p> Devuelve la cantidad de páginas del archivo si no tiene el tag entonces se devuelve 1. Para la extraccion de esta informacion se usa ExifTool.</p><h3>FileExifRaw</h3><ul><li><b>strPath</b><i> As String</i></li></ul><p> Devuelve una matriz con los metadatos extraídos por el programa de la terminal ExifTool.</p><h3>Timestamp</h3><ul><li><b>datTime</b><i> As Date</i></li></ul><p> Retorna una cadena de texto con el tiempo en formato "yyyymmddhhnnss".</p><h3>TypeVar</h3><ul><li><b>intType</b><i> As Integer</i></li></ul><p> Función que devuelve el tipo de variable como una palabra. Como parametro de entrada requiere un numero entero.</p><h3>MouseButton</h3><ul><li><b>intKey</b><i> As Integer</i></li></ul><p> Funcion que retorna el nombre en ingés del boton del ratón que se ha presionado.</p><h3>ArrayInclude</h3><ul><li><b>stxList</b><i> As String[]</i></li><li><b>strFind</b><i> As String</i></li></ul><p>Quita de la lista los textos que no tengan la cadena de texto pasada como parametro</p><h3>ArrayExclude</h3><ul><li><b>stxList</b><i> As String[]</i></li><li><b>strFind</b><i> As String</i></li></ul><p>Quita de la lista los textos que tengan la cadena de texto pasada como parametro</p><h3>FileInfo</h3><ul><li><b>strFilePath</b><i> As String</i></li></ul><p>Devuelve una matriz con datos del archivo que se le pasa como ruta.</p><h3>NamingCon</h3><p> Devuelve una lista de nombres de controles y su abreviación de tres caracteres.</p><h3>HMStoSeconds</h3><ul><li><b>strTime</b><i> As String</i></li></ul><p> Devuelve el tiempo en segundos de una cadena que se le pase con el formato HH:MM:SS HORAS:MINUTOS:SEGUNDOS.</p><h3>SecondsToHMS</h3><ul><li><b>intTime</b><i> As Integer</i></li></ul><p> Devuelve el tiempo en una matriz donde: 0-Y 1-M 2-D 3-H 4-N 5-S y como parametro de entrada requiere el tiempo en segundos</p><h3>MkConfXml</h3><ul><li><b>strXmlPath</b><i> As String</i></li></ul><p> Creacion de archivo de configuracion inicial xml.</p><h3>ListDeldup</h3><ul><li><b>stxInput</b><i> As String[]</i></li></ul><p> Elimina elementos duplicados de una lista, requiere una String[] y devuelve una String[].</p><h3>WhereRun</h3><p>Indica si el programa se esta ejecutando desde el IDE o desde un ejecutable solo utilizando código de gambas.</p><h3>ScanDir</h3><ul><li><b>strDir</b><i> As String</i></li><li><b>Opt.strExt</b><i> As String</i></li></ul><p> Escanea una carpeta que se pasa como parametro en busca de archivos se puede filtrar con una lista de extensiones separadas por dos puntos ":".</p><h2>MValidator.module</h2><h3>VEmail</h3><ul><li><b>strAddress</b><i> As String</i></li></ul><p> Validación de una direccion de correo electrónico</p><h3>ArrangeParagraph</h3><ul><li><b>strInText</b><i> As String</i></li></ul><p></p><h3>OnlyTextParenthesis</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Validación de solo texto, espacio, punto y coma entre parentesis.</p><h3>OnlyLeters</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Validación de palabras.</p><h3>CaptionCheck</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Validación del texto de un control en KDE el texto de los botones por ejemplo tiene un simbolo & delante del texto.</p><h3>NoSymbols</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Solo letras y números, y las letras sin acentos.</p><h3>OnlyNumbers</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p>Devuelve un texto solo con numeros.</p><h3>OnlyCyrilic</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Validación de palabras.</p><h3>OnlyText</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Validación de solo texto, Numeros NO, Doble espacio NO, Espacio Al principio y/o al final NO.</p><h3>OnlyTextCyrilic</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Validación de solo texto, Numeros NO, Doble espacio NO, Espacio Al principio y/o al final NO.</p><h3>ConvertPath</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p> Descodifica los caracteres hexadecimales en las URI's recorriendo la cadena dada Params: strInput la URintPos a descodificar Return: la URintPos descodificada</p><h3>VDNISpain</h3><ul><li><b>strDNI</b><i> As String</i></li></ul><p> Validación de un dni español</p><h3>VRUTChile</h3><ul><li><b>strRutIn</b><i> As String</i></li><li><b>strDigRut</b><i> As String</i></li></ul><p></p><h3>OnlyChar</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p>Devuelve un texto con sus caracteres.</p><h3>Capital</h3><ul><li><b>strInput</b><i> As String</i></li></ul><p>Devuelve un texto con la primera letra en mayusculas y todas las siguientes en minúsculas.</p><h2>MWeb.module</h2><h2>Msys.module</h2><h3>Resume</h3><p></p><h3>Distro</h3><p>Devuelve la distribución instalada xmi</p><h3>DistroShort</h3><p></p><h3>ArqSO</h3><p>Devuelve la Arquitecura del Sistema Operativo</p><h3>ArqMicro</h3><p>Devuelve la Arquitecura del Procesador</p><h3>MicroType</h3><p>Devuelve el tipo de Procesador</p><h3>Ram</h3><p>Devuelve cantidad de Ram en MB tambien con free -m</p><h3>ComputerName</h3><p>Devuelve el nombre del pc</p><h3>CurrentUser</h3><p>Devuelve el usuario activo</p><h3>GetSystemUsers</h3><p>Devuelve el una lista de usuarios del sistema Linux.</p><h3>AllUsers</h3><p>Devuelve los usuarios que hemos creado</p><h3>WGroup</h3><p> Devuelve el Grupo de trabajo del pc</p><h3>SysFile</h3><ul><li><b>ruta</b><i> As String</i></li></ul><p>Devuelve el sistema de ficheros</p><h3>Vgambas</h3><p>Devuelve la versión de gambas intalada en el pc</p><h3>ProjInfo</h3><ul><li><b>Opt.strPath</b><i> As String</i></li></ul><p>Devuelve una matriz con la información del projecto alojada en el archivo ".project" si no se le pasa el camino del archivo .project del que se desea extraer la información la funcion devolvera los datos del proyecto local. Luego, el orden de cada item es el siguiente:<ol start="0"><li>Title</li><li>Description</li><li>Authors</li><li>Vendor</li><li>Version</li><li>Component</li><li>Language</li><li>Startup</li><li>Icon</li></ol></p><h3>Ls</h3><ul><li><b>Ruta</b><i> As String</i></li></ul><p>Devuelve un listado del directorio pasado en ruta</p><h3>AddressIP</h3><p>Devuelve las Ips configuradas en el equipo</p><h3>LastNIP</h3><p>Devuelve el último digito de la Ip</p><h3>Hdserial</h3><p>Devuelve el número de serie del disco duro para utilizarlo como Pk en la BDD</p><h3>UUIDswap</h3><p></p><h3>LastUpgrade</h3><p>Devuelve la Fecha de la ultima vez que se actualizo el sistema</p><h3>PkgStat</h3><ul><li><b>strPkg</b><i> As String</i></li></ul><p>Devuelve el estado respecto a la instalacion de un paquete. Requiere como parametro de entrada el nombre exacto del paquete.</p><h3>XDGFolder</h3><p> Devuelve una matriz de texto con las rutas de las carpetas de musica, imagenes, documentos etc. del directorio /home/user</p><h3>PkgDep</h3><ul><li><b>stxPackages</b><i> As String[]</i></li></ul><p> Verifica si los paqutes que se le pasan como parametros en una matriz, estan instalados en el sistema, si alguno o todos estan pendientes de instalar este modulo propondra instalarlos y abrira la terminal de comandos para que ingreses la clave de administrador.</p><h3>PkgInstall</h3><ul><li><b>stxPackagesInstall</b><i> As String[]</i></li></ul><p> Instala los paqutes que se le pasan como parametros en una matriz de texto.</p>