path: root/docs/reference/pygtk-gtkprintunixdialog.xml

<?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-gtkprintunixdialog">

  <refnamediv>
    <refname>gtkunixprint.PrintUnixDialog</refname>
      <refpurpose>an dialog for selecting a printer in Unix (new in PyGTK
      2.10)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtkunixprint.PrintUnixDialog</classname></ooclass>
      <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
      <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkprintunixdialog">gtkunixprint.PrintUnixDialog</link></methodname>
        <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--set-page-setup">set_page_setup</link></methodname>
        <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--get-page-setup">get_page_setup</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--set-current-page">set_current_page</link></methodname>
        <methodparam><parameter role="keyword">current_page</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--get-current-page">get_current_page</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--set-settings">set_settings</link></methodname>
        <methodparam><parameter role="keyword">settings</parameter><initializer>None</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--get-settings">get_settings</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--get-selected-printer">get_selected_printer</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--add-custom-tab">add_custom_tab</link></methodname>
        <methodparam><parameter role="keyword">child</parameter></methodparam>
        <methodparam><parameter role="keyword">tab_label</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintunixdialog--set-manual-capabilities">set_manual_capabilities</link></methodname>
        <methodparam><parameter role="keyword">capabilities</parameter></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtkwindow">gtk.Window</link>
            +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
              +-- <link linkend="class-gtkprintunixdialog">gtkunixprint.PrintUnixDialog</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkprintunixdialog">
    <title>gtkunixprint.PrintUnixDialog Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
    <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"current-page"</entry>
	      <entry>Read-Write</entry>
	      <entry>The current page in the document. Allowed values: >=
	      -1. Default value: -1. Available in GTK+ 2.10.</entry>
	    </row>

	    <row valign="top">
	      <entry>"page-setup"</entry>
	      <entry>Read-Write</entry>
	      <entry>The <link
	      linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
	      to use. Available in GTK+ 2.10.</entry>
	    </row>

	    <row valign="top">
	      <entry>"print-settings"</entry>
	      <entry>Read-Write</entry>
	      <entry>The <link
	      linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
	      used for initializing the dialog. Available in GTK+
	      2.10.</entry>
	    </row>

	    <row valign="top">
	      <entry>"selected-printer"</entry>
	      <entry>Read-Write</entry>
	      <entry>The <link
	      linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
	      that is selected. Available in GTK+ 2.10.</entry>
	    </row>

	  </tbody>
	</tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="style-properties-gtkprintunixdialog">
    <title>gtkunixprint.PrintUnixDialog Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkprintunixdialog">
    <title>gtkunixprint.PrintUnixDialog Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para></para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <refsect2 id="constructor-gtkprintunixdialog">
      <title>gtkunixprint.PrintUnixDialog</title>

      <programlisting><constructorsynopsis language="python">
        <methodname>gtkunixprint.PrintUnixDialog</methodname>
        <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">title</parameter>&nbsp;:</term>
          <listitem><simpara>The title of the dialog, or
          <literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
          <listitem><simpara>The transient parent of the dialog, or
          <literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link
          linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link></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-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkprintunixdialog--set-page-setup">
      <title>gtkunixprint.PrintUnixDialog.set_page_setup</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_page_setup</methodname>
        <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">page_setup</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>set_page_setup</methodname>() method sets the
      "page-setup" property to the <link
      linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
      specified by <parameter>page_setup</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--get-page-setup">
      <title>gtkunixprint.PrintUnixDialog.get_page_setup</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_page_setup</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the page setup of the
          dialog.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_page_setup</methodname>() method returns the
      <link
      linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
      that is used by the <link
      linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--set-current-page">
      <title>gtkunixprint.PrintUnixDialog.set_current_page</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_current_page</methodname>
        <methodparam><parameter role="keyword">current_page</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">current_page</parameter>&nbsp;:</term>
          <listitem><simpara>the current page number.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>set_current_page</methodname>() method sets the
      "current-page" property ot the value specified by
      <parameter>current_page</parameter>. If
      <parameter>current_page</parameter> is not -1 (the default value), the
      current page choice for the range of pages to print is enabled.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--get-current-page">
      <title>gtkunixprint.PrintUnixDialog.get_current_page</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_current_page</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the current page of the dialog</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_current_page</methodname>() method returns
      the current page of the <link
      linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--set-settings">
      <title>gtkunixprint.PrintUnixDialog.set_settings</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_settings</methodname>
        <methodparam><parameter role="keyword">settings</parameter><initializer>None</initializer></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">settings</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>,
          or <literal>None</literal></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>set_settings</methodname>() method sets the
      <link
      linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
      for the <link
      linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>. Typically,
      this is used to restore saved print settings from a previous print
      operation before the print dialog is shown.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--get-settings">
      <title>gtkunixprint.PrintUnixDialog.get_settings</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_settings</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link
          linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
          object with the values from the dialog</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_settings</methodname>() method returns a new
      <link
      linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
      object that represents the current values in the print dialog.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--get-selected-printer">
      <title>gtkunixprint.PrintUnixDialog.get_selected_printer</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_selected_printer</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the currently selected
          printer</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_selected_printer</methodname>() method
      returns the currently selected <link
      linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--add-custom-tab">
      <title>gtkunixprint.PrintUnixDialog.add_custom_tab</title>

      <programlisting><methodsynopsis language="python">
        <methodname>add_custom_tab</methodname>
        <methodparam><parameter role="keyword">child</parameter></methodparam>
        <methodparam><parameter role="keyword">tab_label</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">child</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">tab_label</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>add_custom_tab</methodname>() method adds a tab
      to the dialog using the <link
      linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
      specified by <parameter>child</parameter> for the contents and
      <parameter>tab_label</parameter> for the label.</para>

    </refsect2>

    <refsect2 id="method-gtkprintunixdialog--set-manual-capabilities">
      <title>gtkunixprint.PrintUnixDialog.set_manual_capabilities</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_manual_capabilities</methodname>
        <methodparam><parameter role="keyword">capabilities</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">capabilities</parameter>&nbsp;:</term>
          <listitem><simpara>one of the <xref
          linkend="unixprint-print-capabilities-constants"
          endterm="unixprint-print-capabilities-title"></xref></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>set_manual_capabilities</methodname>() method
      lets you specify the printing capabilities your application supports
      using the <xref linkend="unixprint-print-capabilities-constants"
      endterm="unixprint-print-capabilities-title"></xref> specified by
      <parameter>capabilities</parameter>. For example, if the application
      can handle scaling the output then it should pass
      <literal>gtkunixprint.PRINT_CAPABILITY_SCALE</literal>. If it doesn't
      pass that, the dialog will only let you select the scale if the
      printing system automatically handles scaling.</para>

    </refsect2>

  </refsect1>

</refentry>