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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gnomeprint.Config</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-gnomeprintcontext.html" title="gnomeprint.Context"><link rel="next" href="class-gnomeprintjob.html" title="gnomeprint.Job"></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.Config</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gnomeprintcontext.html">Prev</a> </td><th width="60%" align="center">The Gnomeprint Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gnomeprintjob.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gnomeprint.Config"><a name="class-gnomeprintconfig"></a><div class="titlepage"></div><div class="refnamediv"><h2>gnomeprint.Config</h2><p>gnomeprint.Config — Config object for GnomePrint</p></div><div class="refsect1" title="Synopsis"><a name="id2599646"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gnomeprint.Config</span></span>(<span class="ooclass"><span class="classname">gobject.GObject</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#constructor-gnomeprintconfig" title="Constructor">gnomeprint.Config</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--dup" title="gnomeprint.Config.dup">dup</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--get" title="gnomeprint.Config.get">get</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--set" title="gnomeprint.Config.set">set</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--get-boolean" title="gnomeprint.Config.get_boolean">get_boolean</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--get-int" title="gnomeprint.Config.get_int">get_int</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--get-double" title="gnomeprint.Config.get_double">get_double</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--get-length" title="gnomeprint.Config.get_length">get_lenght</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--set-boolean" title="gnomeprint.Config.set_boolean">set_boolean</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--set-int" title="gnomeprint.Config.set_int">set_int</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--set-double" title="gnomeprint.Config.set_double">set_double</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--set-length" title="gnomeprint.Config.set_length">set_lenght</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--dump" title="gnomeprint.Config.dump">dump</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id2604533"></a><h2>Ancestry</h2><pre class="synopsis">+-- gobject.GObject
+-- <a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config">gnomeprint.Config</a>
</pre></div><div class="refsect1" title="Description"><a name="description-gnomeprintconfig"></a><h2>Description</h2><p>
</p></div><div class="refsect1" title="Constructor"><a name="constructor-gnomeprintconfig"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gnomeprint.Config</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></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"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a>.
</td></tr></tbody></table><p>
Creates a new <a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object.
</p></div><div class="refsect1" title="Methods"><a name="id2604670"></a><h2>Methods</h2><div class="refsect2" title="gnomeprint.Config.dup"><a name="method-gnomeprintconfig--dup"></a><h3>gnomeprint.Config.dup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">dup</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 copy of config.</td></tr></tbody></table><p>
The <code class="methodname">dup</code>() method does a deep copy of the config config.
</p></div><div class="refsect2" title="gnomeprint.Config.get"><a name="method-gnomeprintconfig--get"></a><h3>gnomeprint.Config.get</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be obtained.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> the value of the key, <code class="literal">None</code> indicates failure.</td></tr></tbody></table><p>
The <code class="methodname">get</code>() method
</p></div><div class="refsect2" title="gnomeprint.Config.set"><a name="method-gnomeprintconfig--set"></a><h3>gnomeprint.Config.set</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be set.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>value</code></strong> :</span></p></td><td> string containing the value to set.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">set</code>() method sets the value of string key in the GnomePrintConfig object to value value
</p></div><div class="refsect2" title="gnomeprint.Config.get_boolean"><a name="method-gnomeprintconfig--get-boolean"></a><h3>gnomeprint.Config.get_boolean</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_boolean</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be obtained.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> a boolean variable to store the value in. Should initially be <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> if a value was retrieved, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">get_boolean</code>() method gets the value of key key from the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object. Converts values such as "true", "y", "yes", and their
opposites, to their boolean equivalent. The boolean value will be stored in the variable val.
</p></div><div class="refsect2" title="gnomeprint.Config.get_int"><a name="method-gnomeprintconfig--get-int"></a><h3>gnomeprint.Config.get_int</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_int</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be obtained.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> an integer variable to store the value in. Should initially be <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> if a value was retrieved, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">get_int</code>() method gets the value of key key from the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object. Converts values to their integer equivalent. The integer
value will be stored in the variable val.
</p></div><div class="refsect2" title="gnomeprint.Config.get_double"><a name="method-gnomeprintconfig--get-double"></a><h3>gnomeprint.Config.get_double</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_double</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be obtained.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> a double variable to store the value in. Should initially be <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> if a value was retrieved, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">get_double</code>() method gets the value of key key from the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object. Converts values to their double equivalent. The double
value will be stored in the variable val.
</p></div><div class="refsect2" title="gnomeprint.Config.get_length"><a name="method-gnomeprintconfig--get-length"></a><h3>gnomeprint.Config.get_length</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_length</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be obtained.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> a double variable to store the value in. Should initially be <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>unit</code></strong> :</span></p></td><td> pointer to an already allocated GnomePrintUnit struct.<code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> if a value was retrieved, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">get_length</code>() method gets the value of key key from the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object. Converts values to their double equivalent. The double
value will be stored in the variable val and the units will be stored in unit.
</p></div><div class="refsect2" title="gnomeprint.Config.set_boolean"><a name="method-gnomeprintconfig--set-boolean"></a><h3>gnomeprint.Config.set_boolean</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_boolean</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be obtained.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> boolean containing the value to set.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> if a value was retrieved, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">set_boolean</code>() method set a boolean value in the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object.
</p></div><div class="refsect2" title="gnomeprint.Config.set_int"><a name="method-gnomeprintconfig--set-int"></a><h3>gnomeprint.Config.set_int</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_int</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be set.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> integer containing the value to set.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> if a value was retrieved, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">set_int</code>() method set an integer value in the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object.
</p></div><div class="refsect2" title="gnomeprint.Config.set_double"><a name="method-gnomeprintconfig--set-double"></a><h3>gnomeprint.Config.set_double</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_double</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be set.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> integer containing the value to set.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">set_double</code>() method set an integer value in the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a> object.
</p></div><div class="refsect2" title="gnomeprint.Config.set_length"><a name="method-gnomeprintconfig--set-length"></a><h3>gnomeprint.Config.set_length</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_length</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>val</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</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>key</code></strong> :</span></p></td><td> string containing the path of key whose value is to be set.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>val</code></strong> :</span></p></td><td> double containing the value to set.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>unit</code></strong> :</span></p></td><td> units to use when setting value.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure.</td></tr></tbody></table><p>
The <code class="methodname">set_length</code>() method sets a double value and the units it is using. This should be used in conjunction with
<a class="link" href="class-gnomeprintconfig.html#method-gnomeprintconfig--get-length" title="gnomeprint.Config.get_length"><code class="methodname">get_lenght</code></a>
</p></div><div class="refsect2" title="gnomeprint.Config.dump"><a name="method-gnomeprintconfig--dump"></a><h3>gnomeprint.Config.dump</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">dump</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">dump</code>() method print out the tree structure representing the
<a class="link" href="class-gnomeprintconfig.html" title="gnomeprint.Config"><code class="classname">gnomeprint.Config</code></a>. Output is to STDOUT and is limited to a depth of 20.
</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-gnomeprintcontext.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-gnomeprintjob.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gnomeprint.Context </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gnomeprint.Job</td></tr></table></div></body></html>
|
