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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gnomeprint.ui.Dialog</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Python Gnomeprintui Reference Manual"><link rel="up" href="gnomeprintui-class-reference.html" title="The Gnomeprintui Class Reference"><link rel="prev" href="gnomeprintui-class-reference.html" title="The Gnomeprintui Class Reference"><link rel="next" href="class-gnomeprintuifontdialog.html" title="gnomeprint.ui.FontDialog"></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.ui.Dialog</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gnomeprintui-class-reference.html">Prev</a> </td><th width="60%" align="center">The Gnomeprintui Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gnomeprintuifontdialog.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gnomeprint.ui.Dialog"><a name="class-gnomeprintuidialog"></a><div class="titlepage"></div><div class="refnamediv"><h2>gnomeprint.ui.Dialog</h2><p>gnomeprint.ui.Dialog — Dialog object for GnomePrintui</p></div><div class="refsect1" title="Synopsis"><a name="id2566709"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gnomeprint.ui.Dialog</span></span>(<span class="ooclass"><span class="classname">gtk.Dialog</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#constructor-gnomeprintuidialog" title="Constructor">gnomeprint.ui.Dialog</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>job</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--construct-range-any" title="gnomeprint.ui.Dialog.construct_range_any">construct_range_any</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>range_widget</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>currentlabel</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>rangelabel</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--construct-range-custom" title="gnomeprint.ui.Dialog.construct_range_custom">construct_range_custom</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>custom</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--construct-range-page" title="gnomeprint.ui.Dialog.construct_range_page">construct_range_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>currentlabel</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>rangelabel</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--get-config" title="gnomeprint.ui.Dialog.get_config">get_config</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--get-copies" title="gnomeprint.ui.Dialog.get_copies">get_copies</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>copies</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>collate</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--get-range" title="gnomeprint.ui.Dialog.get_range">get_range</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--get-range-page" title="gnomeprint.ui.Dialog.get_range_page">get_range_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--set-copies" title="gnomeprint.ui.Dialog.set_copies">set_copies</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>copies</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>collate</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id2514307"></a><h2>Ancestry</h2><pre class="synopsis">+-- gobject.GObject
+-- gtk.Object
+-- gtk.Widget
+-- gtk.Container
+-- gtk.Bin
+-- gtk.Window
+-- gtk.Dialog
+-- <a class="link" href="class-gnomeprintuidialog.html" title="gnomeprint.ui.Dialog">gnomeprint.ui.Dialog</a>
</pre></div><div class="refsect1" title="Properties"><a name="id2510532"></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">"print-config"</td><td valign="top">Read-Write</td><td valign="top">The printing configuration to be used.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Description"><a name="description-gnomeprintuidialog"></a><h2>Description</h2><p>
</p></div><div class="refsect1" title="Constructor"><a name="constructor-gnomeprintuidialog"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gnomeprint.ui.Dialog</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>job</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</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>job</code></strong> :</span></p></td><td> a <code class="classname">gnomeprint.Job</code>.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>title</code></strong> :</span></p></td><td> title of the window.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td> options for created widget.</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-gnomeprintuidialog.html" title="gnomeprint.ui.Dialog"><code class="classname">gnomeprint.ui.Dialog</code></a>.
</td></tr></tbody></table><p>
Creates a new <a class="link" href="class-gnomeprintuidialog.html" title="gnomeprint.ui.Dialog"><code class="classname">gnomeprint.ui.Dialog</code></a> object, the following options flags
are available: gnomeprint.DIALOG_RANGE: A range widget container will be created. A range widget must be created separately,
using the constructor. gnomeprint.DIALOG_COPIES: A copies widget will be created.
</p></div><div class="refsect1" title="Methods"><a name="id2575693"></a><h2>Methods</h2><div class="refsect2" title="gnomeprint.ui.Dialog.construct_range_any"><a name="method-gnomeprintuidialog--construct-range-any"></a><h3>gnomeprint.ui.Dialog.construct_range_any</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">construct_range_any</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>range_widget</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>currentlabel</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>rangelabel</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>flags</code></strong> :</span></p></td><td> Options flags, which ranges are displayed.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>range_widget</code></strong> :</span></p></td><td> Widget to display for the range option.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>currentlabel</code></strong> :</span></p></td><td> Label to display next to the 'current page' button.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>rangelabel</code></strong> :</span></p></td><td> Label to display next to the 'range' button.</td></tr></tbody></table><p>
The <code class="methodname">construct_range_any</code>() method create a generic range area within the print range dialogue.
The flags field contains a mask of which options you wish displayed: gnomeprint.RANGE_CURRENT: A label currentlabel will
be displayed. gnomeprint.RANGE_ALL: A label "All" will be displayed. gnomeprint.RANGE_RANGE: A label rangelabel will be displayed,
next to the range specification widget range_widget. gnomeprint.RANGE_SELECTION: A label "Selection" will be displayed.
</p></div><div class="refsect2" title="gnomeprint.ui.Dialog.construct_range_custom"><a name="method-gnomeprintuidialog--construct-range-custom"></a><h3>gnomeprint.ui.Dialog.construct_range_custom</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">construct_range_custom</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>custom</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>custom</code></strong> :</span></p></td><td> A widget which will be placed in a "Range" frame in the main display.</td></tr></tbody></table><p>
The <code class="methodname">construct_range_custom</code>() method install a custom range specification widget.
</p></div><div class="refsect2" title="gnomeprint.ui.Dialog.construct_range_page"><a name="method-gnomeprintuidialog--construct-range-page"></a><h3>gnomeprint.ui.Dialog.construct_range_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">construct_range_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>currentlabel</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>rangelabel</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>flags</code></strong> :</span></p></td><td> Options flags, see
<code class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--construct-range-any" title="gnomeprint.ui.Dialog.construct_range_any">construct_range_any</a></code>.
</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>start</code></strong> :</span></p></td><td> First page which may be printed.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end</code></strong> :</span></p></td><td> Last page which may be printed.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>currentlabel</code></strong> :</span></p></td><td> Label text for current option.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>rangelabel</code></strong> :</span></p></td><td> Label text for range option.</td></tr></tbody></table><p>
The <code class="methodname">construct_range_page</code>() method construct a generic page/sheet range area.
</p></div><div class="refsect2" title="gnomeprint.ui.Dialog.get_config"><a name="method-gnomeprintuidialog--get-config"></a><h3>gnomeprint.ui.Dialog.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> the config.</td></tr></tbody></table><p>
The <code class="methodname">get_config</code>() method
</p></div><div class="refsect2" title="gnomeprint.ui.Dialog.get_copies"><a name="method-gnomeprintuidialog--get-copies"></a><h3>gnomeprint.ui.Dialog.get_copies</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_copies</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>copies</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>collate</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>copies</code></strong> :</span></p></td><td> Return for the number of copies.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>collate</code></strong> :</span></p></td><td> Return for collation flag.</td></tr></tbody></table><p>
The <code class="methodname">get_copies</code>() method retrieves the number of copies and collation indicator from the print dialogue.
If the print dialogue does not have a copies indicator, then a default of 1 copy is returned.
</p></div><div class="refsect2" title="gnomeprint.ui.Dialog.get_range"><a name="method-gnomeprintuidialog--get-range"></a><h3>gnomeprint.ui.Dialog.get_range</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_range</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 bitmask with one option set.</td></tr></tbody></table><p>
The <code class="methodname">get_range</code>() method return the range option selected by the user.
This is a bitmask with only 1 bit set, out of:
gnomeprint.RANGE_CURRENT: The current option selected. gnomeprint.RANGE_ALL: The all option selected.
gnomeprint.RANGE_RANGE The range option selected. gnomeprint.RANGE_SELECTION: The selection option selected.
</p></div><div class="refsect2" title="gnomeprint.ui.Dialog.get_range_page"><a name="method-gnomeprintuidialog--get-range-page"></a><h3>gnomeprint.ui.Dialog.get_range_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_range_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end</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>start</code></strong> :</span></p></td><td> Return for the user-specified start page.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end</code></strong> :</span></p></td><td> Return for the user-specified end page.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> A bitmask with the user-selection set. See
<code class="methodname"><a class="link" href="class-gnomeprintuidialog.html#method-gnomeprintuidialog--get-range" title="gnomeprint.ui.Dialog.get_range">get_range</a></code></td></tr></tbody></table><p>
The <code class="methodname">get_range_page</code>() method retrieves the user choice for range type and range,
if the user has requested a range of pages to print.
</p></div><div class="refsect2" title="gnomeprint.ui.Dialog.set_copies"><a name="method-gnomeprintuidialog--set-copies"></a><h3>gnomeprint.ui.Dialog.set_copies</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_copies</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>copies</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>collate</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>copies</code></strong> :</span></p></td><td> New number of copies.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>collate</code></strong> :</span></p></td><td> New collation status.</td></tr></tbody></table><p>
The <code class="methodname">set_copies</code>() method sets the print copies and collation status in the print dialogue.
</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gnomeprintui-class-reference.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gnomeprintui-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gnomeprintuifontdialog.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The Gnomeprintui Class Reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gnomeprint.ui.FontDialog</td></tr></table></div></body></html>
|
