← 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/camel/html/camel-CamelDataWrapper.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/camel/html/camel-CamelDataWrapper.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelDataWrapper</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="Camel Reference Manual">
8
8
<link rel="up" href="MIME.html" title="MIME Objects">
9
9
<link rel="prev" href="MIME.html" title="MIME Objects">
26
26
                  <a href="#camel-CamelDataWrapper.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelDataWrapper">
30
30
<a name="camel-CamelDataWrapper"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelDataWrapper.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">struct              <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper">CamelDataWrapper</a>;
41
41
<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="returnvalue">CamelDataWrapper</span></a> *  <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-new" title="camel_data_wrapper_new ()">camel_data_wrapper_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
57
57
<span class="returnvalue">gboolean</span>            <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-is-offline" title="camel_data_wrapper_is_offline ()">camel_data_wrapper_is_offline</a>       (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>);
58
58
</pre>
59
59
</div>
60
 
<div class="refsect1" lang="en">
 
60
<div class="refsect1" title="Description">
61
61
<a name="camel-CamelDataWrapper.description"></a><h2>Description</h2>
62
62
<p>
63
63
</p>
64
64
</div>
65
 
<div class="refsect1" lang="en">
 
65
<div class="refsect1" title="Details">
66
66
<a name="camel-CamelDataWrapper.details"></a><h2>Details</h2>
67
 
<div class="refsect2" lang="en">
 
67
<div class="refsect2" title="struct CamelDataWrapper">
68
68
<a name="CamelDataWrapper"></a><h3>struct CamelDataWrapper</h3>
69
69
<pre class="programlisting">struct CamelDataWrapper {
70
70
        CamelObject parent_object;
82
82
</p>
83
83
</div>
84
84
<hr>
85
 
<div class="refsect2" lang="en">
 
85
<div class="refsect2" title="camel_data_wrapper_new ()">
86
86
<a name="camel-data-wrapper-new"></a><h3>camel_data_wrapper_new ()</h3>
87
87
<pre class="programlisting"><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="returnvalue">CamelDataWrapper</span></a> *  camel_data_wrapper_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
88
88
<p>
89
 
Create a new <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object.</p>
 
89
Create a new <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object.
 
90
</p>
90
91
<div class="variablelist"><table border="0">
91
92
<col align="left" valign="top">
92
93
<tbody><tr>
97
98
</table></div>
98
99
</div>
99
100
<hr>
100
 
<div class="refsect2" lang="en">
 
101
<div class="refsect2" title="camel_data_wrapper_write_to_stream ()">
101
102
<a name="camel-data-wrapper-write-to-stream"></a><h3>camel_data_wrapper_write_to_stream ()</h3>
102
103
<pre class="programlisting"><span class="returnvalue">gssize</span>              camel_data_wrapper_write_to_stream  (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>,
103
104
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>);</pre>
105
106
Writes the content of <em class="parameter"><code>data_wrapper</code></em> to <em class="parameter"><code>stream</code></em> in a machine-independent
106
107
format appropriate for the data. It should be possible to construct an
107
108
equivalent data wrapper object later by passing this stream to
108
 
<a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-construct-from-stream" title="camel_data_wrapper_construct_from_stream ()"><span class="type">camel_data_wrapper_construct_from_stream</span></a>.</p>
 
109
<a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-construct-from-stream" title="camel_data_wrapper_construct_from_stream ()"><span class="type">camel_data_wrapper_construct_from_stream</span></a>.
 
110
</p>
109
111
<div class="variablelist"><table border="0">
110
112
<col align="left" valign="top">
111
113
<tbody>
128
130
</table></div>
129
131
</div>
130
132
<hr>
131
 
<div class="refsect2" lang="en">
 
133
<div class="refsect2" title="camel_data_wrapper_decode_to_stream ()">
132
134
<a name="camel-data-wrapper-decode-to-stream"></a><h3>camel_data_wrapper_decode_to_stream ()</h3>
133
135
<pre class="programlisting"><span class="returnvalue">gssize</span>              camel_data_wrapper_decode_to_stream (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>,
134
136
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>);</pre>
135
137
<p>
136
 
Writes the decoded data content to <em class="parameter"><code>stream</code></em>.</p>
 
138
Writes the decoded data content to <em class="parameter"><code>stream</code></em>.
 
139
</p>
137
140
<div class="variablelist"><table border="0">
138
141
<col align="left" valign="top">
139
142
<tbody>
156
159
</table></div>
157
160
</div>
158
161
<hr>
159
 
<div class="refsect2" lang="en">
 
162
<div class="refsect2" title="camel_data_wrapper_set_mime_type ()">
160
163
<a name="camel-data-wrapper-set-mime-type"></a><h3>camel_data_wrapper_set_mime_type ()</h3>
161
164
<pre class="programlisting"><span class="returnvalue">void</span>                camel_data_wrapper_set_mime_type    (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>,
162
165
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *mime_type</code></em>);</pre>
168
171
Content-Type parameters on the data wrapper, which are meaningless.
169
172
You should not be allowed to change the MIME type of a data wrapper
170
173
that contains data, or at least, if you do, it should invalidate the
171
 
data.</p>
 
174
data.
 
175
</p>
172
176
<div class="variablelist"><table border="0">
173
177
<col align="left" valign="top">
174
178
<tbody>
186
190
</table></div>
187
191
</div>
188
192
<hr>
189
 
<div class="refsect2" lang="en">
 
193
<div class="refsect2" title="camel_data_wrapper_get_mime_type ()">
190
194
<a name="camel-data-wrapper-get-mime-type"></a><h3>camel_data_wrapper_get_mime_type ()</h3>
191
195
<pre class="programlisting"><span class="returnvalue">gchar</span> *             camel_data_wrapper_get_mime_type    (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>);</pre>
192
196
<div class="variablelist"><table border="0">
206
210
</table></div>
207
211
</div>
208
212
<hr>
209
 
<div class="refsect2" lang="en">
 
213
<div class="refsect2" title="camel_data_wrapper_get_mime_type_field ()">
210
214
<a name="camel-data-wrapper-get-mime-type-field"></a><h3>camel_data_wrapper_get_mime_type_field ()</h3>
211
215
<pre class="programlisting"><a class="link" href="camel-camel-mime-utils.html#CamelContentType" title="CamelContentType"><span class="returnvalue">CamelContentType</span></a> *  camel_data_wrapper_get_mime_type_field
212
216
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>);</pre>
227
231
</table></div>
228
232
</div>
229
233
<hr>
230
 
