libgnomescan-dev 0.6.2-1.1ubuntu4 / usr / share / gtk-doc / html / gnome-scan-1.0 / GnomeScanBackend.html

This file is indexed.

/usr/share/gtk-doc/html/gnome-scan-1.0/GnomeScanBackend.html is in libgnomescan-dev 0.6.2-1.1ubuntu4.

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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeScanBackend</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Gnome Scan Reference Manual">
<link rel="up" href="backend.html" title="Writing Backend">
<link rel="prev" href="GnomeScanModule.html" title="GnomeScanModule">
<link rel="next" href="GnomeScanner.html" title="GnomeScanner">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="core.html" title="Part I. Gnome Scan Core Reference">
<link rel="chapter" href="setup.html" title="Using Gnome Scan">
<link rel="chapter" href="extends.html" title="Extending For Application">
<link rel="part" href="internals.html" title="Part II. Gnome Scan Internals">
<link rel="chapter" href="backend.html" title="Writing Backend">
<link rel="index" href="symbols.html" title="Index">
<link rel="index" href="hierarchy.html" title="Object Hierarchy">
<link rel="index" href="gallery.html" title="Widget Gallery">
</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="GnomeScanModule.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="backend.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">Gnome Scan Reference Manual</th>
<td><a accesskey="n" href="GnomeScanner.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GnomeScanBackend.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GnomeScanBackend.description" class="shortcut">Description</a>
                   | 
                  <a href="#GnomeScanBackend.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GnomeScanBackend.signals" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeScanBackend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomeScanBackend.top_of_page"></a>GnomeScanBackend</span></h2>
<p>GnomeScanBackend — Probe scanners</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomeScanBackend.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="GnomeScanBackend.html#GnomeScanBackend-struct" title="GnomeScanBackend">GnomeScanBackend</a>;
<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a>*   <a class="link" href="GnomeScanBackend.html#gnome-scan-backend-new" title="gnome_scan_backend_new ()">gnome_scan_backend_new</a>              (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> backend_type);
void                <a class="link" href="GnomeScanBackend.html#gnome-scan-backend-probe-scanners" title="gnome_scan_backend_probe_scanners ()">gnome_scan_backend_probe_scanners</a>   (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend);
void                <a class="link" href="GnomeScanBackend.html#gnome-scan-backend-add-scanner" title="gnome_scan_backend_add_scanner ()">gnome_scan_backend_add_scanner</a>      (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend,
                                                         <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a> *scanner);
void                <a class="link" href="GnomeScanBackend.html#gnome-scan-backend-remove-scanner" title="gnome_scan_backend_remove_scanner ()">gnome_scan_backend_remove_scanner</a>   (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend,
                                                         <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a> *scanner);
