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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gnomeprint.Job</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Python Gnomeprint Reference Manual"><link rel="up" href="gnomeprint-class-reference.html" title="The Gnomeprint Class Reference"><link rel="prev" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><link rel="next" href="class-gnomeprintfont.html" title="gnomeprint.Font"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gnomeprint.Job</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gnomeprintconfig.html">Prev</a> </td><th width="60%" align="center">The Gnomeprint Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gnomeprintfont.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gnomeprint.Job"><a name="class-gnomeprintjob"></a><div class="titlepage"></div><div class="refnamediv"><h2>gnomeprint.Job</h2><p>gnomeprint.Job — Job object for GnomePrint</p></div><div class="refsect1" title="Synopsis"><a name="id2572558"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gnomeprint.Job</span></span>(<span class="ooclass"><span class="classname">gobject.GObject</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gnomeprintjob.html#constructor-gnomeprintjob" title="Constructor">gnomeprint.Job</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>config</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--get-config" title="gnomeprint.Job.get_config">get_config</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--get-context" title="gnomeprint.Job.get_context">get_context</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--close" title="gnomeprint.Job.close">close</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--print" title="gnomeprint.Job.print">print</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--render" title="gnomeprint.Job.render">render</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ctx</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--render-page" title="gnomeprint.Job.render_page">render_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ctx</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pageops</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--get-pages" title="gnomeprint.Job.get_pages">get_pages</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintjob.html#method-gnomeprintjob--print-to-file" title="gnomeprint.Job.print_to_file">print_to_file</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>output</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id2564283"></a><h2>Ancestry</h2><pre class="synopsis">+-- gobject.GObject
+-- <a class="link" href="class-gnomeprintjob.html" title="gnomeprint.Job">gnomeprint.Job</a>
</pre></div><div class="refsect1" title="Properties"><a name="id2564318"></a><h2>Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"config"</td><td valign="top">Read</td><td valign="top">The configuration for the print job.</td></tr><tr valign="top"><td valign="top">"context"</td><td valign="top">Read-Write</td><td valign="top">The context for the print job.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Description"><a name="description-gnomeprintjob"></a><h2>Description</h2><p>
</p></div><div class="refsect1" title="Constructor"><a name="constructor-gnomeprintjob"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gnomeprint.Job</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>config</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>config</code></strong> :</span></p></td><td> a <a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></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="class-gnomeprintjob.html" title="gnomeprint.Job"><code class="classname">gnomeprint.Job</code></a>.
</td></tr></tbody></table><p>
Creates a new <a class="link" href="class-gnomeprintjob.html" title="gnomeprint.Job"><code class="classname">gnomeprint.Job</code></a> object.
</p></div><div class="refsect1" title="Methods"><a name="id2569084"></a><h2>Methods</h2><div class="refsect2" title="gnomeprint.Job.get_config"><a name="method-gnomeprintjob--get-config"></a><h3>gnomeprint.Job.get_config</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_config</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> a referenced <a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> for this job,
<code class="literal">None</code> on error.</td></tr></tbody></table><p>
The <code class="methodname">get_config</code>() method gets a reference to the configuration of the job.
</p></div><div class="refsect2" title="gnomeprint.Job.get_context"><a name="method-gnomeprintjob--get-context"></a><h3>gnomeprint.Job.get_context</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_context</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> the printing context, <code class="literal">None</code> on error.</td></tr></tbody></table><p>
The <code class="methodname">get_context</code>() method retrieve the <a class="link" href="class-gnomeprintcontext.html" title="gnomeprint.Context"><code class="classname">gnomeprint.Context</code></a>
which applications print to.
</p></div><div class="refsect2" title="gnomeprint.Job.close"><a name="method-gnomeprintjob--close"></a><h3>gnomeprint.Job.close</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">close</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">close</code>() method closes the <a class="link" href="class-gnomeprintjob.html" title="gnomeprint.Job"><code class="classname">gnomeprint.Job</code></a> job, ready for
printing or previewing. To be called after the application has finished sending the drawing commands.
</p></div><div class="refsect2" title="gnomeprint.Job.print"><a name="method-gnomeprintjob--print"></a><h3>gnomeprint.Job.print</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">print</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> GNOME_PRINT_OK on success GNOME_PRINT_ERROR_UNKNOWN otherwise.</td></tr></tbody></table><p>
The <code class="methodname">print</code>() method print the pages stored in the
<a class="link" href="class-gnomeprintjob.html" title="gnomeprint.Job"><code class="classname">gnomeprint.Job</code></a> to the phyisical printing device.
</p></div><div class="refsect2" title="gnomeprint.Job.render"><a name="method-gnomeprintjob--render"></a><h3>gnomeprint.Job.render</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">render</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ctx</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>ctx</code></strong> :</span></p></td><td> a <a class="link" href="class-gnomeprintcontext.html" title="gnomeprint.Context"><code class="classname">gnomeprint.Context</code></a>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> </td></tr></tbody></table><p>
The <code class="methodname">render</code>() renders printout to specified context (with layout, ignoring copies).
</p></div><div class="refsect2" title="gnomeprint.Job.render_page"><a name="method-gnomeprintjob--render-page"></a><h3>gnomeprint.Job.render_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">render_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ctx</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pageops</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>ctx</code></strong> :</span></p></td><td> a <a class="link" href="class-gnomeprintcontext.html" title="gnomeprint.Context"><code class="classname">gnomeprint.Context</code></a>.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page</code></strong> :</span></p></td><td> the page number to print.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>pageops</code></strong> :</span></p></td><td> </td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> </td></tr></tbody></table><p>
The <code class="methodname">render_page</code>() method renders the specified page <em class="parameter"><code>page</code></em>.
</p></div><div class="refsect2" title="gnomeprint.Job.get_pages"><a name="method-gnomeprintjob--get-pages"></a><h3>gnomeprint.Job.get_pages</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pages</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> the number of pages, 0 on error.</td></tr></tbody></table><p>
The <code class="methodname">get_double</code>() method find the number of pages stored in a completed printout. This is the number of physical pages, so if
the layout can hold 4 pages per page, and 5 logical pages are printed (5 beginpage/endpage convinations) 2 is returned
</p></div><div class="refsect2" title="gnomeprint.Job.print_to_file"><a name="method-gnomeprintjob--print-to-file"></a><h3>gnomeprint.Job.print_to_file</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">print_to_file</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>output</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>output</code></strong> :</span></p></td><td> filename.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> </td></tr></tbody></table><p>
The <code class="methodname">print_to_file</code>() method prints the output to <em class="parameter"><code>filename</code></em>.
</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gnomeprintconfig.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gnomeprint-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gnomeprintfont.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gnomeprint.Config </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gnomeprint.Font</td></tr></table></div></body></html>
|