<div class="refsect2" lang="en">
 
234
<div class="refsect2" title="camel_data_wrapper_set_mime_type_field ()">
231
235
<a name="camel-data-wrapper-set-mime-type-field"></a><h3>camel_data_wrapper_set_mime_type_field ()</h3>
232
236
<pre class="programlisting"><span class="returnvalue">void</span>                camel_data_wrapper_set_mime_type_field
233
237
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>,
234
238
                                                         <em class="parameter"><code><a class="link" href="camel-camel-mime-utils.html#CamelContentType" title="CamelContentType"><span class="type">CamelContentType</span></a> *mime_type</code></em>);</pre>
235
239
<p>
236
240
This sets the data wrapper's MIME type. It suffers from the same
237
 
flaws as <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type" title="camel_data_wrapper_set_mime_type ()"><span class="type">camel_data_wrapper_set_mime_type</span></a>.</p>
 
241
flaws as <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type" title="camel_data_wrapper_set_mime_type ()"><span class="type">camel_data_wrapper_set_mime_type</span></a>.
 
242
</p>
238
243
<div class="variablelist"><table border="0">
239
244
<col align="left" valign="top">
240
245
<tbody>
252
257
</table></div>
253
258
</div>
254
259
<hr>
255
 
<div class="refsect2" lang="en">
 
260
<div class="refsect2" title="camel_data_wrapper_construct_from_stream ()">
256
261
<a name="camel-data-wrapper-construct-from-stream"></a><h3>camel_data_wrapper_construct_from_stream ()</h3>
257
262
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_data_wrapper_construct_from_stream
258
263
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>,
259
264
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>);</pre>
260
265
<p>
261
 
Constructs the content of <em class="parameter"><code>data_wrapper</code></em> from the supplied <em class="parameter"><code>stream</code></em>.</p>
 
266
Constructs the content of <em class="parameter"><code>data_wrapper</code></em> from the supplied <em class="parameter"><code>stream</code></em>.
 
267
</p>
262
268
<div class="variablelist"><table border="0">
263
269
<col align="left" valign="top">
264
270
<tbody>
281
287
</table></div>
282
288
</div>
283
289
<hr>
284
 
<div class="refsect2" lang="en">
 
290
<div class="refsect2" title="camel_data_wrapper_is_offline ()">
285
291
<a name="camel-data-wrapper-is-offline"></a><h3>camel_data_wrapper_is_offline ()</h3>
286
292
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_data_wrapper_is_offline       (<em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *data_wrapper</code></em>);</pre>
287
293
<div class="variablelist"><table border="0">