QOF: qofclass.h File Reference

QOF 0.7.5

Data Structures | Macros | Typedefs | Functions
qofclass.h File Reference
Query Object Framework » Class: Getting and setting entity values.

API for registering paramters on objects. More...

`#include "qofid.h"`

Go to the source code of this file.

## Data Structures
struct | _QofParam

## Macros
#define | QOF_MOD_CLASS "qof-class"
Core types
Core data types for objects that can be used in parameters. Note that QofIdTypes may also be used and will create a single reference between two known objects.
#define | QOF_TYPE_STRING "string"
#define | QOF_TYPE_TIME "time"
#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_COLLECT "collection"

## Typedefs
typedef const gchar * | QofType
typedef struct _QofParam | QofParam
typedef gpointer(* | QofAccessFunc) (gpointer object, const QofParam *param)
typedef void(* | QofSetterFunc) (gpointer, gpointer)
typedef gint(* | QofSortFunc) (gconstpointer, gconstpointer)
typedef void(* | QofClassForeachCB) (QofIdTypeConst, gpointer)
typedef void(* | QofParamForeachCB) (QofParam *, gpointer user_data)

## Functions
void | qof_class_register (QofIdTypeConst obj_name, QofSortFunc default_sort_fcn, const QofParam *params)
| registers a new object class with the Qof subsystem. More...
gboolean | qof_class_is_registered (QofIdTypeConst obj_name)
QofType | qof_class_get_parameter_type (QofIdTypeConst obj_name, const gchar *param_name)
const QofParam * | qof_class_get_parameter (QofIdTypeConst obj_name, const gchar *parameter)
QofAccessFunc | qof_class_get_parameter_getter (QofIdTypeConst obj_name, const gchar *parameter)
QofSetterFunc | qof_class_get_parameter_setter (QofIdTypeConst obj_name, const gchar *parameter)
void | qof_class_foreach (QofClassForeachCB, gpointer user_data)
void | qof_class_param_foreach (QofIdTypeConst obj_name, QofParamForeachCB, gpointer user_data)
GList * | qof_class_get_referenceList (QofIdTypeConst type)
| List of the parameters that could be references. More...

## Detailed Description

API for registering paramters on objects.

Author
  Copyright (C) 2002 Derek Atkins warlo.nosp@m.rd@M.nosp@m.IT.ED.nosp@m.U
  Copyright (C) 2003 Linas Vepstas linas.nosp@m.@lin.nosp@m.as.or.nosp@m.g
  Copyright (c) 2005,2006 Neil Williams linux.nosp@m.@cod.nosp@m.ehelp.nosp@m..co..nosp@m.uk

Definition in file qofclass.h.