gui/form.h

   1 /* Manejo de Formularios con CURSES */
   2
   3 #ifndef _FORM_H_
   4 #define _FORM_H_
   5
   6 #include <string.h>
   7 #include <stdlib.h>
   8 #include <curses.h>
   9
  10 #include "malloc_debug.h"
  11
  12 /** Tipos de Widgets válidos */
  13 typedef enum {INPUT, RADIO} t_Campo;
  14
  15 /** Tipo de dato Widget */
  16 typedef struct _elem_ {
  17         /** Nombre */
  18         char *nombre;
  19         /** Tipo */
  20         t_Campo tipo;
  21         /** Dato a manejar
  22          *
  23          *  El dato puede ser simple o múltiple, dependiendo
  24          *  si se opta por referencias valor u opciones.
  25          *
  26          *  Consulte la documentación de union de ANSI-C para
  27          *  mas datos
  28          */
  29         union {
  30                 char *valor;
  31                 char **opciones;
  32         };
  33         /** Elemento actual (si se utiliza valores múltiples */
  34         unsigned int actual;
  35         /** Máximo de elementos
  36          *
  37          *  El uso varía según el Widget :
  38          *   INPUT : Cantidad máxima de caracteres.
  39          *   RADIO : Cantidad de Opciones
  40          */
  41         unsigned int max;
  42         /** Siguiente elemento */
  43         struct _elem_ *sig;
  44
  45         /* Métodos */
  46         int (*ejecutar)(WINDOW *win, int x, int y, struct _elem_ *w);
  47         void (*destruir)(struct _elem_ *);
  48 } t_Widget;
  49
  50 typedef struct _form_ {
  51         t_Widget *primero, *ultimo; /* puntero a widgets */
  52         WINDOW *win;
  53 } t_Form;
  54
  55 /** Inicializa un formulario
  56  *
  57  *  \param win Ventana a la que pertenece
  58  * */
  59 t_Form *form_crear(WINDOW *win);
  60
  61 /** Libera un formulario */
  62 int form_destruir(t_Form *);
  63 /** Agrega un nuevo campo
  64  *
  65  *  Significado de <em>max</em> según tipo:
  66  *    INPUT : Cantidad máxima de caracteres de la entrada.
  67  *    RADIO : Cantidad de opciones
  68  *
  69  *  Significado de <em>defecto</em> según tipo
  70  *    INPUT : Nada.
  71  *    RADIO : Texto separado por comas (',') de las opciones disponibles.
  72  *
  73  *  \param f Formulario
  74  *  \param tipo Tipo de campo a agregar [INPUT|RADIO].
  75  *  \param nombre Nombre del campo. Es también utilizado como etiqueta.
  76  *  \param max Su uso depende del campo tipo.
  77  *  \param defecto Su uso depende del campo tipo.
  78  */
  79 void form_agregar_widget(t_Form *f, t_Campo tipo, const char *nombre, unsigned int max, const char *defecto);
  80
  81 /** Ejecuta una entrada del formulario
  82  *
  83  *  Esta función va recorriendo uno por uno los campos del formulario
  84  *  y dependiendo del tipo ejecutando su acción asociada.
  85  *
  86  *  Cuando se ha pasado por todos los campos el formulario retorna el control.
  87  *
  88  *  \param f Formulario.
  89  *  \param x Coordenada X de inicio del formulario.
  90  *  \param y Coordenada Y de inicio del formulario.
  91  */
  92 void form_ejecutar(t_Form *f, int x, int y);
  93
  94 /** Obtiene el valor asociado a un campo
  95  *
  96  *  \param f Formulario.
  97  *  \param widget Nombre del campo.
  98  *  \return "" Si no se encontro nada.
  99  */
 100 char *form_obtener_valor(t_Form *f, const char *widget);
 101
 102 #endif
 103