← 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/xml/e-file-cache.xml

  • 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/xml/e-file-cache.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libebackend-e-file-cache">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libebackend-e-file-cache.top_of_page">EFileCache</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEBACKEND Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EFileCache</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libebackend-e-file-cache.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
<anchor id="EFileCache"/>
20
 
<synopsis>                    <link linkend="EFileCachePrivate">EFileCachePrivate</link>;
21
 
                    <link linkend="EFileCache-struct">EFileCache</link>;
22
 
<link linkend="EFileCache"><returnvalue>EFileCache</returnvalue></link> *        <link linkend="e-file-cache-new">e_file_cache_new</link>                    (<parameter>const <link linkend="gchar"><type>gchar</type></link> *filename</parameter>);
23
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-remove">e_file_cache_remove</link>                 (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
24
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-clean">e_file_cache_clean</link>                  (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
25
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-file-cache-get-object">e_file_cache_get_object</link>             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
26
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
27
 
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-file-cache-get-objects">e_file_cache_get_objects</link>            (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
28
 
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-file-cache-get-keys">e_file_cache_get_keys</link>               (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
29
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-add-object">e_file_cache_add_object</link>             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
30
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
31
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
32
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-replace-object">e_file_cache_replace_object</link>         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
33
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
34
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *new_value</parameter>);
35
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-remove-object">e_file_cache_remove_object</link>          (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
36
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
37
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-file-cache-freeze-changes">e_file_cache_freeze_changes</link>         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
38
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-file-cache-thaw-changes">e_file_cache_thaw_changes</link>           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
39
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-file-cache-get-filename">e_file_cache_get_filename</link>           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
40
 
</synopsis>
41
 
</refsynopsisdiv>
42
 
<refsect1 id="libebackend-e-file-cache.object-hierarchy" role="object_hierarchy">
43
 
<title role="object_hierarchy.title">Object Hierarchy</title>
44
 
<synopsis>
45
 
  <link linkend="GObject">GObject</link>
46
 
   +----EFileCache
47
 
</synopsis>
48
 
</refsect1>
49
 
<refsect1 id="libebackend-e-file-cache.properties" role="properties">
50
 
<title role="properties.title">Properties</title>
51
 
<synopsis>
52
 
  &quot;<link linkend="EFileCache--filename">filename</link>&quot;                 <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only
53
 
</synopsis>
54
 
</refsect1>
55
 
 
56
 
<refsect1 id="libebackend-e-file-cache.description" role="desc">
57
 
<title role="desc.title">Description</title>
58
 
<para>
59
 
</para>
60
 
</refsect1>
61
 
<refsect1 id="libebackend-e-file-cache.details" role="details">
62
 
<title role="details.title">Details</title>
63
 
<refsect2 id="EFileCachePrivate" role="struct">
64
 
<title>EFileCachePrivate</title>
65
 
<indexterm zone="EFileCachePrivate"><primary>EFileCachePrivate</primary></indexterm>
66
 
<programlisting>typedef struct _EFileCachePrivate EFileCachePrivate;</programlisting>
67
 
<para>
68
 
</para></refsect2>
69
 
<refsect2 id="EFileCache-struct" role="struct">
70
 
<title>EFileCache</title>
71
 
<indexterm zone="EFileCache-struct"><primary>EFileCache</primary></indexterm>
72
 
<programlisting>typedef struct _EFileCache EFileCache;</programlisting>
73
 
<para>
74
 
</para></refsect2>
75
 
<refsect2 id="e-file-cache-new" role="function">
76
 
<title>e_file_cache_new ()</title>
77
 
<indexterm zone="e-file-cache-new"><primary>e_file_cache_new</primary></indexterm>
78
 
<programlisting><link linkend="EFileCache"><returnvalue>EFileCache</returnvalue></link> *        e_file_cache_new                    (<parameter>const <link linkend="gchar"><type>gchar</type></link> *filename</parameter>);</programlisting>
79
 
