evolution-dev 3.10.4-0ubuntu1 / usr / share / gtk-doc / html / evolution-util / evolution-util-Text-to-HTML-Conversion.html

This file is indexed.

/usr/share/gtk-doc/html/evolution-util/evolution-util-Text-to-HTML-Conversion.html is in evolution-dev 3.10.4-0ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Text to HTML Conversion</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch01.html" title="Basic Utility Functions">
<link rel="prev" href="evolution-util-Date-and-Time-Formatting.html" title="Date and Time Formatting">
<link rel="next" href="evolution-util-Miscellaneous-Utilities.html" title="Miscellaneous Utilities">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="evolution-util-Date-and-Time-Formatting.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution Utilities Reference Manual</th>
<td><a accesskey="n" href="evolution-util-Miscellaneous-Utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#evolution-util-Text-to-HTML-Conversion.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#evolution-util-Text-to-HTML-Conversion.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="evolution-util-Text-to-HTML-Conversion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-util-Text-to-HTML-Conversion.top_of_page"></a>Text to HTML Conversion</span></h2>
<p>Text to HTML Conversion</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="evolution-util-Text-to-HTML-Conversion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-PRE:CAPS" title="E_TEXT_TO_HTML_PRE">E_TEXT_TO_HTML_PRE</a>
#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-CONVERT-NL:CAPS" title="E_TEXT_TO_HTML_CONVERT_NL">E_TEXT_TO_HTML_CONVERT_NL</a>
#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-CONVERT-SPACES:CAPS" title="E_TEXT_TO_HTML_CONVERT_SPACES">E_TEXT_TO_HTML_CONVERT_SPACES</a>
#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-CONVERT-URLS:CAPS" title="E_TEXT_TO_HTML_CONVERT_URLS">E_TEXT_TO_HTML_CONVERT_URLS</a>
#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-MARK-CITATION:CAPS" title="E_TEXT_TO_HTML_MARK_CITATION">E_TEXT_TO_HTML_MARK_CITATION</a>
#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-CONVERT-ADDRESSES:CAPS" title="E_TEXT_TO_HTML_CONVERT_ADDRESSES">E_TEXT_TO_HTML_CONVERT_ADDRESSES</a>
#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-ESCAPE-8BIT:CAPS" title="E_TEXT_TO_HTML_ESCAPE_8BIT">E_TEXT_TO_HTML_ESCAPE_8BIT</a>
#define             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#E-TEXT-TO-HTML-CITE:CAPS" title="E_TEXT_TO_HTML_CITE">E_TEXT_TO_HTML_CITE</a>
<span class="returnvalue">gchar</span> *             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#e-text-to-html-full" title="e_text_to_html_full ()">e_text_to_html_full</a>                 (<em class="parameter"><code>const <span class="type">gchar</span> *input</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> flags</code></em>,
                                                         <em class="parameter"><code><span class="type">guint32</span> color</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="evolution-util-Text-to-HTML-Conversion.html#e-text-to-html" title="e_text_to_html ()">e_text_to_html</a>                      (<em class="parameter"><code>const <span class="type">gchar</span> *input</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> flags</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="evolution-util-Text-to-HTML-Conversion.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-util-Text-to-HTML-Conversion.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-PRE:CAPS"></a><h3>E_TEXT_TO_HTML_PRE</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_PRE               (1 &lt;&lt; 0)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-CONVERT-NL:CAPS"></a><h3>E_TEXT_TO_HTML_CONVERT_NL</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_CONVERT_NL        (1 &lt;&lt; 1)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-CONVERT-SPACES:CAPS"></a><h3>E_TEXT_TO_HTML_CONVERT_SPACES</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_CONVERT_SPACES    (1 &lt;&lt; 2)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-CONVERT-URLS:CAPS"></a><h3>E_TEXT_TO_HTML_CONVERT_URLS</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_CONVERT_URLS      (1 &lt;&lt; 3)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-MARK-CITATION:CAPS"></a><h3>E_TEXT_TO_HTML_MARK_CITATION</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_MARK_CITATION     (1 &lt;&lt; 4)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-CONVERT-ADDRESSES:CAPS"></a><h3>E_TEXT_TO_HTML_CONVERT_ADDRESSES</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_CONVERT_ADDRESSES (1 &lt;&lt; 5)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-ESCAPE-8BIT:CAPS"></a><h3>E_TEXT_TO_HTML_ESCAPE_8BIT</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_ESCAPE_8BIT       (1 &lt;&lt; 6)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-CITE:CAPS"></a><h3>E_TEXT_TO_HTML_CITE</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_CITE              (1 &lt;&lt; 7)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-text-to-html-full"></a><h3>e_text_to_html_full ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_text_to_html_full                 (<em class="parameter"><code>const <span class="type">gchar</span> *input</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> flags</code></em>,
                                                         <em class="parameter"><code><span class="type">guint32</span> color</code></em>);</pre>
<p>
This takes a buffer of text as input and produces a buffer of
"equivalent" HTML, subject to certain transformation rules.
</p>
<p>
The set of possible flags is:
</p>
<p>
  - E_TEXT_TO_HTML_PRE: wrap the output HTML in &lt;PRE&gt; and
    &lt;/PRE&gt;  Should only be used if <em class="parameter"><code>input</code></em> is the entire
    buffer to be converted. If e_text_to_html is being called with
    small pieces of data, you should wrap the entire result in
    &lt;PRE&gt; yourself.
</p>
<p>
  - E_TEXT_TO_HTML_CONVERT_NL: convert "\n" to "&lt;BR&gt;n" on
    output.  (Should not be used with E_TEXT_TO_HTML_PRE, since
    that would result in double-newlines.)
</p>
<p>
  - E_TEXT_TO_HTML_CONVERT_SPACES: convert a block of N spaces
    into N-1 non-breaking spaces and one normal space. A space
    at the start of the buffer is always converted to a
    non-breaking space, regardless of the following character,
    which probably means you don't want to use this flag on
    pieces of data that aren't delimited by at least line breaks.
</p>
<p>
    If E_TEXT_TO_HTML_CONVERT_NL and E_TEXT_TO_HTML_CONVERT_SPACES
    are both defined, then TABs will also be converted to spaces.
</p>
<p>
  - E_TEXT_TO_HTML_CONVERT_URLS: wrap &lt;a href="..."&gt; &lt;/a&gt;
    around strings that look like URLs.
</p>
<p>
  - E_TEXT_TO_HTML_CONVERT_ADDRESSES: wrap &lt;a href="mailto:..."&gt;
    &lt;/a&gt; around strings that look like mail addresses.
</p>
<p>
  - E_TEXT_TO_HTML_MARK_CITATION: wrap &lt;font color="..."&gt;
    &lt;/font&gt; around citations (lines beginning with "&gt; ", etc).
</p>
<p>
  - E_TEXT_TO_HTML_ESCAPE_8BIT: flatten everything to US-ASCII
</p>
<p>
  - E_TEXT_TO_HTML_CITE: quote the text with "&gt; " at the start of each
    line.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>input</code></em> :</span></p></td>
<td>a NUL-terminated input buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>some combination of the E_TEXT_TO_HTML_* flags defined
in e-html-utils.h</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>color for citation highlighting</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated string containing HTML</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-text-to-html"></a><h3>e_text_to_html ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_text_to_html                      (<em class="parameter"><code>const <span class="type">gchar</span> *input</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> flags</code></em>);</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.