void                <a class="link" href="GnomeScanBackend.html#gnome-scan-backend-probe-done" title="gnome_scan_backend_probe_done ()">gnome_scan_backend_probe_done</a>       (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----GnomeScanBackend
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanBackend.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GnomeScanBackend.html#GnomeScanBackend-probe-done" title='The "probe-done" signal'>probe-done</a>"                                     : Run Last
  "<a class="link" href="GnomeScanBackend.html#GnomeScanBackend-scanner-added" title='The "scanner-added" signal'>scanner-added</a>"                                  : Run Last
  "<a class="link" href="GnomeScanBackend.html#GnomeScanBackend-scanner-removed" title='The "scanner-removed" signal'>scanner-removed</a>"                                : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanBackend.description"></a><h2>Description</h2>
<p>
In Gnome Scan, the so called "backend" is only responsible to probe
devices. In fact, the scanner is only responsible to detect scanner
plug and unplug and trigger signal about that. Probing is just a
way to add already plugged scanner just like adding a hotplugged
scanner.
</p>
<p>
The backend itseld does not maintain a public list of scanner, it's
up to the UI to maintain a list of scanner (e.g. through a
<a
href="/usr/share/gtk-doc/html/gtk/GtkListStore.html"
><span class="type">GtkListStore</span></a>).
</p>
<p>
<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a> is the base class for real backend. If you want
to instanciate all backends, just initialize all <span class="type">GnomeScanModules</span>
and instanciate each <a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-children"
><code class="function">g_type_children()</code></a> of <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>.</p>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanBackend.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GnomeScanBackend-struct"></a><h3>GnomeScanBackend</h3>
<pre class="programlisting">typedef struct _GnomeScanBackend GnomeScanBackend;</pre>
<p>
The <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a> is only responsible to probe scanners,
emitting signal on scanner plug or unplug. Ideally, most of the
acquisition work is done through <a class="link" href="GnomeScanner.html" title="GnomeScanner"><span class="type">GnomeScanner</span></a>.</p>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-backend-new"></a><h3>gnome_scan_backend_new ()</h3>
<pre class="programlisting"><a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a>*   gnome_scan_backend_new              (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> backend_type);</pre>
<p>
Instanciate a new backend of type <em class="parameter"><code>type</code></em>. It check wether <em class="parameter"><code>type</code></em> is a
child type of <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend_type</code></em> :</span></p></td>
<td> the top level backend GType
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-backend-probe-scanners"></a><h3>gnome_scan_backend_probe_scanners ()</h3>
<pre class="programlisting">void                gnome_scan_backend_probe_scanners   (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend);</pre>
<p>
Trigger probe. Ideally called in a new thread through <a
href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-thread-create"
><code class="function">g_thread_create()</code></a>.
</p>
<p>
See: <a
href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-thread-create"
><code class="function">g_thread_create()</code></a></p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-backend-add-scanner"></a><h3>gnome_scan_backend_add_scanner ()</h3>
<pre class="programlisting">void                gnome_scan_backend_add_scanner      (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend,
                                                         <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a> *scanner);</pre>
<p>
This function is used by child class to trigger
<a class="link" href="GnomeScanBackend.html#GnomeScanBackend-scanner-added" title='The "scanner-added" signal'><span class="type">"scanner-added"</span></a> signal.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scanner</code></em> :</span></p></td>
<td> a new <a class="link" href="GnomeScanner.html" title="GnomeScanner"><span class="type">GnomeScanner</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-backend-remove-scanner"></a><h3>gnome_scan_backend_remove_scanner ()</h3>
<pre class="programlisting">void                gnome_scan_backend_remove_scanner   (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend,
                                                         <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a> *scanner);</pre>
<p>
Trigger <a class="link" href="GnomeScanBackend.html#GnomeScanBackend-scanner-removed" title='The "scanner-removed" signal'><span class="type">"scanner-removed"</span></a> upon <em class="parameter"><code>scanner</code></em>. This
function is to be used only by child class.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scanner</code></em> :</span></p></td>
<td> a deprecated <a class="link" href="GnomeScanner.html" title="GnomeScanner"><span class="type">GnomeScanner</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-backend-probe-done"></a><h3>gnome_scan_backend_probe_done ()</h3>
<pre class="programlisting">void                gnome_scan_backend_probe_done       (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend);</pre>
<p>
Trigger <a class="link" href="GnomeScanBackend.html#GnomeScanBackend-probe-done" title='The "probe-done" signal'><span class="type">"probe-done"</span></a> signal. Used by child class.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanBackend.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="GnomeScanBackend-probe-done"></a><h3>The <code class="literal">"probe-done"</code> signal</h3>
<pre class="programlisting">void                user_function                      (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend,
                                                        <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a>          user_data)      : Run Last</pre>
<p>
This signal allow app to know if the backend has found a
scanner during probe. If the <a class="link" href="GnomeScanBackend.html#GnomeScanBackend-probe-done" title='The "probe-done" signal'><span class="type">"probe-done"</span></a>
signal is emitted and no <a class="link" href="GnomeScanBackend.html#GnomeScanBackend-scanner-added" title='The "scanner-added" signal'><span class="type">"scanner-added"</span></a>
signal has been sent, this mean that no scanner has been found
at all. Remember the backend does not handle a list of
<a class="link" href="GnomeScanner.html" title="GnomeScanner"><span class="type">GnomeScanner</span></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> the emitting <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>
</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>
<hr>
<div class="refsect2" lang="en">
<a name="GnomeScanBackend-scanner-added"></a><h3>The <code class="literal">"scanner-added"</code> signal</h3>
<pre class="programlisting">void                user_function                      (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend,
                                                        <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a>     *scanner,
                                                        <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a>          user_data)      : Run Last</pre>
<p>
This backend is triggered each time it discover a new scanner
during probe or on plug.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> the emitting <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scanner</code></em> :</span></p></td>
<td> the newly added <a class="link" href="GnomeScanner.html" title="GnomeScanner"><span class="type">GnomeScanner</span></a>
</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>
<hr>
<div class="refsect2" lang="en">
<a name="GnomeScanBackend-scanner-removed"></a><h3>The <code class="literal">"scanner-removed"</code> signal</h3>
<pre class="programlisting">void                user_function                      (<a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend">GnomeScanBackend</a> *backend,
                                                        <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a>     *scanner,
                                                        <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a>          user_data)      : Run First</pre>
<p>
This signal is emitted as a scanner is lost. Every reference to
this scanner must be removed.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> the emitting <a class="link" href="GnomeScanBackend.html" title="GnomeScanBackend"><span class="type">GnomeScanBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scanner</code></em> :</span></p></td>
<td> the scanner removed
</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.10</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.