docs/reference/html/GMimeFilterHTML.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GMimeFilterHTML</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="Filters.html" title="Stream Filters">
   9 <link rel="prev" href="GMimeFilterGZip.html" title="GMimeFilterGZip">
  10 <link rel="next" href="GMimeFilterMd5.html" title="GMimeFilterMd5">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GMimeFilterGZip.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="GMimeFilterMd5.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GMimeFilterHTML.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeFilterHTML.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeFilterHTML.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeFilterHTML"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeFilterHTML.top_of_page"></a>GMimeFilterHTML</span></h2>
  36 <p>GMimeFilterHTML — Convert plain text into HTML</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeFilterHTML.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeFilterHTML.html#GMimeFilterHTML-struct" title="struct GMimeFilterHTML">GMimeFilterHTML</a>;
  43 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-PRE:CAPS" title="GMIME_FILTER_HTML_PRE">GMIME_FILTER_HTML_PRE</a>
  44 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-NL:CAPS" title="GMIME_FILTER_HTML_CONVERT_NL">GMIME_FILTER_HTML_CONVERT_NL</a>
  45 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-SPACES:CAPS" title="GMIME_FILTER_HTML_CONVERT_SPACES">GMIME_FILTER_HTML_CONVERT_SPACES</a>
  46 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-URLS:CAPS" title="GMIME_FILTER_HTML_CONVERT_URLS">GMIME_FILTER_HTML_CONVERT_URLS</a>
  47 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-MARK-CITATION:CAPS" title="GMIME_FILTER_HTML_MARK_CITATION">GMIME_FILTER_HTML_MARK_CITATION</a>
  48 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-ADDRESSES:CAPS" title="GMIME_FILTER_HTML_CONVERT_ADDRESSES">GMIME_FILTER_HTML_CONVERT_ADDRESSES</a>
  49 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-ESCAPE-8BIT:CAPS" title="GMIME_FILTER_HTML_ESCAPE_8BIT">GMIME_FILTER_HTML_ESCAPE_8BIT</a>
  50 #define             <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CITE:CAPS" title="GMIME_FILTER_HTML_CITE">GMIME_FILTER_HTML_CITE</a>
  51 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       <a class="link" href="GMimeFilterHTML.html#g-mime-filter-html-new" title="g_mime_filter_html_new ()">g_mime_filter_html_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 </pre>
  54 </div>
  55 <div class="refsect1">
  56 <a name="GMimeFilterHTML.object-hierarchy"></a><h2>Object Hierarchy</h2>
  57 <pre class="synopsis">
  58   GObject
  59    +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a>
  60          +----GMimeFilterHTML
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="GMimeFilterHTML.description"></a><h2>Description</h2>
  65 <p>
  66 A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for converting plain text into HTML.
  67 </p>
  68 </div>
  69 <div class="refsect1">
  70 <a name="GMimeFilterHTML.details"></a><h2>Details</h2>
  71 <div class="refsect2">
  72 <a name="GMimeFilterHTML-struct"></a><h3>struct GMimeFilterHTML</h3>
  73 <pre class="programlisting">struct GMimeFilterHTML;</pre>
  74 <p>
  75 A filter for converting text/plain into text/html.
  76 </p>
  77 <div class="variablelist"><table border="0">
  78 <col align="left" valign="top">
  79 <tbody></tbody>
  80 </table></div>
  81 </div>
  82 <hr>
  83 <div class="refsect2">
  84 <a name="GMIME-FILTER-HTML-PRE:CAPS"></a><h3>GMIME_FILTER_HTML_PRE</h3>
  85 <pre class="programlisting">#define GMIME_FILTER_HTML_PRE               (1 &lt;&lt; 0)
  86 </pre>
  87 <p>
  88 Wrap stream in &lt;pre&gt; tags.
  89 </p>
  90 </div>
  91 <hr>
  92 <div class="refsect2">
  93 <a name="GMIME-FILTER-HTML-CONVERT-NL:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_NL</h3>
  94 <pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_NL        (1 &lt;&lt; 1)
  95 </pre>
  96 <p>
  97 Convert new-lines ('\n') into &lt;br&gt; tags.
  98 </p>
  99 </div>
 100 <hr>
 101 <div class="refsect2">
 102 <a name="GMIME-FILTER-HTML-CONVERT-SPACES:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_SPACES</h3>
 103 <pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_SPACES    (1 &lt;&lt; 2)
 104 </pre>
 105 <p>
 106 Preserve whitespace by converting spaces into their appropriate
 107 html entities.
 108 </p>
 109 </div>
 110 <hr>
 111 <div class="refsect2">
 112 <a name="GMIME-FILTER-HTML-CONVERT-URLS:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_URLS</h3>
 113 <pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_URLS      (1 &lt;&lt; 3)
 114 </pre>
 115 <p>
 116 Wrap detected URLs in &lt;a href=...&gt; tags.
 117 </p>
 118 </div>
 119 <hr>
 120 <div class="refsect2">
 121 <a name="GMIME-FILTER-HTML-MARK-CITATION:CAPS"></a><h3>GMIME_FILTER_HTML_MARK_CITATION</h3>
 122 <pre class="programlisting">#define GMIME_FILTER_HTML_MARK_CITATION     (1 &lt;&lt; 4)
 123 </pre>
 124 <p>
 125 Change the colour of citation text.
 126 </p>
 127 </div>
 128 <hr>
 129 <div class="refsect2">
 130 <a name="GMIME-FILTER-HTML-CONVERT-ADDRESSES:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_ADDRESSES</h3>
 131 <pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_ADDRESSES (1 &lt;&lt; 5)
 132 </pre>
 133 <p>
 134 Wrap email addresses in "mailto:" href tags.
 135 </p>
 136 </div>
 137 <hr>
 138 <div class="refsect2">
 139 <a name="GMIME-FILTER-HTML-ESCAPE-8BIT:CAPS"></a><h3>GMIME_FILTER_HTML_ESCAPE_8BIT</h3>
 140 <pre class="programlisting">#define GMIME_FILTER_HTML_ESCAPE_8BIT       (1 &lt;&lt; 6)
 141 </pre>
 142 <p>
 143 Converts 8bit characters to '?'.
 144 </p>
 145 </div>
 146 <hr>
 147 <div class="refsect2">
 148 <a name="GMIME-FILTER-HTML-CITE:CAPS"></a><h3>GMIME_FILTER_HTML_CITE</h3>
 149 <pre class="programlisting">#define GMIME_FILTER_HTML_CITE              (1 &lt;&lt; 7)
 150 </pre>
 151 <p>
 152 Cites text by prepending "&gt; " to each cited line.
 153 </p>
 154 </div>
 155 <hr>
 156 <div class="refsect2">
 157 <a name="g-mime-filter-html-new"></a><h3>g_mime_filter_html_new ()</h3>
 158 <pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       g_mime_filter_html_new              (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
 159                                                          <em class="parameter"><code><span class="type">guint32</span> colour</code></em>);</pre>
 160 <p>
 161 Creates a new GMimeFilterHTML filter which can be used to convert a
 162 plain UTF-8 text stream into an html stream.
 163 </p>
 164 <div class="variablelist"><table border="0">
 165 <col align="left" valign="top">
 166 <tbody>
 167 <tr>
 168 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 169 <td>html flags</td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"><em class="parameter"><code>colour</code></em> :</span></p></td>
 173 <td>citation colour</td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 177 <td>a new html filter.</td>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 </div>
 182 </div>
 183 <div class="refsect1">
 184 <a name="GMimeFilterHTML.see-also"></a><h2>See Also</h2>
 185 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a>
 186 </div>
 187 </div>
 188 <div class="footer">
 189 <hr>
 190           Generated by GTK-Doc V1.18</div>
 191 </body>
 192 </html>