/usr/share/gtk-doc/html/gnome-scan-1.0/GnomeScanJob.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeScanJob</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="setup.html" title="Using Gnome Scan">
<link rel="prev" href="GnomeScanDialog.html" title="GnomeScanDialog">
<link rel="next" href="GnomeScanSettings.html" title="GnomeScanSettings">
<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="GnomeScanDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="setup.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="GnomeScanSettings.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="#GnomeScanJob.synopsis" class="shortcut">Top</a>
|
<a href="#GnomeScanJob.description" class="shortcut">Description</a>
|
<a href="#GnomeScanJob.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GnomeScanJob.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeScanJob"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomeScanJob.top_of_page"></a>GnomeScanJob</span></h2>
<p>GnomeScanJob — Handling acquisition, processing and outputting</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomeScanJob.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gnome-scan.h>
<a class="link" href="GnomeScanJob.html#GnomeScanJob-struct" title="GnomeScanJob">GnomeScanJob</a>;
<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a>* <a class="link" href="GnomeScanJob.html#gnome-scan-job-new" title="gnome_scan_job_new ()">gnome_scan_job_new</a> (<a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a> *settings,
<a class="link" href="GnomeScanSink.html" title="GnomeScanSink">GnomeScanSink</a> *sink);
void <a class="link" href="GnomeScanJob.html#gnome-scan-job-set-settings" title="gnome_scan_job_set_settings ()">gnome_scan_job_set_settings</a> (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job,
<a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a> *settings);
<a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a>* <a class="link" href="GnomeScanJob.html#gnome-scan-job-get-settings" title="gnome_scan_job_get_settings ()">gnome_scan_job_get_settings</a> (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job);
void <a class="link" href="GnomeScanJob.html#gnome-scan-job-add-processor" title="gnome_scan_job_add_processor ()">gnome_scan_job_add_processor</a> (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job,
<a class="link" href="GnomeScanPlugin.html" title="GnomeScanPlugin">GnomeScanPlugin</a> *processor);
void <a class="link" href="GnomeScanJob.html#gnome-scan-job-set-sink" title="gnome_scan_job_set_sink ()">gnome_scan_job_set_sink</a> (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job,
<a class="link" href="GnomeScanSink.html" title="GnomeScanSink">GnomeScanSink</a> *sink);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanJob.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>
+----GnomeScanJob
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanJob.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GnomeScanJob.html#GnomeScanJob--scanner" title='The "scanner" property'>scanner</a>" <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a>* : Read / Write
"<a class="link" href="GnomeScanJob.html#GnomeScanJob--settings" title='The "settings" property'>settings</a>" <a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a>* : Read / Write
"<a class="link" href="GnomeScanJob.html#GnomeScanJob--sink" title='The "sink" property'>sink</a>" <a class="link" href="GnomeScanSink.html" title="GnomeScanSink">GnomeScanSink</a>* : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanJob.description"></a><h2>Description</h2>
<p>
In Gnome Scan, the job of scanning is divided in three parts :
acquiring, processing and outputting. The first stage is handled by
<a class="link" href="GnomeScanner.html" title="GnomeScanner"><span class="type">GnomeScanner</span></a> plugin. The second is handled using
<span class="type">GeglOperation</span>. The latter is handled by <a class="link" href="GnomeScanSink.html" title="GnomeScanSink"><span class="type">GnomeScanSink</span></a> plugin.
</p>
<p>
The purpose of GnomeScanJob is to marshal the configuration and
execution of these three part, allowing to easily delegate job
execution in a worker thread.</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanJob.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GnomeScanJob-struct"></a><h3>GnomeScanJob</h3>
<pre class="programlisting">typedef struct {
gdouble progress;
gchar* stage;
gboolean done;
} GnomeScanJob;
</pre>
<p>
A <a class="link" href="GnomeScanJob.html" title="GnomeScanJob"><span class="type">GnomeScanJob</span></a> object handle the acquisition, processing and
outputing of images. Use <code class="function">gnome_scan_job_run()</code> to execute the
job. During its execution, the job will fill <em class="parameter"><code>progress</code></em> and <em class="parameter"><code>stage</code></em>
in order you to know what he is doing. This way, the main thread
can know what the worker thread is doing.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <em class="structfield"><code>progress</code></em>;</span></p></td>
<td> a fraction indicating the progress of the execution
(from 0 to 1)
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>stage</code></em>;</span></p></td>
<td> a description of the current stage being executed.
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <em class="structfield"><code>done</code></em>;</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-job-new"></a><h3>gnome_scan_job_new ()</h3>
<pre class="programlisting"><a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a>* gnome_scan_job_new (<a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a> *settings,
<a class="link" href="GnomeScanSink.html" title="GnomeScanSink">GnomeScanSink</a> *sink);</pre>
<p>
Instanciate a new job. If <em class="parameter"><code>settings</code></em> is null, a new
<a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings"><span class="type">GnomeScanSettings</span></a> is created.</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>settings</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings"><span class="type">GnomeScanSettings</span></a> or NULL
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
<td> the <a class="link" href="GnomeScanSink.html" title="GnomeScanSink"><span class="type">GnomeScanSink</span></a>
</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="GnomeScanJob.html" title="GnomeScanJob"><span class="type">GnomeScanJob</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-job-set-settings"></a><h3>gnome_scan_job_set_settings ()</h3>
<pre class="programlisting">void gnome_scan_job_set_settings (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job,
<a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a> *settings);</pre>
<p>
Set the settings for this job.</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>job</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanJob.html" title="GnomeScanJob"><span class="type">GnomeScanJob</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings"><span class="type">GnomeScanSettings</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-job-get-settings"></a><h3>gnome_scan_job_get_settings ()</h3>
<pre class="programlisting"><a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a>* gnome_scan_job_get_settings (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job);</pre>
<p>
Retrieve the settings used by the job.</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>job</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanJob.html" title="GnomeScanJob"><span class="type">GnomeScanJob</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <em class="parameter"><code>job</code></em> <a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings"><span class="type">GnomeScanSettings</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-job-add-processor"></a><h3>gnome_scan_job_add_processor ()</h3>
<pre class="programlisting">void gnome_scan_job_add_processor (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job,
<a class="link" href="GnomeScanPlugin.html" title="GnomeScanPlugin">GnomeScanPlugin</a> *processor);</pre>
<p>
Add <em class="parameter"><code>processor</code></em> as plugin for building the pipeline.</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>job</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanJob.html" title="GnomeScanJob"><span class="type">GnomeScanJob</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>processor</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanPlugin.html" title="GnomeScanPlugin"><span class="type">GnomeScanPlugin</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-job-set-sink"></a><h3>gnome_scan_job_set_sink ()</h3>
<pre class="programlisting">void gnome_scan_job_set_sink (<a class="link" href="GnomeScanJob.html" title="GnomeScanJob">GnomeScanJob</a> *job,
<a class="link" href="GnomeScanSink.html" title="GnomeScanSink">GnomeScanSink</a> *sink);</pre>
<p>
Set the scan sink.</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>job</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanJob.html" title="GnomeScanJob"><span class="type">GnomeScanJob</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
<td> a <a class="link" href="GnomeScanSink.html" title="GnomeScanSink"><span class="type">GnomeScanSink</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanJob.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GnomeScanJob--scanner"></a><h3>The <code class="literal">"scanner"</code> property</h3>
<pre class="programlisting"> "scanner" <a class="link" href="GnomeScanner.html" title="GnomeScanner">GnomeScanner</a>* : Read / Write</pre>
<p>
The <a class="link" href="GnomeScanner.html" title="GnomeScanner"><span class="type">GnomeScanner</span></a> responsible of image acquisition.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GnomeScanJob--settings"></a><h3>The <code class="literal">"settings"</code> property</h3>
<pre class="programlisting"> "settings" <a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings">GnomeScanSettings</a>* : Read / Write</pre>
<p>
The <a class="link" href="GnomeScanSettings.html" title="GnomeScanSettings"><span class="type">GnomeScanSettings</span></a> object containing all user settings for
plugins.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GnomeScanJob--sink"></a><h3>The <code class="literal">"sink"</code> property</h3>
<pre class="programlisting"> "sink" <a class="link" href="GnomeScanSink.html" title="GnomeScanSink">GnomeScanSink</a>* : Read / Write</pre>
<p>
The sink responsible to output acquired images.</p>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|