docs/reference/html/GMimeStreamFilter.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>GMimeStreamFilter</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="Streams.html" title="Streams">
   9 <link rel="prev" href="GMimeStreamNull.html" title="GMimeStreamNull">
  10 <link rel="next" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer">
  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="GMimeStreamNull.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Streams.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="GMimeStreamBuffer.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="#GMimeStreamFilter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeStreamFilter.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeStreamFilter.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeStreamFilter"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeStreamFilter.top_of_page"></a>GMimeStreamFilter</span></h2>
  36 <p>GMimeStreamFilter — A filtering stream</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeStreamFilter.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeStreamFilter.html#GMimeStreamFilter-struct" title="struct GMimeStreamFilter">GMimeStreamFilter</a>;
  43 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamFilter.html#g-mime-stream-filter-new" title="g_mime_stream_filter_new ()">g_mime_stream_filter_new</a>            (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);
  44 <span class="returnvalue">int</span>                 <a class="link" href="GMimeStreamFilter.html#g-mime-stream-filter-add" title="g_mime_stream_filter_add ()">g_mime_stream_filter_add</a>            (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>,
  45                                                          <em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="GMimeStreamFilter.html#g-mime-stream-filter-remove" title="g_mime_stream_filter_remove ()">g_mime_stream_filter_remove</a>         (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>,
  47                                                          <em class="parameter"><code><span class="type">int</span> id</code></em>);
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="GMimeStreamFilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
  52 <pre class="synopsis">
  53   GObject
  54    +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
  55          +----GMimeStreamFilter
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="GMimeStreamFilter.description"></a><h2>Description</h2>
  60 <p>
  61 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> meant for filtering data passing through it.
  62 </p>
  63 <p>
  64 This stream class is useful for converting data of one type to
  65 another using <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> objects.
  66 </p>
  67 <p>
  68 When data passes through a <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>, it will pass through
  69 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> filters in the order they were added.
  70 </p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="GMimeStreamFilter.details"></a><h2>Details</h2>
  74 <div class="refsect2">
  75 <a name="GMimeStreamFilter-struct"></a><h3>struct GMimeStreamFilter</h3>
  76 <pre class="programlisting">struct GMimeStreamFilter;</pre>
  77 <p>
  78 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which passes data through any <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> objects.
  79 </p>
  80 <div class="variablelist"><table border="0">
  81 <col align="left" valign="top">
  82 <tbody></tbody>
  83 </table></div>
  84 </div>
  85 <hr>
  86 <div class="refsect2">
  87 <a name="g-mime-stream-filter-new"></a><h3>g_mime_stream_filter_new ()</h3>
  88 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_filter_new            (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
  89 <p>
  90 Creates a new <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> object using <em class="parameter"><code>stream</code></em> as the source
  91 stream.
  92 </p>
  93 <div class="variablelist"><table border="0">
  94 <col align="left" valign="top">
  95 <tbody>
  96 <tr>
  97 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
  98 <td>source stream</td>
  99 </tr>
 100 <tr>
 101 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 102 <td>a new filter stream with <em class="parameter"><code>stream</code></em> as its source.</td>
 103 </tr>
 104 </tbody>
 105 </table></div>
 106 </div>
 107 <hr>
 108 <div class="refsect2">
 109 <a name="g-mime-stream-filter-add"></a><h3>g_mime_stream_filter_add ()</h3>
 110 <pre class="programlisting"><span class="returnvalue">int</span>                 g_mime_stream_filter_add            (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>,
 111                                                          <em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre>
 112 <p>
 113 Adds <em class="parameter"><code>filter</code></em> to <em class="parameter"><code>stream</code></em>. Filters are applied in the same order in
 114 which they are added.
 115 </p>
 116 <div class="variablelist"><table border="0">
 117 <col align="left" valign="top">
 118 <tbody>
 119 <tr>
 120 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 121 <td>a <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>
 122 </td>
 123 </tr>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 126 <td>a <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a>
 127 </td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 131 <td>an id for the filter.</td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="g-mime-stream-filter-remove"></a><h3>g_mime_stream_filter_remove ()</h3>
 139 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_stream_filter_remove         (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>,
 140                                                          <em class="parameter"><code><span class="type">int</span> id</code></em>);</pre>
 141 <p>
 142 Removed a filter from the stream based on the id (as returned from
 143 filter_add).
 144 </p>
 145 <div class="variablelist"><table border="0">
 146 <col align="left" valign="top">
 147 <tbody>
 148 <tr>
 149 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 150 <td>a <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>
 151 </td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 155 <td>filter id</td>
 156 </tr>
 157 </tbody>
 158 </table></div>
 159 </div>
 160 </div>
 161 <div class="refsect1">
 162 <a name="GMimeStreamFilter.see-also"></a><h2>See Also</h2>
 163 <a class="link" href="Filters.html" title="Stream Filters"><span class="type">Filters</span></a>
 164 </div>
 165 </div>
 166 <div class="footer">
 167 <hr>
 168           Generated by GTK-Doc V1.18</div>
 169 </body>
 170 </html>