/usr/share/gtk-doc/html/dee-1.0/DeeTransaction.html is in libdee-doc 1.0.10-3.1.
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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dee Reference Manual: DeeTransaction</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch02.html" title="Models">
<link rel="prev" href="DeeSharedModel.html" title="DeeSharedModel">
<link rel="next" href="ch03.html" title="Indexes">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#DeeTransaction.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#DeeTransaction.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#DeeTransaction.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#DeeTransaction.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DeeSharedModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DeeTransaction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DeeTransaction.top_of_page"></a>DeeTransaction</span></h2>
<p>DeeTransaction — A self contained change set for a <span class="type">DeeModel</span></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DeeTransaction.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="DeeTransaction.html#dee-transaction-commit" title="dee_transaction_commit ()">dee_transaction_commit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GQuark</span>
</td>
<td class="function_name">
<a class="link" href="DeeTransaction.html#dee-transaction-error-quark" title="dee_transaction_error_quark ()">dee_transaction_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DeeModel</span> *
</td>
<td class="function_name">
<a class="link" href="DeeTransaction.html#dee-transaction-get-target" title="dee_transaction_get_target ()">dee_transaction_get_target</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="DeeTransaction.html#dee-transaction-is-committed" title="dee_transaction_is_committed ()">dee_transaction_is_committed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DeeModel</span> *
</td>
<td class="function_name">
<a class="link" href="DeeTransaction.html#dee-transaction-new" title="dee_transaction_new ()">dee_transaction_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeTransaction.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">DeeModel</span> *</td>
<td class="property_name"><a class="link" href="DeeTransaction.html#DeeTransaction--target" title="The “target” property">target</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeTransaction.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="DeeTransaction.html#DEE-TRANSACTION-ERROR:CAPS" title="DEE_TRANSACTION_ERROR">DEE_TRANSACTION_ERROR</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeTransaction.html#DeeTransaction-struct" title="struct DeeTransaction">DeeTransaction</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeTransaction.html#DeeTransactionClass" title="struct DeeTransactionClass">DeeTransactionClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="DeeTransaction.html#DeeTransactionError" title="enum DeeTransactionError">DeeTransactionError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeTransaction.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="DeeSerializableModel.html" title="DeeSerializableModel">DeeSerializableModel</a>
<span class="lineart">╰──</span> DeeTransaction
</pre>
</div>
<div class="refsect1">
<a name="DeeTransaction.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
DeeTransaction implements
DeeModel and DeeSerializable.</p>
</div>
<div class="refsect1">
<a name="DeeTransaction.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <dee.h>
</pre>
</div>
<div class="refsect1">
<a name="DeeTransaction.description"></a><h2>Description</h2>
<p><a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a> is a self contained change set related to some particular
<span class="type">DeeModel</span> called the <span class="emphasis"><em>target model</em></span>.</p>
<p>The transaction instance itself implements the <span class="type">DeeModel</span> interface in a way
that overlays the target model. In database terms the target model has
isolation level READ_COMMITTED. Meaning that the target model is not modified
until you call <a class="link" href="DeeTransaction.html#dee-transaction-commit" title="dee_transaction_commit ()"><code class="function">dee_transaction_commit()</code></a>.</p>
<p>To flush the changes to the target model call <a class="link" href="DeeTransaction.html#dee-transaction-commit" title="dee_transaction_commit ()"><code class="function">dee_transaction_commit()</code></a>.
After committing the transaction will become invalid and must be freed with
<code class="function">g_object_unref()</code>. It is a programming error to try and access a transaction
that has been committed with the sole exception of calling
<a class="link" href="DeeTransaction.html#dee-transaction-is-committed" title="dee_transaction_is_committed ()"><code class="function">dee_transaction_is_committed()</code></a>.</p>
</div>
<div class="refsect1">
<a name="DeeTransaction.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dee-transaction-commit"></a><h3>dee_transaction_commit ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dee_transaction_commit (<em class="parameter"><code><a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Apply a transaction to its target model. After this call the transaction
is invalidated and must be freed with <code class="function">g_object_unref()</code>.</p>
<div class="refsect3">
<a name="id-1.3.9.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The transaction to commit</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> Location to return a <span class="type">GError</span> in or <code class="literal">NULL</code> to disregard
errors. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.9.10.2.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if and only if the transaction successfully applies to :target.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-transaction-error-quark"></a><h3>dee_transaction_error_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span>
dee_transaction_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.3.9.10.3.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-transaction-get-target"></a><h3>dee_transaction_get_target ()</h3>
<pre class="programlisting"><span class="returnvalue">DeeModel</span> *
dee_transaction_get_target (<em class="parameter"><code><a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a> *self</code></em>);</pre>
<p>Get the target model of a transaction. This is just a convenience method
for accessing the :target property.</p>
<div class="refsect3">
<a name="id-1.3.9.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The transaction to retrieve the target model for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.9.10.4.6"></a><h4>Returns</h4>
<p> The target model. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-transaction-is-committed"></a><h3>dee_transaction_is_committed ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dee_transaction_is_committed (<em class="parameter"><code><a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a> *self</code></em>);</pre>
<p>Check if a <a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a> has been committed. This method is mainly for
debugging and testing purposes.</p>
<div class="refsect3">
<a name="id-1.3.9.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The transaction to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.9.10.5.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if and only if <a class="link" href="DeeTransaction.html#dee-transaction-commit" title="dee_transaction_commit ()"><code class="function">dee_transaction_commit()</code></a> has completed
successfully on the transaction.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-transaction-new"></a><h3>dee_transaction_new ()</h3>
<pre class="programlisting"><span class="returnvalue">DeeModel</span> *
dee_transaction_new (<em class="parameter"><code><span class="type">DeeModel</span> *target</code></em>);</pre>
<div class="refsect3">
<a name="id-1.3.9.10.6.4"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>The <span class="type">DeeModel</span> the transaction applies against</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.9.10.6.5"></a><h4>Returns</h4>
<p> A newly allocated <a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a>. Free with <code class="function">g_object_unref()</code> when
done using it - no matter if you call <a class="link" href="DeeTransaction.html#dee-transaction-commit" title="dee_transaction_commit ()"><code class="function">dee_transaction_commit()</code></a> or not. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Dee.Transaction]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeTransaction.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DEE-TRANSACTION-ERROR:CAPS"></a><h3>DEE_TRANSACTION_ERROR</h3>
<pre class="programlisting">#define DEE_TRANSACTION_ERROR dee_transaction_error_quark()
</pre>
<p>Error domain for the <a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a>. Error codes will be from the
<a class="link" href="DeeTransaction.html#DeeTransactionError" title="enum DeeTransactionError"><span class="type">DeeTransactionError</span></a> enumeration</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeTransaction-struct"></a><h3>struct DeeTransaction</h3>
<pre class="programlisting">struct DeeTransaction;</pre>
<p>All fields in the DeeTransaction structure are private and should never be
accessed directly</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeTransactionClass"></a><h3>struct DeeTransactionClass</h3>
<pre class="programlisting">struct DeeTransactionClass {
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeTransactionError"></a><h3>enum DeeTransactionError</h3>
<p>Error codes for the <a class="link" href="DeeTransaction.html" title="DeeTransaction"><span class="type">DeeTransaction</span></a> class. These codes will be set when the
error domain is <a class="link" href="DeeTransaction.html#DEE-TRANSACTION-ERROR:CAPS" title="DEE_TRANSACTION_ERROR"><span class="type">DEE_TRANSACTION_ERROR</span></a>.</p>
<p><em class="parameter"><code>DEE_TRANSACTION_ERROR_CONCURRENT_MODIFICATION</code></em>
: The target model has been
modified while the transaction was open.</p>
<p><em class="parameter"><code>DEE_TRANSACTION_ERROR_COMMITTED</code></em>
: Raised when someone tries to commit a
transaction that has already been committed</p>
<div class="refsect3">
<a name="id-1.3.9.11.5.6"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="DEE-TRANSACTION-ERROR-CONCURRENT-MODIFICATION:CAPS"></a>DEE_TRANSACTION_ERROR_CONCURRENT_MODIFICATION</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DEE-TRANSACTION-ERROR-COMMITTED:CAPS"></a>DEE_TRANSACTION_ERROR_COMMITTED</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeTransaction.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="DeeTransaction--target"></a><h3>The <code class="literal">“target”</code> property</h3>
<pre class="programlisting"> “target” <span class="type">DeeModel</span> *</pre>
<p>Target model.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|