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
|
<!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: _QofBook 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>_QofBook Struct Reference<br>
<small>
[<a class="el" href="group__Object__Private.html">Object_Private</a>]</small>
</h1><code>#include <qofbook-p.h></code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Book structure
<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>QofEntity </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o0">entity</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__KVP.html#ga0">KvpFrame</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o1">kvp_data</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GHashTable * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o2">hash_of_collections</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GHashTable * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o3">data_tables</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o4">book_open</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gboolean </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o5">dirty</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gint32 </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o6">version</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__QofBackend.html">QofBackend</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o7">backend</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>guint32 </td><td class="memItemRight" valign=bottom><a class="el" href="struct__QofBook.html#o8">idata</a></td></tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="o7" doxytag="_QofBook::backend" ></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"> <a class="el" href="struct__QofBackend.html">QofBackend</a>* <a class="el" href="struct__QofBook.html#o7">_QofBook::backend</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
To be technically correct, backends belong to sessions and not books. So the pointer below "really shouldn't be here", except that it provides a nice convenience, avoiding a lookup from the session. Better solutions welcome ... </td>
</tr>
</table>
<a class="anchor" name="o4" doxytag="_QofBook::book_open" ></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"> char <a class="el" href="struct__QofBook.html#o4">_QofBook::book_open</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
state flag: 'y' means 'open for editing', 'n' means 'book is closed' </td>
</tr>
</table>
<a class="anchor" name="o3" doxytag="_QofBook::data_tables" ></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"> GHashTable* <a class="el" href="struct__QofBook.html#o3">_QofBook::data_tables</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
In order to store arbitrary data, for extensibility, add a table that will be used to hold arbitrary pointers. </td>
</tr>
</table>
<a class="anchor" name="o5" doxytag="_QofBook::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__QofBook.html#o5">_QofBook::dirty</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
dirty/clean flag. If dirty, then this book has been modified, but has not yet been written out to storage (file/database) </td>
</tr>
</table>
<a class="anchor" name="o0" doxytag="_QofBook::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 <a class="el" href="struct__QofBook.html#o0">_QofBook::entity</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Unique guid for this book. </td>
</tr>
</table>
<a class="anchor" name="o2" doxytag="_QofBook::hash_of_collections" ></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"> GHashTable* <a class="el" href="struct__QofBook.html#o2">_QofBook::hash_of_collections</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The entity table associates the GUIDs of all the objects belonging to this book, with their pointers to the respective objects. This allows a lookup of objects based on thier guid. </td>
</tr>
</table>
<a class="anchor" name="o8" doxytag="_QofBook::idata" ></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"> guint32 <a class="el" href="struct__QofBook.html#o8">_QofBook::idata</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
used by the sql backend for kvp management </td>
</tr>
</table>
<a class="anchor" name="o1" doxytag="_QofBook::kvp_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"> <a class="el" href="group__KVP.html#ga0">KvpFrame</a>* <a class="el" href="struct__QofBook.html#o1">_QofBook::kvp_data</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The KvpFrame provides a place for top-level data associated with this book. </td>
</tr>
</table>
<a class="anchor" name="o6" doxytag="_QofBook::version" ></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"> gint32 <a class="el" href="struct__QofBook.html#o6">_QofBook::version</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
version number, used for tracking multiuser updates </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>qofbook-p.h</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>
|