<para>
80
 
Creates a new <link linkend="EFileCache"><type>EFileCache</type></link> object, which implements a cache of
81
 
objects, very useful for remote backends.</para>
82
 
<variablelist role="params">
83
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
84
 
<listitem><simpara>filename where the cache is kept.
85
 
</simpara></listitem></varlistentry>
86
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly created object.
87
 
</simpara></listitem></varlistentry>
88
 
</variablelist></refsect2>
89
 
<refsect2 id="e-file-cache-remove" role="function">
90
 
<title>e_file_cache_remove ()</title>
91
 
<indexterm zone="e-file-cache-remove"><primary>e_file_cache_remove</primary></indexterm>
92
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_remove                 (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
93
 
<para>
94
 
Remove the cache from disk.</para>
95
 
<variablelist role="params">
96
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
97
 
<listitem><simpara>A <link linkend="EFileCache"><type>EFileCache</type></link> object.
98
 
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if successful, FALSE otherwise.
100
 
</simpara></listitem></varlistentry>
101
 
</variablelist></refsect2>
102
 
<refsect2 id="e-file-cache-clean" role="function">
103
 
<title>e_file_cache_clean ()</title>
104
 
<indexterm zone="e-file-cache-clean"><primary>e_file_cache_clean</primary></indexterm>
105
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_clean                  (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
106
 
<para>
107
 
Clean up the cache's contents.</para>
108
 
<variablelist role="params">
109
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
110
 
<listitem><simpara>A <link linkend="EFileCache"><type>EFileCache</type></link> object.
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if successful, FALSE otherwise.
113
 
</simpara></listitem></varlistentry>
114
 
</variablelist></refsect2>
115
 
<refsect2 id="e-file-cache-get-object" role="function">
116
 
<title>e_file_cache_get_object ()</title>
117
 
<indexterm zone="e-file-cache-get-object"><primary>e_file_cache_get_object</primary></indexterm>
118
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_file_cache_get_object             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
119
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
120
 
<variablelist role="params">
121
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
122
 
<listitem><simpara>
123
 
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
125
 
<listitem><simpara>
126
 
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
128
 
</simpara></listitem></varlistentry>
129
 
</variablelist></refsect2>
130
 
<refsect2 id="e-file-cache-get-objects" role="function">
131
 
<title>e_file_cache_get_objects ()</title>
132
 
<indexterm zone="e-file-cache-get-objects"><primary>e_file_cache_get_objects</primary></indexterm>
133
 
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_file_cache_get_objects            (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
134
 
<variablelist role="params">
135
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
136
 
<listitem><simpara>
137
 
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
139
 
</simpara></listitem></varlistentry>
140
 
</variablelist></refsect2>
141
 
<refsect2 id="e-file-cache-get-keys" role="function">
142
 
<title>e_file_cache_get_keys ()</title>
143
 
<indexterm zone="e-file-cache-get-keys"><primary>e_file_cache_get_keys</primary></indexterm>
144
 
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_file_cache_get_keys               (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
145
 
<variablelist role="params">
146
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
147
 
<listitem><simpara>
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
150
 
</simpara></listitem></varlistentry>
151
 
</variablelist></refsect2>
152
 
<refsect2 id="e-file-cache-add-object" role="function">
153
 
<title>e_file_cache_add_object ()</title>
154
 
<indexterm zone="e-file-cache-add-object"><primary>e_file_cache_add_object</primary></indexterm>
155
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_add_object             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
156
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
157
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
158
 
<variablelist role="params">
159
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
160
 
<listitem><simpara>
161
 
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
163
 
<listitem><simpara>
164
 
</simpara></listitem></varlistentry>
165
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
166
 
<listitem><simpara>
167
 
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
169
 
</simpara></listitem></varlistentry>
170
 
</variablelist></refsect2>
171
 
<refsect2 id="e-file-cache-replace-object" role="function">
172
 
<title>e_file_cache_replace_object ()</title>
173
 
<indexterm zone="e-file-cache-replace-object"><primary>e_file_cache_replace_object</primary></indexterm>
174
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_replace_object         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
175
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
176
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *new_value</parameter>);</programlisting>
177
 
<variablelist role="params">
178
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
179
 
<listitem><simpara>
180
 
</simpara></listitem></varlistentry>
181
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
182
 
<listitem><simpara>
183
 
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><parameter>new_value</parameter>&#160;:</term>
185
 
<listitem><simpara>
186
 
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
188
 
</simpara></listitem></varlistentry>
189
 
</variablelist></refsect2>
190
 
<refsect2 id="e-file-cache-remove-object" role="function">
191
 
<title>e_file_cache_remove_object ()</title>
192
 
<indexterm zone="e-file-cache-remove-object"><primary>e_file_cache_remove_object</primary></indexterm>
193
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_remove_object          (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
194
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
195
 
<variablelist role="params">
196
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
197
 
<listitem><simpara>
198
 
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
200
 
<listitem><simpara>
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
203
 
</simpara></listitem></varlistentry>
204
 
</variablelist></refsect2>
205
 
<refsect2 id="e-file-cache-freeze-changes" role="function">
206
 
<title>e_file_cache_freeze_changes ()</title>
207
 
<indexterm zone="e-file-cache-freeze-changes"><primary>e_file_cache_freeze_changes</primary></indexterm>
208
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_file_cache_freeze_changes         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
209
 
<para>
210
 
Disables temporarily all writes to disk for the given cache object.</para>
211
 
<variablelist role="params">
212
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
213
 
<listitem><simpara>An <link linkend="EFileCache"><type>EFileCache</type></link> object.
214
 
</simpara></listitem></varlistentry>
215
 
</variablelist></refsect2>
216
 
<refsect2 id="e-file-cache-thaw-changes" role="function">
217
 
<title>e_file_cache_thaw_changes ()</title>
218
 
<indexterm zone="e-file-cache-thaw-changes"><primary>e_file_cache_thaw_changes</primary></indexterm>
219
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_file_cache_thaw_changes           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
220
 
<para>
221
 
Enables again writes to disk on every change.</para>
222
 
<variablelist role="params">
223
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
224
 
<listitem><simpara>An <link linkend="EFileCache"><type>EFileCache</type></link> object.
225
 
</simpara></listitem></varlistentry>
226
 
</variablelist></refsect2>
227
 
<refsect2 id="e-file-cache-get-filename" role="function">
228
 
<title>e_file_cache_get_filename ()</title>
229
 
<indexterm zone="e-file-cache-get-filename"><primary>e_file_cache_get_filename</primary></indexterm>
230
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_file_cache_get_filename           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
231
 
<para>
232
 
Gets the name of the file where the cache is being stored.</para>
233
 
<variablelist role="params">
234
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
235
 
<listitem><simpara>A <link linkend="EFileCache"><literal>EFileCache</literal></link> object.
236
 
</simpara></listitem></varlistentry>
237
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The name of the cache.
238
 
</simpara></listitem></varlistentry>
239
 
</variablelist></refsect2>
240
 
 
241
 
</refsect1>
242
 
<refsect1 id="libebackend-e-file-cache.property-details" role="property_details">
243
 
<title role="property_details.title">Property Details</title>
244
 
<refsect2 id="EFileCache--filename" role="property"><title>The <literal>&quot;filename&quot;</literal> property</title>
245
 
<indexterm zone="EFileCache--filename"><primary>EFileCache:filename</primary></indexterm>
246
 
<programlisting>  &quot;filename&quot;                 <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only</programlisting>
247
 
<para></para><para>Default value: ""</para>
248
 
</refsect2>
249
 
</refsect1>
250
 
 
251
 
</refentry>