Funciones y procedimientos tiles de Delphi

No todo en Delphi son objetos. Adems de la librera de componentes existe una librera de funciones y procedimientos de utilidad. Son las mismas que conformaban la batera de funciones de las versiones anteriores de Turbo Pascal, con algunos agregados muy prcticos. Repasaremos ahora algunas de las ms utilizadas. La referencia completa, como siempre, se puede encontrar en la ayuda del producto.

IntToStr
function IntToStr(Value: Longint): string;

Esta funcin toma un valor numrico entero y lo transforma a string. Para transformar un valor real, use la funcin FloatToStr..

StrToInt
function StrToInt(const S: string): Longint;

Esta funcin toma una cadena compuesta por nmeros y la transforma al valor entero correspondiente. Si no se puede convertir, se provoca una excepcin EconvertError. Para convertir un valor real, use la funcin StrToFloat o StrToFloatF

StrToIntDef
function StrToIntDef(const s: string; Default: integer): string;

Esta funcin toma una cadena compuesta por nmeros y la transforma al valor entero correspondiente, al igual que StrToInt; pero si la cadena s no contiene un valor entero vlido, devuelve el valor dado en Default en lugar de generar un error.

FloatToStr
function FloatToStr(Value: Extended): string;

Esta funcin toma un valor numrico real y lo transforma a string. No se puede controlar el formato del string resultante; para esto, utilice la funcin FloatToStrF. Para transformar un valor entero, use la funcin IntToStr..

StrToFloat
function StrToFloat(const S: string): Extended;

Esta funcin toma una cadena y la transforma al valor real correspondiente. Si no se puede convertir, se provoca una excepcin EconvertError. Son vlidos en el string los smbolos +, -, E (que indica notacin cientfica y quiere decir por diez a la...) y el separador decimal. Este separador (normalmente el punto o la coma) se define en el Panel de Control de Windows. No obstante, es posible cambiarlo localmente, solamente para nuestro programa, asignando el valor deseado a la variable DecimalSeparator. Veamos un par de ejemplos: ! el String 5,32E2" se convierte al nmero 532. ! el String -43.23" se convierte en el nmero -43.23 ! para utilizar siempre la coma como separador decimal, al margen de lo que est definido en el Panel de Control, podemos hacer

DecimalSeparator:= ','; al principio de la aplicacin, por ejemplo en el evento OnCreate del form principal. Para convertir un valor entero, use la funcin StrToInt.

FloatToStrF
function FloatToStrF(Value: Extended; Format: TFloatFormat; Precision, Digits: Integer): string;

Esta funcin convierte un nmero real a su representacin en caracteres (string) con el formato especificado. Los parmetros son los siguientes: ! Value: el nmero real a convertir ! Format: especifica el formato del string resultante. Puede ser alguna de las constantes siguientes: " ffGeneral: el valor es convertido a la forma ms corta posible, usando notacin cientfica si es necesario. " ffExponent: el valor es convertido a notacin cientfica " ffFixed: notacin normal, con al menos un dgito antes de la coma decimal y la cantidad de dgitos decimales despus de la coma dada por Digits. " ffNumber: el mismo formato que para ffFixed pero con separadores de miles. " ffCurrency: un valor monetario ! Precision: especifica la precisin del resultado; debe ser 7 o menos para variables de tipo single, 15 o menos para tipo double y 18 o menos para extended. ! Digits: indica la cantidad de dgitos decimales cuando no se usa la notacin cientfica, o la cantidad de dgitos del exponente cuando se la utiliza.

StrToDate
function StrToDate(const S: string): TdateTime;

Convierte una cadena a Fecha. El formato se especifica en el Panel de Control de Windows, y dentro de la aplicacin se puede consultar o modificar con las variables DateSeparator (separador: normalmente la barra inclinada /) y ShortDateFormat (indica el orden de los componentes; por ejemplo 'd/m/y' para da/mes/ao o 'm/d/y' para mes/da/ao).

DateToStr
function DateToStr(Date: TDateTime): string;

Convierte una fecha a cadena. El formato de la cadena resultante est dado por la variable ShortDateFormat, como se explica en la funcin StrToDate ms arriba. De la misma manera se definen dos funciones StrToTime y TimeToStr que convierten entre cadenas y variables de tipo tDateTime pero considerando la parte de la hora, no la fecha. El carcter que se utiliza aqu para separar las distintas partes de la especificacin est almacenado en la variable TimeSeparator (usualmente :).

Format
function Format(const Format: string; const Args: array of const): string;

