4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelMimeFilterToHTML</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="StreamFilters.html" title="Stream Filters">
9
9
<link rel="prev" href="camel-CamelMimeFilterSave.html" title="CamelMimeFilterSave">
10
10
<link rel="next" href="camel-CamelMimeFilterWindows.html" title="CamelMimeFilterWindows">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="classes.html" title="Part I. Camel Classes">
14
<link rel="chapter" href="ClassTree.html" title="Class Hierarchy">
15
<link rel="chapter" href="Fundamentals.html" title="Fundamentals">
16
<link rel="chapter" href="Streams.html" title="Streams">
17
<link rel="chapter" href="StreamFilters.html" title="Stream Filters">
18
<link rel="chapter" href="Services.html" title="Services">
19
<link rel="chapter" href="Filters.html" title="Filters">
20
<link rel="chapter" href="Folders.html" title="Folders">
21
<link rel="chapter" href="SearchFolders.html" title="Search Folders">
22
<link rel="chapter" href="Addresses.html" title="Addresses">
23
<link rel="chapter" href="Crypto.html" title="Crypto Contexts">
24
<link rel="chapter" href="MIME.html" title="MIME Objects">
25
<link rel="chapter" href="Storage.html" title="Metadata Storage">
26
<link rel="chapter" href="Utilities.html" title="Utilities">
27
<link rel="chapter" href="Deprecated.html" title="Deprecated Objects">
28
<link rel="index" href="ix01.html" title="Index">
29
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
31
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
32
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
53
36
<td valign="top" align="right"></td>
54
37
</tr></table></div>
55
<div class="refsynopsisdiv" title="Synopsis">
38
<div class="refsynopsisdiv">
56
39
<a name="camel-CamelMimeFilterToHTML.synopsis"></a><h2>Synopsis</h2>
57
<pre class="synopsis">
58
<a class="link" href="camel-CamelMimeFilterToHTML.html#CamelMimeFilterToHTML" title="CamelMimeFilterToHTML">CamelMimeFilterToHTML</a>;
59
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-PRE--CAPS" title="CAMEL_MIME_FILTER_TOHTML_PRE">CAMEL_MIME_FILTER_TOHTML_PRE</a>
60
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-NL--CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_NL">CAMEL_MIME_FILTER_TOHTML_CONVERT_NL</a>
61
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-SPACES--CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES">CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES</a>
62
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-URLS--CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS">CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS</a>
63
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-MARK-CITATION--CAPS" title="CAMEL_MIME_FILTER_TOHTML_MARK_CITATION">CAMEL_MIME_FILTER_TOHTML_MARK_CITATION</a>
64
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-ADDRESSES--CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES">CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES</a>
65
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-ESCAPE-8BIT--CAPS" title="CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT">CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT</a>
66
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CITE--CAPS" title="CAMEL_MIME_FILTER_TOHTML_CITE">CAMEL_MIME_FILTER_TOHTML_CITE</a>
67
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-PRESERVE-8BIT--CAPS" title="CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT">CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT</a>
68
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-FORMAT-FLOWED--CAPS" title="CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED">CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED</a>
69
<a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter">CamelMimeFilter</a> * <a class="link" href="camel-CamelMimeFilterToHTML.html#camel-mime-filter-tohtml-new" title="camel_mime_filter_tohtml_new ()">camel_mime_filter_tohtml_new</a> (<a
70
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
73
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
76
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
77
>gchar</a> * <a class="link" href="camel-CamelMimeFilterToHTML.html#camel-text-to-html" title="camel_text_to_html ()">camel_text_to_html</a> (const <a
78
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
81
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
84
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
40
<pre class="synopsis"> <a class="link" href="camel-CamelMimeFilterToHTML.html#CamelMimeFilterToHTML" title="CamelMimeFilterToHTML">CamelMimeFilterToHTML</a>;
41
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-PRE:CAPS" title="CAMEL_MIME_FILTER_TOHTML_PRE">CAMEL_MIME_FILTER_TOHTML_PRE</a>
42
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-NL:CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_NL">CAMEL_MIME_FILTER_TOHTML_CONVERT_NL</a>
43
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-SPACES:CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES">CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES</a>
44
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-URLS:CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS">CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS</a>
45
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-MARK-CITATION:CAPS" title="CAMEL_MIME_FILTER_TOHTML_MARK_CITATION">CAMEL_MIME_FILTER_TOHTML_MARK_CITATION</a>
46
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CONVERT-ADDRESSES:CAPS" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES">CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES</a>
47
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-ESCAPE-8BIT:CAPS" title="CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT">CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT</a>
48
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-CITE:CAPS" title="CAMEL_MIME_FILTER_TOHTML_CITE">CAMEL_MIME_FILTER_TOHTML_CITE</a>
49
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-PRESERVE-8BIT:CAPS" title="CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT">CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT</a>
50
#define <a class="link" href="camel-CamelMimeFilterToHTML.html#CAMEL-MIME-FILTER-TOHTML-FORMAT-FLOWED:CAPS" title="CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED">CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED</a>
51
<a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter"><span class="returnvalue">CamelMimeFilter</span></a> * <a class="link" href="camel-CamelMimeFilterToHTML.html#camel-mime-filter-tohtml-new" title="camel_mime_filter_tohtml_new ()">camel_mime_filter_tohtml_new</a> (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
52
<em class="parameter"><code><span class="type">guint32</span> colour</code></em>);
53
<span class="returnvalue">gchar</span> * <a class="link" href="camel-CamelMimeFilterToHTML.html#camel-text-to-html" title="camel_text_to_html ()">camel_text_to_html</a> (<em class="parameter"><code>const <span class="type">gchar</span> *in</code></em>,
54
<em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
55
<em class="parameter"><code><span class="type">guint32</span> colour</code></em>);
88
<div class="refsect1" title="Description">
58
<div class="refsect1" lang="en">
89
59
<a name="camel-CamelMimeFilterToHTML.description"></a><h2>Description</h2>
93
<div class="refsect1" title="Details">
63
<div class="refsect1" lang="en">
94
64
<a name="camel-CamelMimeFilterToHTML.details"></a><h2>Details</h2>
95
<div class="refsect2" title="CamelMimeFilterToHTML">
65
<div class="refsect2" lang="en">
96
66
<a name="CamelMimeFilterToHTML"></a><h3>CamelMimeFilterToHTML</h3>
97
67
<pre class="programlisting">typedef struct {
98
68
CamelMimeFilter parent;
113
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_PRE">
114
<a name="CAMEL-MIME-FILTER-TOHTML-PRE--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_PRE</h3>
83
<div class="refsect2" lang="en">
84
<a name="CAMEL-MIME-FILTER-TOHTML-PRE:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_PRE</h3>
115
85
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_PRE (1 << 0)
121
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_NL">
122
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-NL--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_NL</h3>
91
<div class="refsect2" lang="en">
92
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-NL:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_NL</h3>
123
93
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_CONVERT_NL (1 << 1)
129
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES">
130
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-SPACES--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES</h3>
99
<div class="refsect2" lang="en">
100
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-SPACES:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES</h3>
131
101
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES (1 << 2)
137
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS">
138
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-URLS--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS</h3>
107
<div class="refsect2" lang="en">
108
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-URLS:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS</h3>
139
109
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS (1 << 3)
145
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_MARK_CITATION">
146
<a name="CAMEL-MIME-FILTER-TOHTML-MARK-CITATION--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_MARK_CITATION</h3>
115
<div class="refsect2" lang="en">
116
<a name="CAMEL-MIME-FILTER-TOHTML-MARK-CITATION:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_MARK_CITATION</h3>
147
117
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_MARK_CITATION (1 << 4)
153
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES">
154
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-ADDRESSES--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES</h3>
123
<div class="refsect2" lang="en">
124
<a name="CAMEL-MIME-FILTER-TOHTML-CONVERT-ADDRESSES:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES</h3>
155
125
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES (1 << 5)
161
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT">
162
<a name="CAMEL-MIME-FILTER-TOHTML-ESCAPE-8BIT--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT</h3>
131
<div class="refsect2" lang="en">
132
<a name="CAMEL-MIME-FILTER-TOHTML-ESCAPE-8BIT:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT</h3>
163
133
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT (1 << 6)
169
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_CITE">
170
<a name="CAMEL-MIME-FILTER-TOHTML-CITE--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CITE</h3>
139
<div class="refsect2" lang="en">
140
<a name="CAMEL-MIME-FILTER-TOHTML-CITE:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_CITE</h3>
171
141
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_CITE (1 << 7)
177
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT">
178
<a name="CAMEL-MIME-FILTER-TOHTML-PRESERVE-8BIT--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT</h3>
147
<div class="refsect2" lang="en">
148
<a name="CAMEL-MIME-FILTER-TOHTML-PRESERVE-8BIT:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT</h3>
179
149
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT (1 << 8)
185
<div class="refsect2" title="CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED">
186
<a name="CAMEL-MIME-FILTER-TOHTML-FORMAT-FLOWED--CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED</h3>
155
<div class="refsect2" lang="en">
156
<a name="CAMEL-MIME-FILTER-TOHTML-FORMAT-FLOWED:CAPS"></a><h3>CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED</h3>
187
157
<pre class="programlisting">#define CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED (1 << 9)
193
<div class="refsect2" title="camel_mime_filter_tohtml_new ()">
163
<div class="refsect2" lang="en">
194
164
<a name="camel-mime-filter-tohtml-new"></a><h3>camel_mime_filter_tohtml_new ()</h3>
195
<pre class="programlisting"><a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter">CamelMimeFilter</a> * camel_mime_filter_tohtml_new (<a
196
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
199
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
200
>guint32</a> colour);</pre>
165
<pre class="programlisting"><a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter"><span class="returnvalue">CamelMimeFilter</span></a> * camel_mime_filter_tohtml_new (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
166
<em class="parameter"><code><span class="type">guint32</span> colour</code></em>);</pre>
202
168
Create a new <a class="link" href="camel-CamelMimeFilterToHTML.html#CamelMimeFilterToHTML" title="CamelMimeFilterToHTML"><span class="type">CamelMimeFilterToHTML</span></a> object to convert plain text
206
170
<div class="variablelist"><table border="0">
207
171
<col align="left" valign="top">
210
174
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
211
<td> bitwise flags defining the behaviour
175
<td>bitwise flags defining the behaviour
215
179
<td><p><span class="term"><em class="parameter"><code>colour</code></em> :</span></p></td>
216
<td> colour to use when highlighting quoted text
180
<td>colour to use when highlighting quoted text
228
<div class="refsect2" title="camel_text_to_html ()">
192
<div class="refsect2" lang="en">
229
193
<a name="camel-text-to-html"></a><h3>camel_text_to_html ()</h3>
230
<pre class="programlisting"><a
231
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
232
>gchar</a> * camel_text_to_html (const <a
233
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
236
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
239
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
240
>guint32</a> colour);</pre>
194
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_text_to_html (<em class="parameter"><code>const <span class="type">gchar</span> *in</code></em>,
195
<em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
196
<em class="parameter"><code><span class="type">guint32</span> colour</code></em>);</pre>
242
198
Convert <em class="parameter"><code>in</code></em> from plain text into HTML.</p>
245
199
<div class="variablelist"><table border="0">
246
200
<col align="left" valign="top">
249
203
<td><p><span class="term"><em class="parameter"><code>in</code></em> :</span></p></td>
254
208
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
255
<td> bitwise flags defining the html conversion behaviour
209
<td>bitwise flags defining the html conversion behaviour
259
213
<td><p><span class="term"><em class="parameter"><code>colour</code></em> :</span></p></td>
260
<td> colour to use when syntax highlighting
214
<td>colour to use when syntax highlighting