File: group__Entities.html

package info (click to toggle)
qof 0.5.0-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,376 kB
  • ctags: 2,995
  • sloc: ansic: 14,210; sh: 7,273; makefile: 204; yacc: 184; lex: 123
file content (569 lines) | stat: -rw-r--r-- 24,499 bytes parent folder | download
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
<!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: Entities</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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>Entities<br>
<small>
[<a class="el" href="group__Entity.html">Entity: Types, Identity and Instance Framework</a>]</small>
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
This file defines an API that adds types to the GUID's. GUID's with types can be used to identify and reference typed entities.<p>
The idea here is that a GUID can be used to uniquely identify some thing. By adding a type, one can then talk about the type of thing identified. By adding a collection, one can then work with a handle to a collection of things of a given type, each uniquely identified by a given ID. QOF Entities can be used independently of any other part of the system. In particular, Entities can be useful even if one is not using the Query ond Object parts of the QOF system.<p>
Identifiers are globally-unique and permanent, i.e., once an entity has been assigned an identifier, it retains that same identifier for its lifetime. Identifiers can be encoded as hex strings.<p>
GUID Identifiers are 'typed' with strings. The native ids used by QOF are defined below. An id with type QOF_ID_NONE does not refer to any entity, although that may change (???). An id with type QOF_ID_NULL does not refer to any entity, and will never refer to any entity. An identifier with any other type may refer to an actual entity, but that is not guaranteed (??? Huh?). If an id does refer to an entity, the type of the entity will match the type of the identifier.<p>
If you have a type name, and you want to have a way of finding a collection that is associated with that type, then you must use Books. 
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Files</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>file &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="qofid_8h.html">qofid.h</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">QOF entity type identification system. <br><br></td></tr>

<p>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</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(*&nbsp;</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="Entities::qof_collection_new" ></a>
QofCollection *&nbsp;</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&nbsp;</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&nbsp;</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 *&nbsp;</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&nbsp;</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&nbsp;</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="Entities::qof_collection_set_data" ></a>
void&nbsp;</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&nbsp;</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 &amp; Shutdown</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</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&nbsp;</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="Entities::QOF_ID_NONE" ></a>
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>QOF_ID_NONE</b>&nbsp;&nbsp;&nbsp;NULL</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga17" doxytag="Entities::QOF_ID_NULL" ></a>
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>QOF_ID_NULL</b>&nbsp;&nbsp;&nbsp;"null"</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga18" doxytag="Entities::QOF_ID_BOOK" ></a>
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>QOF_ID_BOOK</b>&nbsp;&nbsp;&nbsp;"Book"</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga19" doxytag="Entities::QOF_ID_FREQSPEC" ></a>
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>QOF_ID_FREQSPEC</b>&nbsp;&nbsp;&nbsp;"FreqSpec"</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga20" doxytag="Entities::QOF_ID_SESSION" ></a>
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>QOF_ID_SESSION</b>&nbsp;&nbsp;&nbsp;"Session"</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga21">QOF_ENTITY</a>(object)&nbsp;&nbsp;&nbsp;((QofEntity *)(object))</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</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&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga23">QOF_CHECK_TYPE</a>(obj, type)&nbsp;&nbsp;&nbsp;(0 == QSTRCMP((type),(((QofEntity *)(obj))-&gt;e_type)))</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</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="Entities::QofIdType" ></a>
typedef const char *&nbsp;</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="Entities::QofIdTypeConst" ></a>
typedef const char *&nbsp;</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="Entities::QofEntity" ></a>
typedef QofEntity_s&nbsp;</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="Entities::QofCollection" ></a>
typedef QofCollection_s&nbsp;</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> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__Entities.html#ga7">qof_entity_get_guid</a> (QofEntity *)</td></tr>

</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="ga24" doxytag="qofid.h::QOF_CHECK_CAST" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define QOF_CHECK_CAST</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">obj,         <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>e_type,         <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>c_type&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<b>Value:</b><div class="fragment"><pre>(                   \
  <a class="code" href="group__Entities.html#ga23">QOF_CHECK_TYPE</a>((obj),(e_type)) ?                            \
  (c_type *) (obj) :                                          \
  (c_type *) ({                                               \
     g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,               \
       <span class="stringliteral">"Error: Bad QofEntity at %s:%d"</span>, __FILE__, __LINE__);  \
     (obj);                                                   \
  }))
</pre></div>cast object to the indicated type, print error message if its bad     </td>
  </tr>
