evolution-dev 3.28.1-2 / usr / share / gtk-doc / html / evolution-util / evolution-util-EAlertSink.html

This file is indexed.

/usr/share/gtk-doc/html/evolution-util/evolution-util-EAlertSink.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EAlertSink: 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="ch03.html" title="Alerts">
<link rel="prev" href="evolution-util-EAlertDialog.html" title="EAlertDialog">
<link rel="next" href="ch04.html" title="Attachments">
<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-EAlertSink.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-util-EAlertDialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-util-EAlertSink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-util-EAlertSink.top_of_page"></a>EAlertSink</span></h2>
<p>EAlertSink — an interface to handle alerts</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-util-EAlertSink.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">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-submit-alert" title="e_alert_sink_submit_alert ()">e_alert_sink_submit_alert</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="evolution-util-EAlertSink.html#EAlertSinkThreadJobFunc" title="EAlertSinkThreadJobFunc ()">*EAlertSinkThreadJobFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <span class="returnvalue">_EActivity</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-submit-thread-job" title="e_alert_sink_submit_thread_job ()">e_alert_sink_submit_thread_job</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-thread-job-set-alert-ident" title="e_alert_sink_thread_job_set_alert_ident ()">e_alert_sink_thread_job_set_alert_ident</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-thread-job-set-alert-arg-0" title="e_alert_sink_thread_job_set_alert_arg_0 ()">e_alert_sink_thread_job_set_alert_arg_0</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-util-EAlertSink.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="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="evolution-util-EAlertSink.html#EAlertSinkThreadJobData" title="EAlertSinkThreadJobData">EAlertSinkThreadJobData</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-util-EAlertSink.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;e-util/e-util.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="evolution-util-EAlertSink.description"></a><h2>Description</h2>
<p>A widget that implements <span class="type">EAlertSink</span> means it can handle <span class="type">EAlerts</span>,
usually by displaying them to the user.</p>
</div>
<div class="refsect1">
<a name="evolution-util-EAlertSink.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-alert-sink-submit-alert"></a><h3>e_alert_sink_submit_alert ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_alert_sink_submit_alert (<em class="parameter"><code><span class="type">EAlertSink</span> *alert_sink</code></em>,
                           <em class="parameter"><code><span class="type">EAlert</span> *alert</code></em>);</pre>
<div class="warning"><p><code class="literal">e_alert_sink_submit_alert</code> is deprecated and should not be used in newly-written code.</p></div>
<p>This function is a place to pass <span class="type">EAlert</span> objects.  Beyond that it has no
well-defined behavior.  It's up to the widget implementing the <span class="type">EAlertSink</span>
interface to decide what to do with them.</p>
<div class="refsect3">
<a name="e-alert-sink-submit-alert.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>alert_sink</p></td>
<td class="parameter_description"><p>an <span class="type">EAlertSink</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert</p></td>
<td class="parameter_description"><p>an <span class="type">EAlert</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="EAlertSinkThreadJobFunc"></a><h3>EAlertSinkThreadJobFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*EAlertSinkThreadJobFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="evolution-util-EAlertSink.html#EAlertSinkThreadJobData" title="EAlertSinkThreadJobData"><span class="type">EAlertSinkThreadJobData</span></a> *job_data</code></em>,
                            <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
                            <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                            <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning"><p><code class="literal">EAlertSinkThreadJobFunc</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="e-alert-sink-submit-thread-job"></a><h3>e_alert_sink_submit_thread_job ()</h3>
<pre class="programlisting">struct <span class="returnvalue">_EActivity</span> *
e_alert_sink_submit_thread_job (<em class="parameter"><code><span class="type">EAlertSink</span> *alert_sink</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *alert_ident</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *alert_arg_0</code></em>,
                                <em class="parameter"><code><a class="link" href="evolution-util-EAlertSink.html#EAlertSinkThreadJobFunc" title="EAlertSinkThreadJobFunc ()"><span class="type">EAlertSinkThreadJobFunc</span></a> func</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
                                <em class="parameter"><code><span class="type">GDestroyNotify</span> free_user_data</code></em>);</pre>
<div class="warning"><p><code class="literal">e_alert_sink_submit_thread_job</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Runs the <em class="parameter"><code>func</code></em>
 in a dedicated thread. Any error is propagated to UI.
The cancellable passed into the <em class="parameter"><code>func</code></em>
 is a <span class="type">CamelOperation</span>, thus
