diff options
Diffstat (limited to 'docs/reference/pygtk-gtkprintsettings.xml')
-rw-r--r-- | docs/reference/pygtk-gtkprintsettings.xml | 1954 |
1 files changed, 0 insertions, 1954 deletions
diff --git a/docs/reference/pygtk-gtkprintsettings.xml b/docs/reference/pygtk-gtkprintsettings.xml deleted file mode 100644 index 061cd626..00000000 --- a/docs/reference/pygtk-gtkprintsettings.xml +++ /dev/null @@ -1,1954 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="class-gtkprintsettings"> - - <refnamediv> - <refname>gtk.PrintSettings</refname> - <refpurpose>Stores print settings (new in PyGTK 2.10)</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <classsynopsis language="python"> - <ooclass><classname>gtk.PrintSettings</classname></ooclass> - <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass> - <constructorsynopsis language="python"> - <methodname><link linkend="constructor-gtkprintsettings">gtk.PrintSettings</link></methodname> - <methodparam></methodparam> - </constructorsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--copy">copy</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--has-key">has_key</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get">get</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set">set</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--unset">unset</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--foreach">foreach</link></methodname> - <methodparam><parameter role="keyword">func</parameter></methodparam> - <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-bool">get_bool</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-bool">set_bool</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-double">get_double</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-double-with-default">get_double_with_default</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">def</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-double">set_double</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-length">get_length</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-length">set_length</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-int">get_int</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-int-with-default">get_int_with_default</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">def</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-int">set_int</link></methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-printer">get_printer</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-printer">set_printer</link></methodname> - <methodparam><parameter role="keyword">printer</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-orientation">get_orientation</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-orientation">set_orientation</link></methodname> - <methodparam><parameter role="keyword">orientation</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-paper-size">get_paper_size</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-paper-size">set_paper_size</link></methodname> - <methodparam><parameter role="keyword">paper_size</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-paper-width">get_paper_width</link></methodname> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-paper-width">set_paper_width</link></methodname> - <methodparam><parameter role="keyword">width</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-paper-height">get_paper_height</link></methodname> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-paper-height">set_paper_height</link></methodname> - <methodparam><parameter role="keyword">height</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-use-color">get_use_color</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-use-color">set_use_color</link></methodname> - <methodparam><parameter role="keyword">use_color</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-collate">get_collate</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-collate">set_collate</link></methodname> - <methodparam><parameter role="keyword">collate</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-reverse">get_reverse</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-reverse">set_reverse</link></methodname> - <methodparam><parameter role="keyword">reverse</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-duplex">get_duplex</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-duplex">set_duplex</link></methodname> - <methodparam><parameter role="keyword">duplex</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-quality">get_quality</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-quality">set_quality</link></methodname> - <methodparam><parameter role="keyword">quality</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-n-copies">get_n_copies</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-n-copies">set_n_copies</link></methodname> - <methodparam><parameter role="keyword">num_copies</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-number-up">get_number_up</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-number-up">set_number_up</link></methodname> - <methodparam><parameter role="keyword">number_up</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-resolution">get_resolution</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-resolution">set_resolution</link></methodname> - <methodparam><parameter role="keyword">resolution</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-scale">get_scale</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-scale">set_scale</link></methodname> - <methodparam><parameter role="keyword">scale</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-print-pages">get_print_pages</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-print-pages">set_print_pages</link></methodname> - <methodparam><parameter role="keyword">pages</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-page-ranges">get_page_ranges</link></methodname> - <methodparam><parameter role="keyword">num_ranges</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-page-ranges">set_page_ranges</link></methodname> - <methodparam><parameter role="keyword">page_ranges</parameter></methodparam> - <methodparam><parameter role="keyword">num_ranges</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-page-set">get_page_set</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-page-set">set_page_set</link></methodname> - <methodparam><parameter role="keyword">page_set</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-default-source">get_default_source</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-default-source">set_default_source</link></methodname> - <methodparam><parameter role="keyword">default_source</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-media-type">get_media_type</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-media-type">set_media_type</link></methodname> - <methodparam><parameter role="keyword">media_type</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-dither">get_dither</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-dither">set_dither</link></methodname> - <methodparam><parameter role="keyword">dither</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-finishings">get_finishings</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-finishings">set_finishings</link></methodname> - <methodparam><parameter role="keyword">finishings</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--get-output-bin">get_output_bin</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gtkprintsettings--set-output-bin">set_output_bin</link></methodname> - <methodparam><parameter role="keyword">output_bin</parameter></methodparam> - </methodsynopsis> -</classsynopsis> - - </refsect1> - - <refsect1> - <title>Ancestry</title> - -<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link> - +-- <link linkend="class-gtkprintsettings">gtk.PrintSettings</link> -</synopsis> - - </refsect1> - - <refsect1 id="signal-prototypes-gtkprintsettings"> - <title>gtk.PrintSettings Signal Prototypes</title> - - <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> - </refsect1> - - <refsect1> - <title>Description</title> - - <para>A <link - linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link> - object represents the settings of a print dialog in a system-independent - way. The main use for this object is that once you've printed you can - get a settings object that represents the settings the user chose, and - the next time you print you can pass that object in so that the user - doesn't have to re-set all his settings. </para> - - <para>Its also possible to enumerate the settings so that you can easily - save the settings for the next time your app runs, or even store them in - a document. The predefined keys try to use shared values as much as - possible so that moving such a document between systems still - works.</para> - - <para>Printing support was added in GTK+ 2.10.</para> - - </refsect1> - - <refsect1> - <title>Constructor</title> - - <refsect2 id="constructor-gtkprintsettings"> - <title>gtk.PrintSettings</title> - - <programlisting><constructorsynopsis language="python"> - <methodname>gtk.PrintSettings</methodname> - <methodparam></methodparam> - </constructorsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link - linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link> - object</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This constructor is available in PyGTK 2.10 and above.</para> - </note> - - <para>Creates a new <link - linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link> - object.</para> - - </refsect2> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-gtkprintsettings--copy"> - <title>gtk.PrintSettings.copy</title> - - <programlisting><methodsynopsis language="python"> - <methodname>copy</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a newly allocated copy of the print - settings</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns a copy of this <link - linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link> - object.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--has-key"> - <title>gtk.PrintSettings.has_key</title> - - <programlisting><methodsynopsis language="python"> - <methodname>has_key</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal>, if - <parameter>key</parameter> has a value</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns <literal>True</literal>, if a value is associated with - <parameter>key</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get"> - <title>gtk.PrintSettings.get</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the string value for - <parameter>key</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Looks up the string value associated with - <parameter>key</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set"> - <title>gtk.PrintSettings.set</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">value</parameter> :</term> - <listitem><simpara>a string value, or - <literal>None</literal></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Associates <parameter>value</parameter> with - <parameter>key</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--unset"> - <title>gtk.PrintSettings.unset</title> - - <programlisting><methodsynopsis language="python"> - <methodname>unset</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Removes any value associated with <parameter>key</parameter>. - This has the same effect as setting the value to - <literal>None</literal>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--foreach"> - <title>gtk.PrintSettings.foreach</title> - - <programlisting><methodsynopsis language="python"> - <methodname>foreach</methodname> - <methodparam><parameter role="keyword">func</parameter></methodparam> - <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">func</parameter> :</term> - <listitem><simpara>the function to call</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">user_data</parameter> :</term> - <listitem><simpara>user data for - <parameter>func</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Calls <parameter>func</parameter> for each key-value pair.</para> - - <para>The signature of <parameter>func</parameter> is:</para> - - <programlisting> - def func(key, value, data): - </programlisting> - - <para>where <parameter>key</parameter> and - <parameter>value</parameter> are the key-value pair and - <parameter>data</parameter> is - <parameter>user_data</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-bool"> - <title>gtk.PrintSettings.get_bool</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_bool</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal>, if - <parameter>key</parameter> maps to a true - value.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the boolean represented by the value that is associated - with <parameter>key</parameter>. </para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-bool"> - <title>gtk.PrintSettings.set_bool</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_bool</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">value</parameter> :</term> - <listitem><simpara>a boolean</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets <parameter>key</parameter> to the boolean value specified - by <parameter>value</parameter>..</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-double"> - <title>gtk.PrintSettings.get_double</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_double</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the double value of - <parameter>key</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the double value associated with - <parameter>key</parameter>, or 0.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-double-with-default"> - <title>gtk.PrintSettings.get_double_with_default</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_double_with_default</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">def</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">def</parameter> :</term> - <listitem><simpara>the default value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the floating point number associated with - <parameter>key</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the floating point number represented by the value that - is associated with <parameter>key</parameter>, or - <parameter>def</parameter> if the value does not represent a floating - point number.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-double"> - <title>gtk.PrintSettings.set_double</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_double</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">value</parameter> :</term> - <listitem><simpara>a double value</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets <parameter>key</parameter> to the given double - value.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-length"> - <title>gtk.PrintSettings.get_length</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_length</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">unit</parameter> :</term> - <listitem><simpara>the unit of the return value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the length value of <parameter>key</parameter>, - converted to <parameter>unit</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value associated with <parameter>key</parameter>, - interpreted as a length. The returned value is converted to the units - specified by <parameter>unit</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-length"> - <title>gtk.PrintSettings.set_length</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_length</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">value</parameter> :</term> - <listitem><simpara>a length</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">unit</parameter> :</term> - <listitem><simpara>the unit of - <parameter>length</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Associates a length in units of <parameter>unit</parameter> with - <parameter>key</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-int"> - <title>gtk.PrintSettings.get_int</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_int</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the integer value of - <parameter>key</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the integer value of <parameter>key</parameter>, or - 0.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-int-with-default"> - <title>gtk.PrintSettings.get_int_with_default</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_int_with_default</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">def</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">def</parameter> :</term> - <listitem><simpara>the default value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the integer value of - <parameter>key</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of <parameter>key</parameter>, interpreted as - an integer, or the default value specified by - <parameter>def</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-int"> - <title>gtk.PrintSettings.set_int</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_int</methodname> - <methodparam><parameter role="keyword">key</parameter></methodparam> - <methodparam><parameter role="keyword">value</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">key</parameter> :</term> - <listitem><simpara>a key</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">value</parameter> :</term> - <listitem><simpara>an integer</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets <parameter>key</parameter> to the given integer - value.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-printer"> - <title>gtk.PrintSettings.get_printer</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_printer</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the printer name</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Convenience method to obtain the value of the "printer" - key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-printer"> - <title>gtk.PrintSettings.set_printer</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_printer</methodname> - <methodparam><parameter role="keyword">printer</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">printer</parameter> :</term> - <listitem><simpara>the printer name</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Convenience function to set the "printer" key the value - specified by <parameter>printer</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-orientation"> - <title>gtk.PrintSettings.get_orientation</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_orientation</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the orientation</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Get the value of the "orientation" key, converted to one of the - <xref linkend="gtk-page-orientation-constants" - endterm="gtk-page-orientation-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-orientation"> - <title>gtk.PrintSettings.set_orientation</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_orientation</methodname> - <methodparam><parameter role="keyword">orientation</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">orientation</parameter> :</term> - <listitem><simpara>a page orientation</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "orientation" key to one of the <xref - linkend="gtk-page-orientation-constants" - endterm="gtk-page-orientation-constants-title"></xref> specified by - <parameter>orientation</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-paper-size"> - <title>gtk.PrintSettings.get_paper_size</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_paper_size</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the paper size</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Gets the value of the "paper-format" key, converted to a <link - linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-paper-size"> - <title>gtk.PrintSettings.set_paper_size</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_paper_size</methodname> - <methodparam><parameter role="keyword">paper_size</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">paper_size</parameter> :</term> - <listitem><simpara>a paper size</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "paper-format", "paper-width" and - "paper-height" keys using the <link - linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link> - specified by <parameter>paper_size</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-paper-width"> - <title>gtk.PrintSettings.get_paper_width</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_paper_width</methodname> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">unit</parameter> :</term> - <listitem><simpara>the unit for the return value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the paper width, in units of - <parameter>unit</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Retuens the value of the "printer-width" key converted to the - units specified by <parameter>unit</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-paper-width"> - <title>gtk.PrintSettings.set_paper_width</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_paper_width</methodname> - <methodparam><parameter role="keyword">width</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">width</parameter> :</term> - <listitem><simpara>the paper width</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">unit</parameter> :</term> - <listitem><simpara>the units of <parameter>width</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "printer-width" key using the units - specified by <parameter>unit</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-paper-height"> - <title>gtk.PrintSettings.get_paper_height</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_paper_height</methodname> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">unit</parameter> :</term> - <listitem><simpara>the units for the return - value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the paper height, in units of - <parameter>unit</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Gets the value of the "paper-height" key converted to the units - specified by <parameter>unit</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-paper-height"> - <title>gtk.PrintSettings.set_paper_height</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_paper_height</methodname> - <methodparam><parameter role="keyword">height</parameter></methodparam> - <methodparam><parameter role="keyword">unit</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">height</parameter> :</term> - <listitem><simpara>the paper height</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">unit</parameter> :</term> - <listitem><simpara>the units of - <parameter>height</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "paper-height" key using the units - specified by <parameter>unit</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-use-color"> - <title>gtk.PrintSettings.get_use_color</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_use_color</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>whether to use color</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "use-color" key. If - <literal>True</literal> color will be used when printing.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-use-color"> - <title>gtk.PrintSettings.set_use_color</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_use_color</methodname> - <methodparam><parameter role="keyword">use_color</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">use_color</parameter> :</term> - <listitem><simpara>if <literal>True</literal> use - color</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "use-color" key to the value specified by - <parameter>use_color</parameter>. If <parameter>use_color</parameter> - is <literal>True</literal> color will be used when printing.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-collate"> - <title>gtk.PrintSettings.get_collate</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_collate</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the printed pages - are to be collated</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "collate" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-collate"> - <title>gtk.PrintSettings.set_collate</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_collate</methodname> - <methodparam><parameter role="keyword">collate</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">collate</parameter> :</term> - <listitem><simpara>if <literal>True</literal>, collate the - output</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "collate" key. If - <parameter>collate</parameter> is <literal>True</literal> the output - pages will be collated.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-reverse"> - <title>gtk.PrintSettings.get_reverse</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_reverse</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the order of the - printed pages shoudl be reversed.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "reverse" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-reverse"> - <title>gtk.PrintSettings.set_reverse</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_reverse</methodname> - <methodparam><parameter role="keyword">reverse</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">reverse</parameter> :</term> - <listitem><simpara>if <literal>True</literal> reverse the - output</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "reverse" key. If - <parameter>reverse</parameter> is <literal>True</literal> the output - pages willl be reversed.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-duplex"> - <title>gtk.PrintSettings.get_duplex</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_duplex</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the "duplex" key.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "duplex" key - one of the <xref - linkend="gtk-print-duplex-constants" - endterm="gtk-print-duplex-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-duplex"> - <title>gtk.PrintSettings.set_duplex</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_duplex</methodname> - <methodparam><parameter role="keyword">duplex</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">duplex</parameter> :</term> - <listitem><simpara>one of the <xref - linkend="gtk-print-duplex-constants" - endterm="gtk-print-duplex-constants-title"></xref></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "duplex" - key. <parameter>duplexp</parameter> must be one of the <xref - linkend="gtk-print-duplex-constants" - endterm="gtk-print-duplex-constants-title"></xref></para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-quality"> - <title>gtk.PrintSettings.get_quality</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_quality</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the print quality</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "quality" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-quality"> - <title>gtk.PrintSettings.set_quality</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_quality</methodname> - <methodparam><parameter role="keyword">quality</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">quality</parameter> :</term> - <listitem><simpara>one of the <xref - linkend="gtk-print-quality-constants" - endterm="gtk-print-quality-constants-title"></xref></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "quality" - key. <parameter>quality</parameter> must be one of the <xref - linkend="gtk-print-quality-constants" - endterm="gtk-print-quality-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-n-copies"> - <title>gtk.PrintSettings.get_n_copies</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_n_copies</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the number of copies to print</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "n-copies" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-n-copies"> - <title>gtk.PrintSettings.set_n_copies</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_n_copies</methodname> - <methodparam><parameter role="keyword">num_copies</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">num_copies</parameter> :</term> - <listitem><simpara>the number of copies</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "n-copies" key to the value specified by - <parameter>num_copies</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-number-up"> - <title>gtk.PrintSettings.get_number_up</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_number_up</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the number of pages per sheet</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "number-up" key which specifies the - number of pages per sheet.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-number-up"> - <title>gtk.PrintSettings.set_number_up</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_number_up</methodname> - <methodparam><parameter role="keyword">number_up</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">number_up</parameter> :</term> - <listitem><simpara>the number of pages per sheet</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "number-up" - key. <parameter>number_up</parameter> specifies the number of document - pages to be printed per sheet.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-resolution"> - <title>gtk.PrintSettings.get_resolution</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_resolution</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the resolution in dpi</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "resolution" key in dpi.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-resolution"> - <title>gtk.PrintSettings.set_resolution</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_resolution</methodname> - <methodparam><parameter role="keyword">resolution</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">resolution</parameter> :</term> - <listitem><simpara>the resolution in dpi</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "resolution" key in dpi.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-scale"> - <title>gtk.PrintSettings.get_scale</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_scale</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the scale in percent</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "scale" key as a float number.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-scale"> - <title>gtk.PrintSettings.set_scale</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_scale</methodname> - <methodparam><parameter role="keyword">scale</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">scale</parameter> :</term> - <listitem><simpara>the scale in percent</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "scale" key using the float number - specified by <parameter>scale</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-print-pages"> - <title>gtk.PrintSettings.get_print_pages</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_print_pages</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>which pages to print</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "print-pages" key as one if the <xref - linkend="gtk-print-pages-constants" - endterm="gtk-print-pages-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-print-pages"> - <title>gtk.PrintSettings.set_print_pages</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_print_pages</methodname> - <methodparam><parameter role="keyword">pages</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">pages</parameter> :</term> - <listitem><simpara>one if the <xref - linkend="gtk-print-pages-constants" - endterm="gtk-print-pages-constants-title"></xref></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "print-pages" key to one of the <xref - linkend="gtk-print-pages-constants" - endterm="gtk-print-pages-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-page-ranges"> - <title>gtk.PrintSettings.get_page_ranges</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_page_ranges</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a list of [age ranges as - 2-tuples</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "page-ranges" key as a list of - 2-tuples containing the start and end page numbers of each - range.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-page-ranges"> - <title>gtk.PrintSettings.set_page_ranges</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_page_ranges</methodname> - <methodparam><parameter role="keyword">page_ranges</parameter></methodparam> - <methodparam><parameter role="keyword">num_ranges</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">page_ranges</parameter> :</term> - <listitem><simpara>a sequence of page range - 2-tuples</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "page-ranges" key to the value of - <parameter>page_ranges</parameter> which should be a sequence of - 2-tuples containing the start and end page numbers of each page - range.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-page-set"> - <title>gtk.PrintSettings.get_page_set</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_page_set</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the set of pages to print</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "page-set" key which is one of the - <xref linkend="gtk-page-set-constants" - endterm="gtk-page-set-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-page-set"> - <title>gtk.PrintSettings.set_page_set</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_page_set</methodname> - <methodparam><parameter role="keyword">page_set</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">page_set</parameter> :</term> - <listitem><simpara>one of the <xref - linkend="gtk-page-set-constants" - endterm="gtk-page-set-constants-title"></xref></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "page-set" key to the value specified by - <parameter>page_set</parameter> which should be one of the <xref - linkend="gtk-page-set-constants" - endterm="gtk-page-set-constants-title"></xref>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-default-source"> - <title>gtk.PrintSettings.get_default_source</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_default_source</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the default source</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "default-source" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-default-source"> - <title>gtk.PrintSettings.set_default_source</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_default_source</methodname> - <methodparam><parameter role="keyword">default_source</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">default_source</parameter> :</term> - <listitem><simpara>the default source</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "default-source" key to the string - specified by <parameter>default_source</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-media-type"> - <title>gtk.PrintSettings.get_media_type</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_media_type</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the media type</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "media-type" key.</para> - - <para>The set of media types is defined in PWG 5101.1-2002 PWG.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-media-type"> - <title>gtk.PrintSettings.set_media_type</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_media_type</methodname> - <methodparam><parameter role="keyword">media_type</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">media_type</parameter> :</term> - <listitem><simpara>the media type</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "media-type" key.</para> - - <para>The set of media types is defined in PWG 5101.1-2002 PWG.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-dither"> - <title>gtk.PrintSettings.get_dither</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_dither</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the dithering that is used</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "dither" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-dither"> - <title>gtk.PrintSettings.set_dither</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_dither</methodname> - <methodparam><parameter role="keyword">dither</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">dither</parameter> :</term> - <listitem><simpara>the dithering that is used</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "dither" key to the string specified by - <parameter>dither</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-finishings"> - <title>gtk.PrintSettings.get_finishings</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_finishings</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the finishings</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "finishings" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-finishings"> - <title>gtk.PrintSettings.set_finishings</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_finishings</methodname> - <methodparam><parameter role="keyword">finishings</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">finishings</parameter> :</term> - <listitem><simpara>the finishings</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "finishings" key to the string specified - by <parameter>finishings</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--get-output-bin"> - <title>gtk.PrintSettings.get_output_bin</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_output_bin</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the output bin</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Returns the value of the "output-bin" key.</para> - - </refsect2> - - <refsect2 id="method-gtkprintsettings--set-output-bin"> - <title>gtk.PrintSettings.set_output_bin</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_output_bin</methodname> - <methodparam><parameter role="keyword">output_bin</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">output_bin</parameter> :</term> - <listitem><simpara>the output bin</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Sets the value of the "output-bin" key to the value specified by - <parameter>output_bin</parameter>.</para> - - </refsect2> - - </refsect1> - -</refentry> |