</table>
<a class="anchor" name="ga23" doxytag="qofid.h::QOF_CHECK_TYPE" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define QOF_CHECK_TYPE</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">obj,         <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>type&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;(0 == QSTRCMP((type),(((QofEntity *)(obj))-&gt;e_type)))
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
return TRUE if object is of the given type     </td>
  </tr>
</table>
<a class="anchor" name="ga21" doxytag="qofid.h::QOF_ENTITY" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define QOF_ENTITY</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">object&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;((QofEntity *)(object))
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
simple,cheesy cast but holds water for now     </td>
  </tr>
</table>
<a class="anchor" name="ga22" doxytag="qofid.h::QSTRCMP" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define QSTRCMP</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">da,         <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>db&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<b>Value:</b><div class="fragment"><pre>({                \
  <span class="keywordtype">int</span> val = 0;                           \
  <span class="keywordflow">if</span> ((da) &amp;&amp; (db)) {                    \
    <span class="keywordflow">if</span> ((da) != (db)) {                  \
      val = strcmp ((da), (db));         \
    }                                    \
  } <span class="keywordflow">else</span>                                 \
  <span class="keywordflow">if</span> ((!(da)) &amp;&amp; (db)) {                 \
    val = -1;                            \
  } <span class="keywordflow">else</span>                                 \
  <span class="keywordflow">if</span> ((da) &amp;&amp; (!(db))) {                 \
    val = 1;                             \
  }                                      \
  val; <span class="comment">/* block assumes value of last statment */</span>  \
})
</pre></div>Inline string comparision; compiler will optimize away most of this     </td>
  </tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="ga4" doxytag="qofid.h::QofEntityForeachCB" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> typedef void(* <a class="el" href="group__Entities.html#ga4">QofEntityForeachCB</a>)(QofEntity *, gpointer user_data)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Callback type for qof_entity_foreach     </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ga9" doxytag="qofid.h::qof_collection_destroy" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void qof_collection_destroy </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofCollection *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>col</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a class="anchor" name="ga12" doxytag="qofid.h::qof_collection_foreach" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void qof_collection_foreach </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofCollection *&nbsp;</td>
          <td class="mdname" nowrap>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="group__Entities.html#ga4">QofEntityForeachCB</a>&nbsp;</td>
          <td class="mdname" nowrap>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>gpointer&nbsp;</td>
          <td class="mdname" nowrap> <em>user_data</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Call the callback for each entity in the collection.     </td>
  </tr>
</table>
<a class="anchor" name="ga13" doxytag="qofid.h::qof_collection_get_data" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> gpointer qof_collection_get_data </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofCollection *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>col</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Store and retreive arbitrary object-defined data<p>
XXX We need to add a callback for when the collection is being destroyed, so that the user has a chance to clean up anything that was put in the 'data' member here.     </td>
  </tr>
</table>
<a class="anchor" name="ga10" doxytag="qofid.h::qof_collection_get_type" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> QofIdType qof_collection_get_type </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofCollection *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
return the type that the collection stores     </td>
  </tr>
</table>
<a class="anchor" name="ga15" doxytag="qofid.h::qof_collection_is_dirty" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> gboolean qof_collection_is_dirty </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofCollection *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>col</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return value of 'dirty' flag on collection     </td>
  </tr>
</table>
<a class="anchor" name="ga11" doxytag="qofid.h::qof_collection_lookup_entity" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> QofEntity* qof_collection_lookup_entity </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofCollection *&nbsp;</td>
          <td class="mdname" nowrap>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="union__GUID.html">GUID</a> *&nbsp;</td>
          <td class="mdname" nowrap></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Find the entity going only from its guid     </td>
  </tr>
</table>
<a class="anchor" name="ga7" doxytag="qofid.h::qof_entity_get_guid" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> const <a class="el" href="union__GUID.html">GUID</a>* qof_entity_get_guid </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofEntity *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the GUID of this entity     </td>
  </tr>
</table>
<a class="anchor" name="ga5" doxytag="qofid.h::qof_entity_init" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void qof_entity_init </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofEntity *&nbsp;</td>
          <td class="mdname" nowrap>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>QofIdType&nbsp;</td>
          <td class="mdname" nowrap>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>QofCollection *&nbsp;</td>
          <td class="mdname" nowrap></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialise the memory associated with an entity     </td>
  </tr>
</table>
<a class="anchor" name="ga6" doxytag="qofid.h::qof_entity_release" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void qof_entity_release </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">QofEntity *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Release the data associated with this entity. Dont actually free the memory associated with the instance.     </td>
  </tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun May 23 15:41:48 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>