/usr/share/gtk-doc/html/evolution-util/EDataCapture.html is in evolution-dev 3.10.4-0ubuntu1.
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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch15.html" title="(Unsorted Sections)">
<link rel="prev" href="EContactStore.html" title="EContactStore">
<link rel="next" href="evolution-util-EDateEdit.html" title="EDateEdit">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="EContactStore.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch15.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution Utilities Reference Manual</th>
<td><a accesskey="n" href="evolution-util-EDateEdit.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EDataCapture.synopsis" class="shortcut">Top</a>
|
<a href="#EDataCapture.description" class="shortcut">Description</a>
|
<a href="#EDataCapture.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EDataCapture.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EDataCapture.properties" class="shortcut">Properties</a>
|
<a href="#EDataCapture.signals" class="shortcut">Signals</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EDataCapture.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <e-util/e-util.h>
struct <a class="link" href="EDataCapture.html#EDataCapture-struct" title="struct EDataCapture">EDataCapture</a>;
<a class="link" href="EDataCapture.html" title="EDataCapture"><span class="returnvalue">EDataCapture</span></a> * <a class="link" href="EDataCapture.html#e-data-capture-new" title="e_data_capture_new ()">e_data_capture_new</a> (<em class="parameter"><code><span class="type">GMainContext</span> *main_context</code></em>);
<span class="returnvalue">GMainContext</span> * <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> (<em class="parameter"><code><a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a> *data_capture</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EDataCapture.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----EDataCapture
</pre>
</div>
<div class="refsect1">
<a name="EDataCapture.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EDataCapture implements
GConverter.</p>
</div>
<div class="refsect1">
<a name="EDataCapture.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EDataCapture.html#EDataCapture--main-context" title='The "main-context" property'>main-context</a>" <span class="type">GMainContext</span>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="EDataCapture.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EDataCapture.html#EDataCapture-finished" title='The "finished" signal'>finished</a>" : <code class="literal">Run First</code>
</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 <span class="type">GConverter</span> 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 <span class="type">GBytes</span> instance.
</p>
<p>
When used with <span class="type">GConverterInputStream</span> or <span class="type">GConverterOutputStream</span>,
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.details"></a><h2>Details</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>
<hr>
<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><span class="type">GMainContext</span> *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 <code class="literal">NULL</code>, then the
<span class="type">"finished"</span> signal will be emitted from the thread-default
<span class="type">GMainContext</span> for this thread.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>main_context</code></em> :</span></p></td>
<td>a <span class="type">GMainContext</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a>
</td>
</tr>
</tbody>
</table></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"><span class="returnvalue">GMainContext</span> * 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 <span class="type">GMainContext</span> from which the <span class="type">"finished"</span> signal
is emitted.
</p>
<p>
The returned <span class="type">GMainContext</span> is referenced for thread-safety and must be
unreferenced with <code class="function">g_main_context_unref()</code> when finished with it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_capture</code></em> :</span></p></td>
<td>an <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">GMainContext</span>
</td>
</tr>
</tbody>
</table></div>
</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" <span class="type">GMainContext</span>* : Read / Write / Construct Only</pre>
<p>
The <span class="type">GMainContext</span> 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>
</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,
<span class="type">GBytes</span> *data,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
The ::finished signal is emitted when there is no more input
data to be captured.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_capture</code></em> :</span></p></td>
<td>the <a class="link" href="EDataCapture.html" title="EDataCapture"><span class="type">EDataCapture</span></a> that received the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>the captured data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|