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
|
<!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: _QofObject struct 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>_QofObject Struct Reference<br>
<small>
[<a class="el" href="group__Objects.html">Objects</a>]</small>
</h1><code>#include <qofobject.h></code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is the QofObject Class descriptor
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o0" doxytag="_QofObject::interface_version" ></a>
gint </td><td class="memItemRight" valign=bottom><b>interface_version</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o1" doxytag="_QofObject::e_type" ></a>
QofIdType </td><td class="memItemRight" valign=bottom><b>e_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o2" doxytag="_QofObject::type_label" ></a>
const char * </td><td class="memItemRight" valign=bottom><b>type_label</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gpointer(* </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofObject.html#o3">new</a> )(<a class="el" href="struct__QofBook.html">QofBook</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void(* </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofObject.html#o4">book_begin</a> )(<a class="el" href="struct__QofBook.html">QofBook</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void(* </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofObject.html#o5">book_end</a> )(<a class="el" href="struct__QofBook.html">QofBook</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gboolean(* </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofObject.html#o6">is_dirty</a> )(QofCollection *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void(* </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofObject.html#o7">mark_clean</a> )(QofCollection *)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void(* </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofObject.html#o8">foreach</a> )(QofCollection *, <a class="el" href="group__Entities.html#ga4">QofEntityForeachCB</a>, gpointer)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const char *(* </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofObject.html#o9">printable</a> )(gpointer instance)</td></tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="o4" doxytag="_QofObject::book_begin" ></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(* <a class="el" href="struct__QofObject.html#o4">_QofObject::book_begin</a>)(<a class="el" href="struct__QofBook.html">QofBook</a> *)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
book_begin is called from within the Book routines to create module-specific hooks in a book whenever a book is created. </td>
</tr>
</table>
<a class="anchor" name="o5" doxytag="_QofObject::book_end" ></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(* <a class="el" href="struct__QofObject.html#o5">_QofObject::book_end</a>)(<a class="el" href="struct__QofBook.html">QofBook</a> *)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
book_end is called when the book is being closed, to clean up (and free memory). </td>
</tr>
</table>
<a class="anchor" name="o8" doxytag="_QofObject::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(* <a class="el" href="struct__QofObject.html#o8">_QofObject::foreach</a>)(QofCollection *, <a class="el" href="group__Entities.html#ga4">QofEntityForeachCB</a>, gpointer)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="struct__QofObject.html#o8">foreach()</a> is used to execute a callback over each object stored in the particular book </td>
</tr>
</table>
<a class="anchor" name="o6" doxytag="_QofObject::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(* <a class="el" href="struct__QofObject.html#o6">_QofObject::is_dirty</a>)(QofCollection *)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determine if there are any dirty items in this book </td>
</tr>
</table>
<a class="anchor" name="o7" doxytag="_QofObject::mark_clean" ></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(* <a class="el" href="struct__QofObject.html#o7">_QofObject::mark_clean</a>)(QofCollection *)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Mark this object's book clean (for after a load) </td>
</tr>
</table>
<a class="anchor" name="o3" doxytag="_QofObject::new" ></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(* <a class="el" href="struct__QofObject.html#o3">_QofObject::new</a>)(<a class="el" href="struct__QofBook.html">QofBook</a> *)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a new instance of this object type. </td>
</tr>
</table>
<a class="anchor" name="o9" doxytag="_QofObject::printable" ></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 char*(* <a class="el" href="struct__QofObject.html#o9">_QofObject::printable</a>)(gpointer instance)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Given a particular instance of this type, return a printable string. Argument should really be QofInstance not gpointer.. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="qofobject_8h.html">qofobject.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun May 23 15:41:47 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>
|
