/usr/share/gtk-doc/html/evolution-util/evolution-util-e-html-utils.html is in evolution-dev 3.28.1-2.
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-html-utils: Evolution Utilities Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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-e-datetime-format.html" title="e-datetime-format">
<link rel="next" href="evolution-util-e-misc-utils.html" title="e-misc-utils">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#evolution-util-e-html-utils.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-util-e-datetime-format.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-util-e-misc-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-util-e-html-utils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-util-e-html-utils.top_of_page"></a>e-html-utils</span></h2>
<p>e-html-utils</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-util-e-html-utils.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-e-html-utils.html#e-text-to-html-full" title="e_text_to_html_full ()">e_text_to_html_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-e-html-utils.html#e-text-to-html" title="e_text_to_html ()">e_text_to_html</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-util-e-html-utils.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-PRE:CAPS" title="E_TEXT_TO_HTML_PRE">E_TEXT_TO_HTML_PRE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-CONVERT-NL:CAPS" title="E_TEXT_TO_HTML_CONVERT_NL">E_TEXT_TO_HTML_CONVERT_NL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-CONVERT-SPACES:CAPS" title="E_TEXT_TO_HTML_CONVERT_SPACES">E_TEXT_TO_HTML_CONVERT_SPACES</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-CONVERT-URLS:CAPS" title="E_TEXT_TO_HTML_CONVERT_URLS">E_TEXT_TO_HTML_CONVERT_URLS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-MARK-CITATION:CAPS" title="E_TEXT_TO_HTML_MARK_CITATION">E_TEXT_TO_HTML_MARK_CITATION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-CONVERT-ADDRESSES:CAPS" title="E_TEXT_TO_HTML_CONVERT_ADDRESSES">E_TEXT_TO_HTML_CONVERT_ADDRESSES</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-ESCAPE-8BIT:CAPS" title="E_TEXT_TO_HTML_ESCAPE_8BIT">E_TEXT_TO_HTML_ESCAPE_8BIT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-CITE:CAPS" title="E_TEXT_TO_HTML_CITE">E_TEXT_TO_HTML_CITE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-HIDE-URL-SCHEME:CAPS" title="E_TEXT_TO_HTML_HIDE_URL_SCHEME">E_TEXT_TO_HTML_HIDE_URL_SCHEME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-util-e-html-utils.html#E-TEXT-TO-HTML-LAST-FLAG:CAPS" title="E_TEXT_TO_HTML_LAST_FLAG">E_TEXT_TO_HTML_LAST_FLAG</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-util-e-html-utils.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-util-e-html-utils.functions_details"></a><h2>Functions</h2>
<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>
<div class="warning"><p><code class="literal">e_text_to_html_full</code> is deprecated and should not be used in newly-written code.</p></div>
<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>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>E_TEXT_TO_HTML_PRE: wrap the output HTML in <PRE> and
</PRE> 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
<PRE> yourself.</p></li>
<li class="listitem"><p>E_TEXT_TO_HTML_CONVERT_NL: convert "\n" to "<BR>n" on
output. (Should not be used with E_TEXT_TO_HTML_PRE, since
that would result in double-newlines.)</p></li>
<li class="listitem">
<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>
</li>
<li class="listitem"><p>E_TEXT_TO_HTML_CONVERT_URLS: wrap <a href="..."> </a>
around strings that look like URLs.</p></li>
<li class="listitem"><p>E_TEXT_TO_HTML_CONVERT_ADDRESSES: wrap <a href="mailto:...">
</a> around strings that look like mail addresses.</p></li>
<li class="listitem"><p>E_TEXT_TO_HTML_MARK_CITATION: wrap <font color="...">
</font> around citations (lines beginning with "> ", etc).</p></li>
<li class="listitem"><p>E_TEXT_TO_HTML_ESCAPE_8BIT: flatten everything to US-ASCII</p></li>
<li class="listitem"><p>E_TEXT_TO_HTML_CITE: quote the text with "> " at the start of each
line.</p></li>
<li class="listitem"><p>E_TEXT_TO_HTML_HIDE_URL_SCHEME: hides scheme part of the URL in
the display part of the generated text (thus, instead of "http://www.example.com",
user will only see "www.example.com")</p></li>
<li class="listitem"><p>E_TEXT_TO_HTML_URL_IS_WHOLE_TEXT: set when the whole <em class="parameter"><code>input</code></em>
text
represents a URL; any spaces are removed in the href part.</p></li>
</ul></div>
<div class="refsect3">
<a name="e-text-to-html-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>input</p></td>
<td class="parameter_description"><p>a NUL-terminated input buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>some combination of the E_TEXT_TO_HTML_* flags defined
in e-html-utils.h</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>color for citation highlighting</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-text-to-html-full.returns"></a><h4>Returns</h4>
<p> a newly-allocated string containing HTML</p>
</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 class="warning"><p><code class="literal">e_text_to_html</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
</div>
<div class="refsect1">
<a name="evolution-util-e-html-utils.other_details"></a><h2>Types and Values</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 << 0)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_PRE</code> is deprecated and should not be used in newly-written code.</p></div>
</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 << 1)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_CONVERT_NL</code> is deprecated and should not be used in newly-written code.</p></div>
</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 << 2)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_CONVERT_SPACES</code> is deprecated and should not be used in newly-written code.</p></div>
</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 << 3)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_CONVERT_URLS</code> is deprecated and should not be used in newly-written code.</p></div>
</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 << 4)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_MARK_CITATION</code> is deprecated and should not be used in newly-written code.</p></div>
</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 << 5)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_CONVERT_ADDRESSES</code> is deprecated and should not be used in newly-written code.</p></div>
</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 << 6)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_ESCAPE_8BIT</code> is deprecated and should not be used in newly-written code.</p></div>
</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 << 7)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_CITE</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-HIDE-URL-SCHEME:CAPS"></a><h3>E_TEXT_TO_HTML_HIDE_URL_SCHEME</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_HIDE_URL_SCHEME (1 << 8)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_HIDE_URL_SCHEME</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="E-TEXT-TO-HTML-LAST-FLAG:CAPS"></a><h3>E_TEXT_TO_HTML_LAST_FLAG</h3>
<pre class="programlisting">#define E_TEXT_TO_HTML_LAST_FLAG (1 << 10)
</pre>
<div class="warning"><p><code class="literal">E_TEXT_TO_HTML_LAST_FLAG</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|