← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libebackend/html/libebackend-e-file-cache.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libebackend/html/libebackend-e-file-cache.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>EFileCache</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
9
9
<link rel="prev" href="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
30
30
                  <a href="#libebackend-e-file-cache.properties" class="shortcut">Properties</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" lang="en">
 
33
<div class="refentry" title="EFileCache">
34
34
<a name="libebackend-e-file-cache"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
 
<div class="refsynopsisdiv">
 
42
<div class="refsynopsisdiv" title="Synopsis">
43
43
<a name="libebackend-e-file-cache.synopsis"></a><h2>Synopsis</h2>
44
44
<a name="EFileCache"></a><pre class="synopsis">                    <a class="link" href="libebackend-e-file-cache.html#EFileCachePrivate" title="EFileCachePrivate">EFileCachePrivate</a>;
45
45
                    <a class="link" href="libebackend-e-file-cache.html#EFileCache-struct" title="EFileCache">EFileCache</a>;
63
63
const <span class="returnvalue">gchar</span> *       <a class="link" href="libebackend-e-file-cache.html#e-file-cache-get-filename" title="e_file_cache_get_filename ()">e_file_cache_get_filename</a>           (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);
64
64
</pre>
65
65
</div>
66
 
<div class="refsect1" lang="en">
 
66
<div class="refsect1" title="Object Hierarchy">
67
67
<a name="libebackend-e-file-cache.object-hierarchy"></a><h2>Object Hierarchy</h2>
68
68
<pre class="synopsis">
69
69
  GObject
70
70
   +----EFileCache
71
71
</pre>
72
72
</div>
73
 
<div class="refsect1" lang="en">
 
73
<div class="refsect1" title="Properties">
74
74
<a name="libebackend-e-file-cache.properties"></a><h2>Properties</h2>
75
75
<pre class="synopsis">
76
76
  "<a class="link" href="libebackend-e-file-cache.html#EFileCache--filename" title='The "filename" property'>filename</a>"                 <span class="type">gchar</span>*                : Read / Write / Construct Only
77
77
</pre>
78
78
</div>
79
 
<div class="refsect1" lang="en">
 
79
<div class="refsect1" title="Description">
80
80
<a name="libebackend-e-file-cache.description"></a><h2>Description</h2>
81
81
<p>
82
82
</p>
83
83
</div>
84
 
<div class="refsect1" lang="en">
 
84
<div class="refsect1" title="Details">
85
85
<a name="libebackend-e-file-cache.details"></a><h2>Details</h2>
86
 
<div class="refsect2" lang="en">
 
86
<div class="refsect2" title="EFileCachePrivate">
87
87
<a name="EFileCachePrivate"></a><h3>EFileCachePrivate</h3>
88
88
<pre class="programlisting">typedef struct _EFileCachePrivate EFileCachePrivate;</pre>
89
89
<p>
90
90
</p>
91
91
</div>
92
92
<hr>
93
 
<div class="refsect2" lang="en">
 
93
<div class="refsect2" title="EFileCache">
94
94
<a name="EFileCache-struct"></a><h3>EFileCache</h3>
95
95
<pre class="programlisting">typedef struct _EFileCache EFileCache;</pre>
96
96
<p>
97
97
</p>
98
98
</div>
99
99
<hr>
100
 
<div class="refsect2" lang="en">
 