Esta funcin nos permite crear un string con datos de distintos tipos fcilmente. La cadena que queremos de resultado contiene caracteres especiales que indican dnde insertar los valores dados en el argumento Args, y con algn control sobre el formato de la conversin. Los parmetros son los siguientes: Args: un array de valores. Es una lista de valores a ser introducidos en la expresin final, separados por comas y encerrados entre corchetes. El reemplazo se hace en orden de aparicin, es decir que el primer valor reemplaza al primer cdigo, el segundo al segundo y as sucesivamente. Format: el string a ser formateado, con cdigos especiales que indican el tipo de dato que debe reemplazar. El string tiene el siguiente formato:

"%" [indice ":"] ["-"] [ancho] ["." precisin] tipo

comienza con un signo de porcentaje %. El nico especificador obligatorio es el de tipo, que puede ser una letra de las siguientes: d Decimal. El argumento correspondiente debe ser un valor entero, que se convierte a un string de dgitos decimales. Si la cadena de formato tiene una especificacin de precisin, indica que el string resultante debe contener al menos la cantidad especificada de dgitos; si tiene menos, se rellena con espacios a la izquierda. e Notacin cientfica. El argumento debe ser un nmero en punto flotante. El valor se convierte a un string de la forma d.ddd...E+ddd. Siempre hay un dgito precediendo al punto decimal, y si el nmero es negativo se coloca un signo menos delante. El nmero total de caracteres de la cadena resultante -incluyendo el punto decimal- es dado por el especificador de precisin de la cadena de formato. Si no se da este especificador, se toma una precisin de 15. La parte que sigue a la letra E (que indica 10 elevado a la cantidad que sigue) tiene siempre tres dgitos y un signo, + o -. f Precisin fija. El argumento debe ser un nmero de punto flotante, que es convertido a un string de la forma ddd.ddd.... Si el nmero es negativo se agrega el signo menos delante. El nmero de dgitos se especifica con la precisin, tomndose un valor por defecto de 2. g General. El argumento debe ser un nmero de punto flotante, que se convierte a la cadena decimal ms corta posible, usando formato fijo o cientfico. El nmero de dgitos se especifica con la precisin, tomndose 15 por defecto. n Nmero. El argumento debe ser un nmero en punto flotante, que se convierte a un string de la forma d.ddd.ddd.ddd,ddd.... Es igual que el formato con f pero con separadores de miles. m Monetario. El argumento debe ser un nmero en punto flotante, que se convierte a un string representando un valor monetario. El formato de la cadena es controlado por las variables globales CurrencyString, CurrencyFormat, NegCurrFormat, ThousandSeparator, DecimalSeparator, y CurrencyDecimals que se inicializan con los valores del panel de control de Windows, seccin Internacional. Si se especifica un valor de precisin, tiene prioridad sobre el valor de la variable CurrencyDecimals. p Puntero. El argumento debe ser un valor de puntero, que es convertido a la forma segmento:offset XXXX:YYYY con dgitos hexadecimales. s String. El argumento debe ser un caracter, un string o un valor pChar. La cadena se inserta en el lugar del identificador de formato. Si se especifica un valor de precisin, se toma como longitud mxima de la cadena resultante (si se pasa de esta longitud, se trunca). x Hexadecimal. El argumento debe ser un valor entero, que se convierte a una cadena de dgitos hexadecimales. Si se especifica una precisin, se toma como la cantidad mnima de dgitos que debe contener la cadena resultante, llenndose por la izquierda con ceros. Los especificadores de ndice, ancho y precisin pueden ser dados directamente con dgitos decimales, o a travs de parmetros indicando en la cadena de formato un asterisco *. Por ejemplo, format(%*.*f, [8,2,123.456]) es lo mismo que format(%8.2f,[123.456]) El especificador de ancho indica el mnimo ancho de un campo para la conversin. Si la cadena resultante es ms corta, se llena con espacios a la izquierda; salvo que se especifique tambin el indicador de justificacin a la izquierda (un signo menos antes del ancho) en cuyo caso los espacios se agregan a la derecha. El indicador de ndice nos permite reutilizar los valores del array de parmetros. Este nmero especifica el ndice del parmetro a usar en el prximo reemplazo. Por ejemplo, format(%d %d %1:d,[1,2,3]) da como resultado la cadena 1 2 2'.

DateToStr
function DateToStr(Date: TDateTime): string;

Convierte una fecha dada en formato TdateTime a un string.

StrToDate

function StrToDate(const S: string): TDateTime;

Convierte un string en TdateTime. Toma la hora como las 0:00. Si no puede convertir (el string contiene una fecha errnea) se genera una excepcin EconvertError. Si se ingresa el ao con slo dos dgitos, se determina el siglo a que pertenece utilizando la variable global TwoDigitYearCenturyWindow. Los detalles se pueden ver en la ayuda, con ejemplos.

