File: EDataCapture.html

package info (click to toggle)
evolution 3.22.6-1%2Bdeb9u2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 143,884 kB
  • sloc: ansic: 462,464; makefile: 5,128; xml: 4,189; sh: 4,094; python: 702
file content (258 lines) | stat: -rw-r--r-- 14,392 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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EDataCapture: 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="ch17.html" title="(Unsorted Sections)">
<link rel="prev" href="EContactStore.html" title="EContactStore">
<link rel="next" href="EDateEdit.html" title="EDateEdit">
<meta name="generator" content="GTK-Doc V1.25 (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="#EDataCapture.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#EDataCapture.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#EDataCapture.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#EDataCapture.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#EDataCapture.signals" class="shortcut">Signals</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="ch17.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EContactStore.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EDateEdit.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EDataCapture"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EDataCapture.top_of_page"></a>EDataCapture</span></h2>
<p>EDataCapture — Capture data from streams</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EDataCapture.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">
<a class="link" href="EDataCapture.html" title="EDataCapture"><span class="returnvalue">EDataCapture</span></a> *
</td>
<td class="function_name">
<a class="link" href="EDataCapture.html#e-data-capture-new" title="e_data_capture_new ()">e_data_capture_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="returnvalue">GMainContext</span></a> *
</td>
<td class="function_name">
<a class="link" href="EDataCapture.html#e-data-capture-ref-main-context" title="e_data_capture_ref_main_context ()">e_data_capture_ref_main_context</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDataCapture.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</td>
<td class="property_name"><a class="link" href="EDataCapture.html#EDataCapture--main-context" title="The “main-context” property">main-context</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDataCapture.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="EDataCapture.html#EDataCapture-finished" title="The “finished” signal">finished</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDataCapture.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">struct</td>
<td class="function_name"><a class="link" href="EDataCapture.html#EDataCapture-struct" title="struct EDataCapture">EDataCapture</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDataCapture.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> EDataCapture
</pre>
</div>
<div class="refsect1">
<a name="EDataCapture.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EDataCapture implements
 <a href="/usr/share/gtk-doc/html/gioGConverter.html#GConverter-struct">GConverter</a>.</p>
</div>
<div class="refsect1">
<a name="EDataCapture.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;e-util/e-util.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="EDataCapture.description"></a><h2>Description</h2>
<p><a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a> is a <a href="/usr/share/gtk-doc/html/gioGConverter.html#GConverter-struct"><span class="type">GConverter</span></a> that captures data until the end of
the input data is seen, then emits a <span class="type">“finished”</span> signal
with the captured data in a <a href="/usr/share/gtk-doc/html/glibglib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> instance.</p>
<p>When used with <a href="/usr/share/gtk-doc/html/giogio-GConverterInputstream.html#GConverterInputStream-struct"><span class="type">GConverterInputStream</span></a> or <a href="/usr/share/gtk-doc/html/giogio-GConverterOutputstream.html#GConverterOutputStream-struct"><span class="type">GConverterOutputStream</span></a>,
an <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a> can discreetly capture the stream content for the
purpose of caching.</p>
</div>
<div class="refsect1">
<a name="EDataCapture.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-data-capture-new"></a><h3>e_data_capture_new ()</h3>
<pre class="programlisting"><a class="link" href="EDataCapture.html" title="EDataCapture"><span class="returnvalue">EDataCapture</span></a> *
e_data_capture_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *main_context</code></em>);</pre>
<p>Creates a new <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a>.  If <em class="parameter"><code>main_context</code></em>
 is <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the
<span class="type">“finished”</span> signal will be emitted from the thread-default
<a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> for this thread.</p>
<div class="refsect3">
<a name="e-data-capture-new.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>main_context</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>, or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-data-capture-new.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-data-capture-ref-main-context"></a><h3>e_data_capture_ref_main_context ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="returnvalue">GMainContext</span></a> *
e_data_capture_ref_main_context (<em class="parameter"><code><a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a> *data_capture</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> from which the <span class="type">“finished”</span> signal
is emitted.</p>
<p>The returned <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> is referenced for thread-safety and must be
unreferenced with <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#g-main-context-unref"><code class="function">g_main_context_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="e-data-capture-ref-main-context.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>data_capture</p></td>
<td class="parameter_description"><p>an <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-data-capture-ref-main-context.returns"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="EDataCapture.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EDataCapture-struct"></a><h3>struct EDataCapture</h3>
<pre class="programlisting">struct EDataCapture;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
</div>
</div>
<div class="refsect1">
<a name="EDataCapture.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EDataCapture--main-context"></a><h3>The <code class="literal">“main-context”</code> property</h3>
<pre class="programlisting">  “main-context”             <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</pre>
<p>The <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> from which to emit the <a class="link" href="EDataCapture.html#EDataCapture-finished" title="The “finished” signal"><span class="type">“finished”</span></a>
signal.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="EDataCapture.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EDataCapture-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a> *data_capture,
               <a href="/usr/share/gtk-doc/html/glibglib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a>       *data,
               <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)</pre>
<p>The ::finished signal is emitted when there is no more input
data to be captured.</p>
<div class="refsect3">
<a name="EDataCapture-finished.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>data_capture</p></td>
<td class="parameter_description"><p>the <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a> that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>the captured data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>