File: EMailFormatterExtension.html

package info (click to toggle)
evolution 3.12.9~git20141130.241663-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 135,148 kB
  • ctags: 42,742
  • sloc: ansic: 398,340; sh: 11,322; xml: 6,861; makefile: 4,982; perl: 164
file content (267 lines) | stat: -rw-r--r-- 15,580 bytes parent folder | download 
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution Mail Formatter Reference Manual: EMailFormatterExtension</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution Mail Formatter Reference Manual">
<link rel="up" href="ch02.html" title="Extensions">
<link rel="prev" href="EMailParserExtension.html" title="EMailParserExtension">
<link rel="next" href="ch03.html" title="Miscellaneous">
<meta name="generator" content="GTK-Doc V1.21 (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="#EMailFormatterExtension.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#EMailFormatterExtension.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EMailParserExtension.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EMailFormatterExtension"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EMailFormatterExtension.top_of_page"></a>EMailFormatterExtension</span></h2>
<p>EMailFormatterExtension</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EMailFormatterExtension.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EMailFormatterExtension.html#e-mail-formatter-extension-format" title="e_mail_formatter_extension_format ()">e_mail_formatter_extension_format</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EMailFormatterExtension.html#e-mail-formatter-extension-has-widget" title="e_mail_formatter_extension_has_widget ()">e_mail_formatter_extension_has_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="EMailFormatterExtension.html#e-mail-formatter-extension-get-widget" title="e_mail_formatter_extension_get_widget ()">e_mail_formatter_extension_get_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EMailFormatterExtension.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EMailFormatterExtension.html#EMailFormatterExtension-struct" title="struct EMailFormatterExtension">EMailFormatterExtension</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EMailFormatterExtension.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> EMailFormatterExtension
        <span class="lineart">├──</span> <a class="link" href="EMailFormatterPrint.html#EMailFormatterPrintExtension">EMailFormatterPrintExtension</a>
        <span class="lineart">╰──</span> <a class="link" href="EMailFormatterQuote.html#EMailFormatterQuoteExtension">EMailFormatterQuoteExtension</a>
</pre>
</div>
<div class="refsect1">
<a name="EMailFormatterExtension.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EMailFormatterExtension.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-mail-formatter-extension-format"></a><h3>e_mail_formatter_extension_format ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_mail_formatter_extension_format (<em class="parameter"><code><a class="link" href="EMailFormatterExtension.html" title="EMailFormatterExtension"><span class="type">EMailFormatterExtension</span></a> *extension</code></em>,
                                   <em class="parameter"><code><a class="link" href="EMailFormatter.html" title="EMailFormatter"><span class="type">EMailFormatter</span></a> *formatter</code></em>,
                                   <em class="parameter"><code><a class="link" href="EMailFormatter.html#EMailFormatterContext" title="struct EMailFormatterContext"><span class="type">EMailFormatterContext</span></a> *context</code></em>,
                                   <em class="parameter"><code><a class="link" href="EMailPart.html" title="EMailPart"><span class="type">EMailPart</span></a> *part</code></em>,
                                   <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GOutputStream.html"><span class="type">GOutputStream</span></a> *stream</code></em>,
                                   <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>);</pre>
<p>A virtual function reimplemented in all mail formatter extensions. The
function formats <em class="parameter"><code>part</code></em>
, generated HTML (or other format that can be
displayed to user) and writes it to the <em class="parameter"><code>stream</code></em>
.</p>
<p>When the function is unable to format the <em class="parameter"><code>part</code></em>
 (either because it's broken
or because it is a different mimetype then the extension is specialized
for), the function will return <em class="parameter"><code>FALSE</code></em>
 indicating the <a class="link" href="EMailFormatter.html" title="EMailFormatter"><span class="type">EMailFormatter</span></a>, that