IncMonth
function IncMonth(const Date: TDateTime; NumberOfMonths: Integer): TDateTime;

Incrementa la fecha pasada como parmetro (Date) en el nmero de meses dado por NumberOfMonths, tomando en cuenta el cambio de ao y la diferencia de das entre los meses, si es necesario. El nmero de meses a incrementar puede ser negativo, dando como resultado una fecha anterior a la original.

Mensajes y notificaciones
Muchas veces nos encontraremos con que tenemos que mostrar mensajes al usuario de manera de atraer su atencin. Para cumplir este objetivo, es generalmente deseable que el mensaje sea presentado en una ventana secundaria que se mostrar sobre las dems y tendr que ser cerrada para poder continuar trabajando en el mismo programa (ventana Modal). Microsoft ha especificado algunos criterios para este tipo de ventanas en sus Windows Interface Guidelines for Software Design (Lineamientos para el diseo de interfaces en programas de Windows). Viene al caso comentar algunos de estos criterios. Siempre es preferible evitar las situaciones que demandan la presentacin de un mensaje. Si por ejemplo una determinada tarea necesita algunos recursos especiales para ser realizada, es mejor controlar la existencia de los mismos y deshabilitar el comando antes que permitir al usuario intentar la operacin y mostrar luego un mensaje indicando la falta de recursos. El ttulo del mensaje debe ser claro sobre quin produjo el mensaje. Mucho ms tomando en cuenta que varias aplicaciones pueden estar funcionando simultneamente; incluso dentro de una misma aplicacin podemos tener un documento compuesto con objetos OLE. Por lo tanto es importante indicar en el ttulo la aplicacin (y eventualmente el documento) que genera el mensaje. Nunca utilice en el ttulo de una ventana de mensaje la palabra Error. Intente evitar la palabra Error en general: en lugar de Error en el nombre de archivo utilice No se encuentra el archivo. Utilice frases simples y entendibles para el usuario comn. Evite mencionar caractersticas tcnicas. Exprese el problema, su causa si es posible, y las acciones que el usuario puede tomar para corregirlo. En lugar de No hay espacio en disco utilice El documento XXXX no pudo grabarse por falta de espacio en disco. Seleccione otro disco o libere un poco de espacio y vuelva a intentarlo Trate de ofrecer la solucin como una opcin. Por ejemplo, en el ejemplo anterior de falta de espacio en disco se podra ofrecer al usuario vaciar la papelera. Limite el mensaje a dos o tres lneas. Si es necesaria ms informacin, ofrezca un botn Ayuda que muestre la ventana de ayuda general en el tpico correspondiente. Veamos ahora las funciones de Pascal que hacen posible mostrar una ventana de notificacin en forma simple y rpida. Recuerde que siempre es posible sortear las limitaciones de estas funciones (por ejemplo, para agregar un botn no considerado o una animacin) creando un cuadro de dilogo propio.

ShowMessage
procedure ShowMessage(const Msg: string);

Presenta en pantalla una caja de dilogo con el mensaje pasado como parmetro centrado sobre un botn OK. El ttulo de la ventana es el nombre del ejecutable y no se puede cambiar. Es slo para presentar mensajes en una forma fcil y rpida, generalmente usada por los programadores durante el desarrollo.

Otra funcin relacionada que nos permite ms control sobre los botones y el ttulo es MessageDlg

MessageDlg
function MessageDlg(const Msg: string; AType: TMsgDlgType; Abuttons: HelpCtx: Longint): Word; TmsgDlgButtons;

Esta funcin muestra una caja de dilogo con un mensaje nuestro, permitiendo adems especificar el ttulo y los botones, as como un icono caracterstico del tipo de mensaje. Los parmetros son los siguientes: Msg: un string con el mensaje que debe presentar centrado en la caja de dilogo. aType: una constante que identifica el tipo de mensaje (y el ttulo de la caja de dilogo). Los valores posibles son los siguientes: mtWarning: caja de dilogo con un signo de exclamacin amarillo. Ttulo: Warning. mtError: caja de dilogo con un signo de Stop rojo. Ttulo: Error. mtInformation: contiene un icono con una letra i azul. Ttulo: Information. mtConfirmation: contiene un icono con un signo de pregunta verde. Ttulo: Confirmation. mtCustom: no contiene icono. El ttulo es el nombre de la aplicacin. aButtons: un set de constantes que especifican los botones que debe mostrar la caja. Los valores posibles son los siguientes: mbYes, mbNo, mbOK, mbCancel, mbHelp, mbAbort, mbRetry (Reintentar), mbIgnore (Ignorar), mbAll (todo) Adems de estos valores (a ser usados entre corchetes, es decir formando un set) estn definidos algunos conjuntos de uso comn (no se ponen entre corchetes, ya estn definidos como conjuntos): mbYesNoCancel: botones Yes, No, Cancel. mbOkCancel: botones Ok, Cancel. mbAbortRetryIgnore: botones Abort, Retry, Ignore. HelpCtx: determina la pgina de ayuda a usar para la caja de dilogo. Cuando se presiona un botn se cierra la caja de dilogo y la funcin MessageDlg devuelve un valor de tipo Word que indica el botn que fue presionado. Estos valores son constantes predefinidas: mrNone, mrOk, mrCancel, mrAbort, mrRetry, mrIgnore, mrYes, mrNo, mrAll