100
<div class="refsect2" title="e_file_cache_new ()">
101
101
<a name="e-file-cache-new"></a><h3>e_file_cache_new ()</h3>
102
102
<pre class="programlisting"><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="returnvalue">EFileCache</span></a> *        e_file_cache_new                    (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
103
103
<p>
104
104
Creates a new <a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> object, which implements a cache of
105
 
objects, very useful for remote backends.</p>
 
105
objects, very useful for remote backends.
 
106
</p>
106
107
<div class="variablelist"><table border="0">
107
108
<col align="left" valign="top">
108
109
<tbody>
120
121
</table></div>
121
122
</div>
122
123
<hr>
123
 
<div class="refsect2" lang="en">
 
124
<div class="refsect2" title="e_file_cache_remove ()">
124
125
<a name="e-file-cache-remove"></a><h3>e_file_cache_remove ()</h3>
125
126
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_file_cache_remove                 (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
126
127
<p>
127
 
Remove the cache from disk.</p>
 
128
Remove the cache from disk.
 
129
</p>
128
130
<div class="variablelist"><table border="0">
129
131
<col align="left" valign="top">
130
132
<tbody>
142
144
</table></div>
143
145
</div>
144
146
<hr>
145
 
<div class="refsect2" lang="en">
 
147
<div class="refsect2" title="e_file_cache_clean ()">
146
148
<a name="e-file-cache-clean"></a><h3>e_file_cache_clean ()</h3>
147
149
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_file_cache_clean                  (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
148
150
<p>
149
 
Clean up the cache's contents.</p>
 
151
Clean up the cache's contents.
 
152
</p>
150
153
<div class="variablelist"><table border="0">
151
154
<col align="left" valign="top">
152
155
<tbody>
164
167
</table></div>
165
168
</div>
166
169
<hr>
167
 
<div class="refsect2" lang="en">
 
170
<div class="refsect2" title="e_file_cache_get_object ()">
168
171
<a name="e-file-cache-get-object"></a><h3>e_file_cache_get_object ()</h3>
169
172
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_file_cache_get_object             (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
170
173
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
190
193
</table></div>
191
194
</div>
192
195
<hr>
193
 
<div class="refsect2" lang="en">
 
196
<div class="refsect2" title="e_file_cache_get_objects ()">
194
197
<a name="e-file-cache-get-objects"></a><h3>e_file_cache_get_objects ()</h3>
195
198
<pre class="programlisting"><span class="returnvalue">GSList</span> *            e_file_cache_get_objects            (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
196
199
<div class="variablelist"><table border="0">
210
213
</table></div>
211
214
</div>
212
215
<hr>
213
 
<div class="refsect2" lang="en">
 
216
<div class="refsect2" title="e_file_cache_get_keys ()">
214
217
<a name="e-file-cache-get-keys"></a><h3>e_file_cache_get_keys ()</h3>
215
218
<pre class="programlisting"><span class="returnvalue">GSList</span> *            e_file_cache_get_keys               (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
216
219
<div class="variablelist"><table border="0">
230
233
</table></div>
231
234
</div>
232
235
<hr>
233
 
<div class="refsect2" lang="en">
 
236
<div class="refsect2" title="e_file_cache_add_object ()">
234
237
<a name="e-file-cache-add-object"></a><h3>e_file_cache_add_object ()</h3>
235
238
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_file_cache_add_object             (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
236
239
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
262
265
</table></div>
263
266
</div>
264
267
<hr>
265
 
<div class="refsect2" lang="en">
 
268
<div class="refsect2" title="e_file_cache_replace_object ()">
266
269
<a name="e-file-cache-replace-object"></a><h3>e_file_cache_replace_object ()</h3>
267
270
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_file_cache_replace_object         (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
268
271
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
294
297
</table></div>
295
298
</div>
296
299
<hr>
297
 
<div class="refsect2" lang="en">
 
300
<div class="refsect2" title="e_file_cache_remove_object ()">
298
301
<a name="e-file-cache-remove-object"></a><h3>e_file_cache_remove_object ()</h3>
299
302
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_file_cache_remove_object          (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
300
303
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
320
323
</table></div>
321
324
</div>
322
325
<hr>
323
 
<div class="refsect2" lang="en">
 
326
<div class="refsect2" title="e_file_cache_freeze_changes ()">
324
327
<a name="e-file-cache-freeze-changes"></a><h3>e_file_cache_freeze_changes ()</h3>
325
328
<pre class="programlisting"><span class="returnvalue">void</span>                e_file_cache_freeze_changes         (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
326
329
<p>
327
 
Disables temporarily all writes to disk for the given cache object.</p>
 
330
Disables temporarily all writes to disk for the given cache object.
 
331
</p>
328
332
<div class="variablelist"><table border="0">
329
333
<col align="left" valign="top">
330
334
<tbody><tr>
335
339
</table></div>
336
340
</div>
337
341
<hr>
338
 
<div class="refsect2" lang="en">
 
342
<div class="refsect2" title="e_file_cache_thaw_changes ()">
339
343
<a name="e-file-cache-thaw-changes"></a><h3>e_file_cache_thaw_changes ()</h3>
340
344
<pre class="programlisting"><span class="returnvalue">void</span>                e_file_cache_thaw_changes           (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
341
345
<p>
342
 
Enables again writes to disk on every change.</p>
 
346
Enables again writes to disk on every change.
 
347
</p>
343
348
<div class="variablelist"><table border="0">
344
349
<col align="left" valign="top">
345
350
<tbody><tr>
350
355
</table></div>
351
356
</div>
352
357
<hr>
353
 
<div class="refsect2" lang="en">
 
358
<div class="refsect2" title="e_file_cache_get_filename ()">
354
359
<a name="e-file-cache-get-filename"></a><h3>e_file_cache_get_filename ()</h3>
355
360
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_file_cache_get_filename           (<em class="parameter"><code><a class="link" href="libebackend-e-file-cache.html#EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
356
361
<p>
357
 
Gets the name of the file where the cache is being stored.</p>
 
362
Gets the name of the file where the cache is being stored.
 
363
</p>
358
364
<div class="variablelist"><table border="0">
359
365
<col align="left" valign="top">
360
366
<tbody>
372
378
</table></div>
373
379
</div>
374
380
</div>
375
 
<div class="refsect1" lang="en">
 
381
<div class="refsect1" title="Property Details">
376
382
<a name="libebackend-e-file-cache.property-details"></a><h2>Property Details</h2>
377
 
<div class="refsect2" lang="en">
 
383
<div class="refsect2" title='The "filename" property'>
378
384
<a name="EFileCache--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
379
385
<pre class="programlisting">  "filename"                 <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
380
386
<p></p>