qofclass.h

Go to the documentation of this file.

/********************************************************************\
 * qofclass.h -- API for registering parameters on objects          *
 *                                                                  *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program 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 General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/

#ifndef QOF_CLASS_H
#define QOF_CLASS_H

#include "qofid.h"

#ifdef __cplusplus
extern "C"
{
#endif

#define QOF_MOD_CLASS "qof.class"

#define QOF_TYPE_STRING    "string"
#define QOF_TYPE_DATE      "date"
#define QOF_TYPE_NUMERIC   "numeric"
#define QOF_TYPE_DEBCRED   "debcred"
#define QOF_TYPE_GUID      "guid"
#define QOF_TYPE_INT32     "gint32"
#define QOF_TYPE_INT64     "gint64"
#define QOF_TYPE_DOUBLE    "double"
#define QOF_TYPE_BOOLEAN   "boolean"
#define QOF_TYPE_KVP       "kvp"
#define QOF_TYPE_CHAR      "character"
#define QOF_TYPE_CHOICE    "choice"     /* was moved from (deleted) qofchoice.h */
#define QOF_TYPE_COLLECT   "collection" 
                typedef const char * QofType;

typedef struct _QofParam QofParam;

typedef gpointer (*QofAccessFunc)(gpointer object, /*@ null @*/ const QofParam *param);

typedef void (*QofSetterFunc) (gpointer, /*@ null @*/ gpointer);

/* A callback for how to compare two (same-type) objects based on a
 * common getter (parameter member), using the provided comparison
 * options (which are the type-specific options).
 */
typedef gint (*QofCompareFunc) (gpointer a, gpointer b,
                                gint compare_options,
                                QofParam *getter);

struct _QofParam
{
    const char       * param_name;
    QofType            param_type;
    QofAccessFunc      param_getfcn;
    QofSetterFunc      param_setfcn;
    QofCompareFunc     param_compfcn;
    gpointer           param_userdata;
};

typedef int (*QofSortFunc)(gconstpointer, gconstpointer);

void qof_class_register (QofIdTypeConst obj_name,
                         QofSortFunc default_sort_fcn,
                         const QofParam *params);

gboolean qof_class_is_registered (QofIdTypeConst obj_name);

QofType qof_class_get_parameter_type (QofIdTypeConst obj_name,
                                      const char *param_name);

const QofParam * qof_class_get_parameter (QofIdTypeConst obj_name,
        const char *parameter);

QofAccessFunc qof_class_get_parameter_getter (QofIdTypeConst obj_name,
        const char *parameter);

QofSetterFunc qof_class_get_parameter_setter (QofIdTypeConst obj_name,
        const char *parameter);

typedef void (*QofClassForeachCB) (QofIdTypeConst, gpointer);

void qof_class_foreach (QofClassForeachCB, gpointer user_data);

typedef void (*QofParamForeachCB) (QofParam *, gpointer user_data);

void qof_class_param_foreach (QofIdTypeConst obj_name,
                              QofParamForeachCB, gpointer user_data);

GList* qof_class_get_referenceList(QofIdTypeConst type);


#ifdef __cplusplus
}
#endif

#endif /* QOF_CLASS_H */