the caller can overwrite progress and description message on it.</p>
<div class="refsect3">
<a name="e-alert-sink-submit-thread-job.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>alert_sink</p></td>
<td class="parameter_description"><p>an <span class="type">EAlertSink</span> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>description</p></td>
<td class="parameter_description"><p>user-friendly description of the job, to be shown in UI</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert_ident</p></td>
<td class="parameter_description"><p>in case of an error, this alert identificator is used
for EAlert construction</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert_arg_0</p></td>
<td class="parameter_description"><p>in case of an error, use this string as
the first argument to the EAlert construction; the second argument
is the actual error message; can be <span class="type">NULL</span>, in which case only
the error message is passed to the EAlert construction. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>function to be run in a dedicated thread</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>custom data passed into <em class="parameter"><code>func</code></em>
; can be <span class="type">NULL</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>free_user_data</p></td>
<td class="parameter_description"><p>function to be called on <em class="parameter"><code>user_data</code></em>
,
when the job is over; can be <span class="type">NULL</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-alert-sink-submit-thread-job.returns"></a><h4>Returns</h4>
<p>Newly created <span class="type">EActivity</span> on success.
The caller is responsible to <code class="function">g_object_unref()</code> it when done with it.</p>
<p>Note: The <em class="parameter"><code>free_user_data</code></em>
, if set, is called in the main thread.</p>
<p>Note: This function should be called only from the main thread. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-alert-sink-thread-job-set-alert-ident"></a><h3>e_alert_sink_thread_job_set_alert_ident ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_alert_sink_thread_job_set_alert_ident
                               (<em class="parameter"><code><a class="link" href="evolution-util-EAlertSink.html#EAlertSinkThreadJobData" title="EAlertSinkThreadJobData"><span class="type">EAlertSinkThreadJobData</span></a> *job_data</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *alert_ident</code></em>);</pre>
<div class="warning"><p><code class="literal">e_alert_sink_thread_job_set_alert_ident</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Change an alert identificator to be used for error reporting.
This can be used within a thread function at <a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-submit-thread-job" title="e_alert_sink_submit_thread_job ()"><code class="function">e_alert_sink_submit_thread_job()</code></a>,
to overwrite the default error message, in case of a need to more fine-tuned
infomation to a user being available.</p>
<p>See: e_alert_sink_thread_job_set_alert_arg_0</p>
<div class="refsect3">
<a name="e-alert-sink-thread-job-set-alert-ident.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>job_data</p></td>
<td class="parameter_description"><p>Thread job data, as passed to a thread
function specified at <a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-submit-thread-job" title="e_alert_sink_submit_thread_job ()"><code class="function">e_alert_sink_submit_thread_job()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert_ident</p></td>
<td class="parameter_description"><p>A new alert identificator to use; cannot be <span class="type">NULL</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-alert-sink-thread-job-set-alert-arg-0"></a><h3>e_alert_sink_thread_job_set_alert_arg_0 ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_alert_sink_thread_job_set_alert_arg_0
                               (<em class="parameter"><code><a class="link" href="evolution-util-EAlertSink.html#EAlertSinkThreadJobData" title="EAlertSinkThreadJobData"><span class="type">EAlertSinkThreadJobData</span></a> *job_data</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *alert_arg_0</code></em>);</pre>
<div class="warning"><p><code class="literal">e_alert_sink_thread_job_set_alert_arg_0</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Change an argument 0 for an alert to be used for error reporting.
This can be used within a thread function at <a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-submit-thread-job" title="e_alert_sink_submit_thread_job ()"><code class="function">e_alert_sink_submit_thread_job()</code></a>,
to overwrite the default argument 0 of the erorr message. It might be
usually used with combination of <a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-thread-job-set-alert-ident" title="e_alert_sink_thread_job_set_alert_ident ()"><code class="function">e_alert_sink_thread_job_set_alert_ident()</code></a>.</p>
<div class="refsect3">
<a name="e-alert-sink-thread-job-set-alert-arg-0.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>job_data</p></td>
<td class="parameter_description"><p>Thread job data, as passed to a thread
function specified at <a class="link" href="evolution-util-EAlertSink.html#e-alert-sink-submit-thread-job" title="e_alert_sink_submit_thread_job ()"><code class="function">e_alert_sink_submit_thread_job()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert_arg_0</p></td>
<td class="parameter_description"><p>A new argument 0 of the alert;
can be <span class="type">NULL</span>, to unset the previously set value. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-util-EAlertSink.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EAlertSinkThreadJobData"></a><h3>EAlertSinkThreadJobData</h3>
<pre class="programlisting">typedef struct _EAlertSinkThreadJobData EAlertSinkThreadJobData;</pre>
<div class="warning"><p><code class="literal">EAlertSinkThreadJobData</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>

APT Browse - Built by Thomas Orozco.