1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>QOF: qofid.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6-20040222 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>qofid.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
QOF entity type identification system.
<p>
<dl compact><dt><b>Author:</b></dt><dd>Copyright (C) 2000 Dave Peticolas <<a href="mailto:peticola@cs.ucdavis.edu">peticola@cs.ucdavis.edu</a>> <p>
Copyright (C) 2003 Linas Vepstas <<a href="mailto:linas@linas.org">linas@linas.org</a>></dd></dl>
<p>
<code>#include <string.h></code><br>
<code>#include "<a class="el" href="guid_8h.html">guid.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><b>QofEntity_s</b></td></tr>
<tr><td colspan=2><br><h2>Collections of Entities</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef void(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga4">QofEntityForeachCB</a> )(QofEntity *, gpointer user_data)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga8" doxytag="qofid.h::qof_collection_new" ></a>
QofCollection * </td><td class="memItemRight" valign=bottom><b>qof_collection_new</b> (QofIdType type)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga9">qof_collection_destroy</a> (QofCollection *col)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>QofIdType </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga10">qof_collection_get_type</a> (QofCollection *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>QofEntity * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga11">qof_collection_lookup_entity</a> (QofCollection *, const <a class="el" href="union__GUID.html">GUID</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga12">qof_collection_foreach</a> (QofCollection *, <a class="el" href="group__Entities.html#ga4">QofEntityForeachCB</a>, gpointer user_data)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gpointer </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga13">qof_collection_get_data</a> (QofCollection *col)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga14" doxytag="qofid.h::qof_collection_set_data" ></a>
void </td><td class="memItemRight" valign=bottom><b>qof_collection_set_data</b> (QofCollection *col, gpointer user_data)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gboolean </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga15">qof_collection_is_dirty</a> (QofCollection *col)</td></tr>
<tr><td colspan=2><br><h2>QOF Entity Initialization & Shutdown</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga5">qof_entity_init</a> (QofEntity *, QofIdType, QofCollection *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga6">qof_entity_release</a> (QofEntity *)</td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga16" doxytag="qofid.h::QOF_ID_NONE" ></a>
#define </td><td class="memItemRight" valign=bottom><b>QOF_ID_NONE</b> NULL</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga17" doxytag="qofid.h::QOF_ID_NULL" ></a>
#define </td><td class="memItemRight" valign=bottom><b>QOF_ID_NULL</b> "null"</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga18" doxytag="qofid.h::QOF_ID_BOOK" ></a>
#define </td><td class="memItemRight" valign=bottom><b>QOF_ID_BOOK</b> "Book"</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga19" doxytag="qofid.h::QOF_ID_FREQSPEC" ></a>
#define </td><td class="memItemRight" valign=bottom><b>QOF_ID_FREQSPEC</b> "FreqSpec"</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga20" doxytag="qofid.h::QOF_ID_SESSION" ></a>
#define </td><td class="memItemRight" valign=bottom><b>QOF_ID_SESSION</b> "Session"</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga21">QOF_ENTITY</a>(object) ((QofEntity *)(object))</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga22">QSTRCMP</a>(da, db)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga23">QOF_CHECK_TYPE</a>(obj, type) (0 == QSTRCMP((type),(((QofEntity *)(obj))->e_type)))</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga24">QOF_CHECK_CAST</a>(obj, e_type, c_type)</td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga0" doxytag="qofid.h::QofIdType" ></a>
typedef const char * </td><td class="memItemRight" valign=bottom><b>QofIdType</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga1" doxytag="qofid.h::QofIdTypeConst" ></a>
typedef const char * </td><td class="memItemRight" valign=bottom><b>QofIdTypeConst</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga2" doxytag="qofid.h::QofEntity" ></a>
typedef QofEntity_s </td><td class="memItemRight" valign=bottom><b>QofEntity</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga3" doxytag="qofid.h::QofCollection" ></a>
typedef QofCollection_s </td><td class="memItemRight" valign=bottom><b>QofCollection</b></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="union__GUID.html">GUID</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga7">qof_entity_get_guid</a> (QofEntity *)</td></tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun May 23 15:41:46 2004 for QOF by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.6-20040222 </small></address>
</body>
</html>
|