it should pick another extension.</p>
<p>Implementation of this function must be thread-safe.</p>
<div class="refsect3">
<a name="id-1.3.4.7.2.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="EMailFormatterExtension.html" title="EMailFormatterExtension"><span class="type">EMailFormatterExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>formatter</p></td>
<td class="parameter_description"><p>an <a class="link" href="EMailFormatter.html" title="EMailFormatter"><span class="type">EMailFormatter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>an <a class="link" href="EMailFormatter.html#EMailFormatterContext" title="struct EMailFormatterContext"><span class="type">EMailFormatterContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>part</p></td>
<td class="parameter_description"><p>a <a class="link" href="EMailPart.html" title="EMailPart"><span class="type">EMailPart</span></a> to be formatter</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GOutputStream.html"><span class="type">GOutputStream</span></a> to which the output should be written</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>(allow-none) a <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.7.2.8"></a><h4>Returns</h4>
<p> Returns <em class="parameter"><code>TRUE</code></em>
when the <em class="parameter"><code>part</code></em>
was successfully formatted and
data were written to the <em class="parameter"><code>stream</code></em>
, <em class="parameter"><code>FALSE</code></em>
otherwise.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-mail-formatter-extension-has-widget"></a><h3>e_mail_formatter_extension_has_widget ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_mail_formatter_extension_has_widget (<em class="parameter"><code><a class="link" href="EMailFormatterExtension.html" title="EMailFormatterExtension"><span class="type">EMailFormatterExtension</span></a> *extension</code></em>);</pre>
<p>Returns whether the extension can provide a GtkWidget.</p>
<div class="refsect3">
<a name="id-1.3.4.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="EMailFormatterExtension.html" title="EMailFormatterExtension"><span class="type">EMailFormatterExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.7.3.6"></a><h4>Returns</h4>
<p> Returns <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when <em class="parameter"><code>extension</code></em>
reimplements <code class="function">get_widget()</code>, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
otherwise.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-mail-formatter-extension-get-widget"></a><h3>e_mail_formatter_extension_get_widget ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
e_mail_formatter_extension_get_widget (<em class="parameter"><code><a class="link" href="EMailFormatterExtension.html" title="EMailFormatterExtension"><span class="type">EMailFormatterExtension</span></a> *extension</code></em>,
                                       <em class="parameter"><code><a class="link" href="EMailPartList.html" title="EMailPartList"><span class="type">EMailPartList</span></a> *context</code></em>,
                                       <em class="parameter"><code><a class="link" href="EMailPart.html" title="EMailPart"><span class="type">EMailPart</span></a> *part</code></em>,
                                       <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *params</code></em>);</pre>
<p>A virtual function reimplemented in some mail formatter extensions. The
function should construct a <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> for given <em class="parameter"><code>part</code></em>
. The <em class="parameter"><code>params</code></em>
 hash
table can contain additional parameters listed in the &lt;object&gt; HTML
element that has requested the widget.</p>
<p>When <em class="parameter"><code>bind_dom_func</code></em>
 is not <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the callee will set a callback function
which should be called when the webpage is completely rendered to setup
bindings between DOM events and the widget.</p>
<div class="refsect3">
<a name="id-1.3.4.7.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="EMailFormatterExtension.html" title="EMailFormatterExtension"><span class="type">EMailFormatterExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>part</p></td>
<td class="parameter_description"><p>an <a class="link" href="EMailPart.html" title="EMailPart"><span class="type">EMailPart</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.7.4.7"></a><h4>Returns</h4>
<p> Returns a <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, when error occurs or given
<em class="parameter"><code>extension</code></em>
does not reimplement this method.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="EMailFormatterExtension.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EMailFormatterExtension-struct"></a><h3>struct EMailFormatterExtension</h3>
<pre class="programlisting">struct EMailFormatterExtension;</pre>
<p>The <a class="link" href="EMailFormatterExtension.html" title="EMailFormatterExtension"><span class="type">EMailFormatterExtension</span></a> is an abstract class for all extensions for
<a class="link" href="EMailFormatter.html" title="EMailFormatter"><span class="type">EMailFormatter</span></a>.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>