1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.PrintOperation</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkprintcontext.html" title="gtk.PrintContext"><link rel="next" href="class-gtkprintoperationpreview.html" title="gtk.PrintOperationPreview"></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">gtk.PrintOperation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkprintcontext.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkprintoperationpreview.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkprintoperation"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.PrintOperation</h2><p>gtk.PrintOperation — a high-level printing API (new in PyGTK 2.10)</p></div><div class="refsect1" lang="en"><a name="id3594174"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.PrintOperation</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>, <span class="ooclass"><span class="classname"><a class="link" href="class-gtkprintoperationpreview.html" title="gtk.PrintOperationPreview">gtk.PrintOperationPreview</a></span></span>):
2
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkprintoperation.html#constructor-gtkprintoperation" title="gtk.PrintOperation">gtk.PrintOperation</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-default-page-setup" title="gtk.PrintOperation.set_default_page_setup">set_default_page_setup</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>default_page_setup</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-default-page-setup" title="gtk.PrintOperation.get_default_page_setup">get_default_page_setup</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-print-settings" title="gtk.PrintOperation.set_print_settings">set_print_settings</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>print_settings</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-print-settings" title="gtk.PrintOperation.get_print_settings">get_print_settings</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-job-name" title="gtk.PrintOperation.set_job_name">set_job_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>job_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-n-pages" title="gtk.PrintOperation.set_n_pages">set_n_pages</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>n_pages</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-current-page" title="gtk.PrintOperation.set_current_page">set_current_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>current_page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-use-full-page" title="gtk.PrintOperation.set_use_full_page">set_use_full_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>full_page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-unit" title="gtk.PrintOperation.set_unit">set_unit</a></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-gtkprintoperation.html#method-gtkprintoperation--set-export-filename" title="gtk.PrintOperation.set_export_filename">set_export_filename</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-track-print-status" title="gtk.PrintOperation.set_track_print_status">set_track_print_status</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>track_status</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-show-progress" title="gtk.PrintOperation.set_show_progress">set_show_progress</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>show_progress</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-allow-async" title="gtk.PrintOperation.set_allow_async">set_allow_async</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>allow_async</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-custom-tab-label" title="gtk.PrintOperation.set_custom_tab_label">set_custom_tab_label</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--run" title="gtk.PrintOperation.run">run</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>action</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>parent</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-error" title="gtk.PrintOperation.get_error">get_error</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-status" title="gtk.PrintOperation.get_status">get_status</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-status-string" title="gtk.PrintOperation.get_status_string">get_status_string</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--is-finished" title="gtk.PrintOperation.is_finished">is_finished</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--cancel" title="gtk.PrintOperation.cancel">cancel</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3594756"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.PrintOperation</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkprintcontext.html" title="gtk.PrintContext"><link rel="next" href="class-gtkprintoperationpreview.html" title="gtk.PrintOperationPreview"></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">gtk.PrintOperation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkprintcontext.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkprintoperationpreview.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkprintoperation"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.PrintOperation</h2><p>gtk.PrintOperation — a high-level printing API (new in PyGTK 2.10)</p></div><div class="refsect1" lang="en"><a name="id3794980"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.PrintOperation</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>, <span class="ooclass"><span class="classname"><a class="link" href="class-gtkprintoperationpreview.html" title="gtk.PrintOperationPreview">gtk.PrintOperationPreview</a></span></span>):
2
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkprintoperation.html#constructor-gtkprintoperation" title="gtk.PrintOperation">gtk.PrintOperation</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-default-page-setup" title="gtk.PrintOperation.set_default_page_setup">set_default_page_setup</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>default_page_setup</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-default-page-setup" title="gtk.PrintOperation.get_default_page_setup">get_default_page_setup</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-print-settings" title="gtk.PrintOperation.set_print_settings">set_print_settings</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>print_settings</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-print-settings" title="gtk.PrintOperation.get_print_settings">get_print_settings</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-job-name" title="gtk.PrintOperation.set_job_name">set_job_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>job_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-n-pages" title="gtk.PrintOperation.set_n_pages">set_n_pages</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>n_pages</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-current-page" title="gtk.PrintOperation.set_current_page">set_current_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>current_page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-use-full-page" title="gtk.PrintOperation.set_use_full_page">set_use_full_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>full_page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-unit" title="gtk.PrintOperation.set_unit">set_unit</a></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-gtkprintoperation.html#method-gtkprintoperation--set-export-filename" title="gtk.PrintOperation.set_export_filename">set_export_filename</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-track-print-status" title="gtk.PrintOperation.set_track_print_status">set_track_print_status</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>track_status</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-show-progress" title="gtk.PrintOperation.set_show_progress">set_show_progress</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>show_progress</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-allow-async" title="gtk.PrintOperation.set_allow_async">set_allow_async</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>allow_async</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--set-custom-tab-label" title="gtk.PrintOperation.set_custom_tab_label">set_custom_tab_label</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--run" title="gtk.PrintOperation.run">run</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>action</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>parent</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-error" title="gtk.PrintOperation.get_error">get_error</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-status" title="gtk.PrintOperation.get_status">get_status</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--get-status-string" title="gtk.PrintOperation.get_status_string">get_status_string</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--is-finished" title="gtk.PrintOperation.is_finished">is_finished</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--cancel" title="gtk.PrintOperation.cancel">cancel</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3795562"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3
3
+-- <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation">gtk.PrintOperation</a> (implements <a class="link" href="class-gtkprintoperationpreview.html" title="gtk.PrintOperationPreview">gtk.PrintOperationPreview</a>)
4
4
</pre></div><div class="refsect1" lang="en"><a name="properties-gtkprintoperation"></a><h2>gtk.PrintOperation 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><col><col></colgroup><tbody><tr valign="top"><td valign="top">"allow-async"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code> the print operation may run
5
5
asynchronously or not. Some systems don't support asynchronous
62
62
and the number of pages per sheet). Otherwise, the origin is at
63
63
the top left corner of the imageable area (i.e. inside the
64
64
margins). This property is available in GTK+ 2.10 and
65
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkprintoperation"></a><h2>gtk.PrintOperation Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkprintoperationpreview.html#signal-prototypes-gtkprintoperationpreview" title="gtk.PrintOperationPreview Signal Prototypes">gtk.PrintOperationPreview Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--begin-print" title='The "begin-print" gtk.PrintOperation Signal'>begin-print</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--create-custom-widget" title='The "create-custom-widget" gtk.PrintOperation Signal'>create-custom-widget</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--custom-widget-apply" title='The "custom-widget-apply" gtk.PrintOperation Signal'>custom-widget-apply</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--done" title='The "done" gtk.PrintOperation Signal'>done</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>result</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--draw-page" title='The "draw-page" gtk.PrintOperation Signal'>draw-page</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_nr</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--end-print" title='The "end-print" gtk.PrintOperation Signal'>end-print</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--paginate" title='The "paginate" gtk.PrintOperation Signal'>paginate</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>printoperation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--preview" title='The "preview" gtk.PrintOperation Signal'>preview</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>preview</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>parent</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--request-page-setup" title='The "request-page-setup" gtk.PrintOperation Signal'>request-page-setup</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_nr</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>setup</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--status-changed" title='The "status-changed" gtk.PrintOperation Signal'>status-changed</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>printoperation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3596064"></a><h2>Description</h2><p><a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a>
65
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkprintoperation"></a><h2>gtk.PrintOperation Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkprintoperationpreview.html#signal-prototypes-gtkprintoperationpreview" title="gtk.PrintOperationPreview Signal Prototypes">gtk.PrintOperationPreview Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--begin-print" title='The "begin-print" gtk.PrintOperation Signal'>begin-print</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--create-custom-widget" title='The "create-custom-widget" gtk.PrintOperation Signal'>create-custom-widget</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--custom-widget-apply" title='The "custom-widget-apply" gtk.PrintOperation Signal'>custom-widget-apply</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--done" title='The "done" gtk.PrintOperation Signal'>done</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>result</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--draw-page" title='The "draw-page" gtk.PrintOperation Signal'>draw-page</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_nr</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--end-print" title='The "end-print" gtk.PrintOperation Signal'>end-print</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--paginate" title='The "paginate" gtk.PrintOperation Signal'>paginate</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>printoperation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--preview" title='The "preview" gtk.PrintOperation Signal'>preview</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>preview</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>parent</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--request-page-setup" title='The "request-page-setup" gtk.PrintOperation Signal'>request-page-setup</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_nr</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>setup</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkprintoperation.html#signal-gtkprintoperation--status-changed" title='The "status-changed" gtk.PrintOperation Signal'>status-changed</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>printoperation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3796870"></a><h2>Description</h2><p><a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a>
66
66
is the high-level, portable printing API. It looks a bit different than
67
67
other GTK+ dialogs such as the <a class="link" href="class-gtkfilechooser.html" title="gtk.FileChooser"><code class="classname">gtk.FileChooser</code></a>,
68
68
since some platforms don't expose enough infrastructure to implement a
80
80
emitted on the <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a>,
81
81
the main one being "draw-page", which you are supposed to catch and
82
82
render the page on the provided <a class="link" href="class-gtkprintcontext.html" title="gtk.PrintContext"><code class="classname">gtk.PrintContext</code></a>
83
using Cairo.</p><div class="example"><a name="id3596170"></a><p class="title"><b>Example 3. The high-level printing API</b></p><div class="example-contents"><pre class="programlisting">
83
using Cairo.</p><div class="example"><a name="id3796976"></a><p class="title"><b>Example 3. The high-level printing API</b></p><div class="example-contents"><pre class="programlisting">
97
97
if res == gtk.PRINT_OPERATION_RESULT_APPLY:
98
98
settings = print_op.get_print_settings()
99
</pre></div></div><br class="example-break"><p>Printing support was added in GTK+ 2.10.</p></div><div class="refsect1" lang="en"><a name="id3596196"></a><h2>Constructor</h2><div class="refsect2" lang="en"><a name="constructor-gtkprintoperation"></a><h3>gtk.PrintOperation</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.PrintOperation</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 new <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.10 and above.</p></div><p>Creates a new <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a>.</p></div></div><div class="refsect1" lang="en"><a name="id3596280"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkprintoperation--set-default-page-setup"></a><h3>gtk.PrintOperation.set_default_page_setup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_default_page_setup</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>default_page_setup</code></strong></span><span class="initializer">=None</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>default_page_setup</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkpagesetup.html" title="gtk.PageSetup"><code class="classname">gtk.PageSetup</code></a>,
99
</pre></div></div><br class="example-break"><p>Printing support was added in GTK+ 2.10.</p></div><div class="refsect1" lang="en"><a name="id3797002"></a><h2>Constructor</h2><div class="refsect2" lang="en"><a name="constructor-gtkprintoperation"></a><h3>gtk.PrintOperation</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.PrintOperation</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 new <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.10 and above.</p></div><p>Creates a new <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a>.</p></div></div><div class="refsect1" lang="en"><a name="id3797086"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkprintoperation--set-default-page-setup"></a><h3>gtk.PrintOperation.set_default_page_setup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_default_page_setup</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>default_page_setup</code></strong></span><span class="initializer">=None</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>default_page_setup</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkpagesetup.html" title="gtk.PageSetup"><code class="classname">gtk.PageSetup</code></a>,
100
100
or <code class="literal">None</code></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_default_page_setup</code>() method
101
101
makes <em class="parameter"><code>default_page_setup</code></em> the default page
102
102
setup.</p><p>This page setup will be used by the <a class="link" href="class-gtkprintoperation.html#method-gtkprintoperation--run" title="gtk.PrintOperation.run"><code class="methodname">gtk.PrintOperation.run()</code></a>
231
231
printer.</p></div></div><div class="refsect2" lang="en"><a name="method-gtkprintoperation--cancel"></a><h3>gtk.PrintOperation.cancel</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">cancel</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">cancel</code>() method cancels a running
232
232
print operation. This method may be called from a "begin-print",
233
233
"paginate" or "draw-page" signal handler to stop the currently running
234
print operation.</p></div></div><div class="refsect1" lang="en"><a name="id3598322"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkprintoperation--begin-print"></a><h3>The "begin-print" gtk.PrintOperation Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>operation</code></em> :</span></p></td><td>the <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a>
234
print operation.</p></div></div><div class="refsect1" lang="en"><a name="id3799128"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkprintoperation--begin-print"></a><h3>The "begin-print" gtk.PrintOperation Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>operation</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>operation</code></em> :</span></p></td><td>the <a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a>
235
235
on which the signal was emitted</td></tr><tr><td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td><td>the <a class="link" href="class-gtkprintcontext.html" title="gtk.PrintContext"><code class="classname">gtk.PrintContext</code></a>
236
236
for the current operation</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
237
237
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>