/usr/share/doc/libqof-doc/html/struct__QofBook.html is in libqof-doc 0.8.7-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>QOF: _QofBook Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">QOF
 <span id="projectnumber">0.8.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">_QofBook Struct Reference<div class="ingroups"><a class="el" href="group__Object__Private.html">Object_Private</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aef949596b493a8f6b95d5508ae3a3632"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structQofInstance__s.html">QofInstance</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#aef949596b493a8f6b95d5508ae3a3632">inst</a></td></tr>
<tr class="separator:aef949596b493a8f6b95d5508ae3a3632"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29d216165ed1f9c6a5cd89e303011edc"><td class="memItemLeft" align="right" valign="top">GHashTable * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a29d216165ed1f9c6a5cd89e303011edc">hash_of_collections</a></td></tr>
<tr class="separator:a29d216165ed1f9c6a5cd89e303011edc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75470458c8bf65c8d3d71affc24fe55c"><td class="memItemLeft" align="right" valign="top">GHashTable * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a75470458c8bf65c8d3d71affc24fe55c">data_tables</a></td></tr>
<tr class="separator:a75470458c8bf65c8d3d71affc24fe55c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a82f856fcfcf67633ac364dad412bf9"><td class="memItemLeft" align="right" valign="top">GHashTable * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a7a82f856fcfcf67633ac364dad412bf9">data_table_finalizers</a></td></tr>
<tr class="separator:a7a82f856fcfcf67633ac364dad412bf9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2344ffe124e69ca845b73267f250fd9"><td class="memItemLeft" align="right" valign="top">gchar </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#ab2344ffe124e69ca845b73267f250fd9">book_open</a></td></tr>
<tr class="separator:ab2344ffe124e69ca845b73267f250fd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84fcc8468af148852872cca07d3a2055"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a84fcc8468af148852872cca07d3a2055">shutting_down</a></td></tr>
<tr class="separator:a84fcc8468af148852872cca07d3a2055"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87f5b9e2dcc2cb12fe2ce8d70ae227bb"><td class="memItemLeft" align="right" valign="top">gint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a87f5b9e2dcc2cb12fe2ce8d70ae227bb">version</a></td></tr>
<tr class="separator:a87f5b9e2dcc2cb12fe2ce8d70ae227bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f94fcabd22a290f2b93bef6fc5397c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Backend.html#ga17b6933f99a1ab390051fef85723059d">QofBackend</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a7f94fcabd22a290f2b93bef6fc5397c6">backend</a></td></tr>
<tr class="separator:a7f94fcabd22a290f2b93bef6fc5397c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75b4364efab668395bb9781e62209cfd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structQofUndo__s.html">QofUndo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a75b4364efab668395bb9781e62209cfd">undo_data</a></td></tr>
<tr class="separator:a75b4364efab668395bb9781e62209cfd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59f1ca7ee55cc5375588aa0ad4f08c71"><td class="memItemLeft" align="right" valign="top">guint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__QofBook.html#a59f1ca7ee55cc5375588aa0ad4f08c71">idata</a></td></tr>
<tr class="separator:a59f1ca7ee55cc5375588aa0ad4f08c71"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Book structure </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00048">48</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a7f94fcabd22a290f2b93bef6fc5397c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Backend.html#ga17b6933f99a1ab390051fef85723059d">QofBackend</a>* _QofBook::backend</td>
</tr>
</table>
</div><div class="memdoc">
<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 ... </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>allow book to lookup session and then backend. </dd></dl>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00087">87</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab2344ffe124e69ca845b73267f250fd9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gchar _QofBook::book_open</td>
</tr>
</table>
</div><div class="memdoc">
<p>state flag: 'y' means 'open for editing', 'n' means 'book is closed' </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>shouldn't this be replaced by the instance editlevel ? </dd></dl>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00070">70</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7a82f856fcfcf67633ac364dad412bf9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GHashTable* _QofBook::data_table_finalizers</td>
</tr>
</table>
</div><div class="memdoc">
<p>Hash table of destroy callbacks for the data table. </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00064">64</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="a75470458c8bf65c8d3d71affc24fe55c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GHashTable* _QofBook::data_tables</td>
</tr>
</table>
</div><div class="memdoc">
<p>In order to store arbitrary data, for extensibility, add a table that will be used to hold arbitrary pointers. </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00061">61</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="a29d216165ed1f9c6a5cd89e303011edc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GHashTable* _QofBook::hash_of_collections</td>
</tr>
</table>
</div><div class="memdoc">
<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 their guid. </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00057">57</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="a59f1ca7ee55cc5375588aa0ad4f08c71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint32 _QofBook::idata</td>
</tr>
</table>
</div><div class="memdoc">
<p>Backend private expansion data used by the sql backend for kvp management </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00094">94</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="aef949596b493a8f6b95d5508ae3a3632"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structQofInstance__s.html">QofInstance</a> _QofBook::inst</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique guid for this book. </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00051">51</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="a84fcc8468af148852872cca07d3a2055"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean _QofBook::shutting_down</td>
</tr>
</table>
</div><div class="memdoc">
<p>a flag denoting whether the book is closing down, used to help the QOF objects shut down cleanly without maintaining internal consistency. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>shouldn't shutting_down be replaced by instance->do_free? </dd></dl>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00077">77</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="a75b4364efab668395bb9781e62209cfd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structQofUndo__s.html">QofUndo</a>* _QofBook::undo_data</td>
</tr>
</table>
</div><div class="memdoc">
<p>Undo support object </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00090">90</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<a class="anchor" id="a87f5b9e2dcc2cb12fe2ce8d70ae227bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gint32 _QofBook::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>version number, used for tracking multiuser updates </p>
<p>Definition at line <a class="el" href="qofbook-p_8h_source.html#l00080">80</a> of file <a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="qofbook-p_8h_source.html">qofbook-p.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 5 2014 01:35:07 for QOF by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|