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

  <refnamediv>
    <refname>gtk.PrintOperationPreview</refname>
      <refpurpose>an interface for printing preview (new in PyGTK
      2.10)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.PrintOperationPreview</classname></ooclass>
      <ooclass><classname>gobject.GInterface</classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintoperationpreview--render-page">render_page</link></methodname>
        <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintoperationpreview--end-preview">end_preview</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkprintoperationpreview--is-selected">is_selected</link></methodname>
        <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkprintoperationpreview">
    <title>gtk.PrintOperationPreview Signal Prototypes</title>


      <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-gtkprintoperationpreview--got-page-size">got-page-size</link></term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>printoperationpreview</parameter></methodparam>
            <methodparam><parameter>printcontext</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-gtkprintoperationpreview--ready">ready</link></term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>printoperationpreview</parameter></methodparam>
            <methodparam><parameter>printcontext</parameter></methodparam>
            <methodparam><parameter>pagesetup</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
    linkend="class-gtkprintoperationpreview"><classname>gtk.PrintOperationPreview</classname></link>
    is an interface implemented by <link
    linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
    for previewing pages before printing.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkprintoperationpreview--render-page">
      <title>gtk.PrintOperationPreview.render_page</title>

      <programlisting><methodsynopsis language="python">
        <methodname>render_page</methodname>
        <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">page_nr</parameter>&nbsp;:</term>
          <listitem><simpara>the number of the page to be
          previewed</simpara></listitem>
        </varlistentry>
      </variablelist>

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

    </refsect2>

    <refsect2 id="method-gtkprintoperationpreview--end-preview">
      <title>gtk.PrintOperationPreview.end_preview</title>

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

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

    </refsect2>

    <refsect2 id="method-gtkprintoperationpreview--is-selected">
      <title>gtk.PrintOperationPreview.is_selected</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_selected</methodname>
        <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">page_nr</parameter>&nbsp;:</term>
          <listitem><simpara></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if
          <parameter>page_nr</parameter> is the currently selected
          page</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns <literal>True</literal> if the page with the number
      specified by <parameter>page_nr</parameter> is currently
      selected.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkprintoperationpreview--got-page-size">
      <title>The "got-page-size" gtk.PrintOperationPreview Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>printoperationpreview</parameter></methodparam>
            <methodparam><parameter>printcontext</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>printoperationpreview</parameter>&nbsp;:</term>
          <listitem><simpara></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>printcontext</parameter>&nbsp;:</term>
          <listitem><simpara>the print context</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.10 and above.</para>
      </note>

    </refsect2>

    <refsect2 id="signal-gtkprintoperationpreview--ready">
      <title>The "ready" gtk.PrintOperationPreview Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>printoperationpreview</parameter></methodparam>
            <methodparam><parameter>printcontext</parameter></methodparam>
            <methodparam><parameter>pagesetup</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>printoperationpreview</parameter>&nbsp;:</term>
          <listitem><simpara></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>printcontext</parameter>&nbsp;:</term>
          <listitem><simpara>the print context</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>pagesetup</parameter>&nbsp;:</term>
          <listitem><simpara>the page setup</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.10 and above.</para>
      </note>

    </refsect2>

</refsect1>

</refentry>
