duifield.h

Go to the documentation of this file.

/********************************************************************\
 * duifield.h - abstract base class for a 'field'.                  *
 * Copyright (C) 2003 Linas Vepstas <linas@linas.org>               *
 * http://dwi.sourceforge.net                                       *
 *                                                                  *
 * This library is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU Lesser General Public       *
 * License as published by the Free Software Foundation; either     *
 * version 2.1 of the License, or (at your option) any later version.
 *                                                                  *
 * This library is distributed in the hope that it will be useful,  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
 * GNU Lesser General Public License for more details.              *
 *                                                                  *
 * You should have received a copy of the GNU Lesser General Public *
 * License along with this program; if not, contact:                *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
\********************************************************************/

#ifndef DUI_FIELD_H
#define DUI_FIELD_H

#include "config.h"
#include <string.h>

typedef struct DuiField_s DuiField;
typedef const char * DuiFieldType; 

#define DUI_FIELD_NONE      "DUI_FIELD_NONE"
#define DUI_FIELD_CONST     "DUI_FIELD_CONST"    
#define DUI_FIELD_WIDGET    "DUI_FIELD_WIDGET"   
#define DUI_FIELD_WID_DATA  "DUI_FIELD_WID_DATA"  
#define DUI_FIELD_WID_ARG   "DUI_FIELD_WID_ARG"   
#define DUI_FIELD_WID_WHERE "DUI_FIELD_WID_WHERE" 
#define DUI_FIELD_HASH_KEY  "DUI_FIELD_HASH_KEY"  
#define DUI_FIELD_SQL       "DUI_FIELD_SQL"       
#define DUI_FIELD_WHERE     "DUI_FIELD_WHERE"     
#define DUI_FIELD_GOBJ      "DUI_FIELD_GOBJ"      
#define DUI_FIELD_QOF       "DUI_FIELD_QOF"       
#define DUI_FIELD_QOF_MATCH "DUI_FIELD_QOF_MATCH" 
#define DUI_FIELD_IS_TYPE(fld,typ) (0==strcmp((fld)->type,typ))

struct DuiField_s
{
    DuiFieldType type;
    char * fieldname;

    const char * (*get_field_value) (DuiField *);

    void (*set_field_value) (DuiField *, const char *);

    void (*clear_field) (DuiField *);

    void     (*iter_pre)    (DuiField *, gboolean do_clear);
    gboolean (*iter_next)   (DuiField *);
    void     (*iter_column) (DuiField *, DuiField *);
    void     (*iter_post)   (DuiField *);
    union 
    {
        char * value;

        gpointer priv[8];
    } u;
};

const char * dui_field_get_fieldname (DuiField *fs);

void dui_field_clear (DuiField *s);

void dui_field_set_const (DuiField *fs, const char *value);

void dui_field_iter_pre (DuiField *matcher, gboolean do_clear);

gboolean dui_field_iter_next (DuiField *matcher);

void dui_field_iter_column (DuiField *target_column, DuiField *matcher);

void dui_field_iter_post (DuiField *matcher);

gpointer get_gobj_field (DuiField *f);

#endif /* DUI_FIELD_H */

---