Ejemplos
La lnea siguiente pide confirmacin al usuario:
MessageDlg('Esta operacin no se puede deshacer. Est seguro de querer borrar el registro?',mtConfirmation,[mbYes,mbNo,mbCancel],0);

el mismo resultado se logra utilizando uno de los conjuntos de botones predefinidos:

MessageDlg('Esta operacin no se puede deshacer. Est seguro de querer borrar el registro?',mtConfirmation,mbYesNoCancel,0);

la lnea siguiente presenta un mensaje preguntando al usuario si desea grabar los datos; segn la respuesta, se ejecuta una parte u otra de la aplicacin
if MessageDlg('Desea grabar los datos?',mtConfirmation,[mbYes,mbNo],0)=mrYes then {Grabar los datos} else {no graba los datos}

Existe todava otra forma de presentar un mensaje al usuario, un poco ms configurable: la funcin MessageBox.

MessageBox

Actualmente, existen dos versiones de esta funcin con el mismo nombre: una en la API de Windows y un mtodo de la clase tApplication. La nica diferencia entre ellas es que el segundo provee automticamente el manejador de ventana requerido por la funcin API. Veamos las declaraciones de las dos: Funcin API:
function MessageBox(hWnd: HWND; lpText, lpCaption: PChar; uType: UINT): Integer;

Mtodo de tApplication:
function MessageBox(Text, Caption: PChar; Flags: Longint): Integer;

Los parmetros son los mismos (salvo algunos nombres diferentes, que no alteran el resultado). Dado que en cualquier lugar del programa tenemos acceso a la instancia de tApplication que corresponde al mismo, discutiremos aqui la segunda versin (que se accede como Application.MessageBox). Text: en este parmetro especificamos el mensaje que queremos mostrar Caption: el ttulo de la ventana Flags: especifica los botones y el comportamiento del cuadro de dilogo. Veremos aqu los valores ms utilizados; para una referencia completa, vea la ayuda de la funcin en la API de Windows. Los valores se pueden combinar sumndolos. MB_ABORTRETRYIGNORE: botones Abort, Retry, Ignore (Cancelar, Reintentar, Ignorar) MB_OK: botn OK MB_OKCANCEL: botones OK y Cancel MB_RETRYCANCEL: botones Retry (Reintentar) y Cancel MB_YESNO: botones Yes (Si) y No MB_YESNOCANCEL: botones Yes, No y Cancel

El primer botn es marcado como botn por defecto (presionar ENTER en el teclado tiene el mismo efecto que presionar este botn) a menos que se especifique alguna de las siguientes constantes en el parmetro Flags: MB_DEFBUTTON2: el segundo botn es el botn por defecto MB_DEFBUTTON3: dem para el tercer botn MB_DEFBUTTON4: dem para el cuarto botn Tambin es posible indicar que queremos un dibujo explicativo (icono) en la ventana, utilizando las siguientes constantes:

MB_ICONASTERISK, MB_ICONINFORMATION Este icono indica que el mensaje es una informacin nicamente; no se deberan ofrecer opciones al usuario, slo el botn Cerrar o OK.

MB_ICONHAND, MB_ICONERROR*, MB_ICONSTOP Este tipo de mensaje notifica al usuario de alguna anomala seria que requiere su intervencin (la impresora no est lista, no hay disquete en la unidad, etc.). Normalmente se ofrecer al usuario la opcin de reintentar o cancelar la operacin.

MB_ICONEXCLAMATION, MB_ICONWARNING* Informa de una situacin que requiere que el usuario tome una decisin antes de proseguir, acciones que pueden ser destructivas o irreversibles como reemplazar un bloque de texto demasiado extenso, borrar un registro en una tabla o reemplazar un archivo ya existente. Se dan a usuario las opciones necesarias a travs de los botones.

MB_ICONQUESTION De acuerdo con los lineamientos de diseo para Windows 95 y NT, este smbolo no debera utilizarse y Las constantes marcadas con un asterisco (*) slo estn definidas en Windows 95 (Delphi 2 o superior).