******************
wx.PrintDialogData
******************

Inheritance diagram for `wx.PrintDialogData`:

|

.. inheritance-diagram:: wx.PrintDialogData

|

Description
===========

This class holds information related to the visual characteristics of `wx.PrintDialog <wx.PrintDialog.html>`_. 

It contains a `wx.PrintData <wx.PrintData.html>`_ object with underlying printing settings.


.. seealso:: `wx.PrintDialog <wx.PrintDialog.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `EnableHelp <#EnableHelp>`_ 
* `EnablePageNumbers <#EnablePageNumbers>`_ 
* `EnablePrintToFile <#EnablePrintToFile>`_ 
* `EnableSelection <#EnableSelection>`_ 
* `GetAllPages <#GetAllPages>`_ 
* `GetCollate <#GetCollate>`_ 
* `GetEnableHelp <#GetEnableHelp>`_ 
* `GetEnablePageNumbers <#GetEnablePageNumbers>`_ 
* `GetEnablePrintToFile <#GetEnablePrintToFile>`_ 
* `GetEnableSelection <#GetEnableSelection>`_ 
* `GetFromPage <#GetFromPage>`_ 
* `GetMaxPage <#GetMaxPage>`_ 
* `GetMinPage <#GetMinPage>`_ 
* `GetNoCopies <#GetNoCopies>`_ 
* `GetPrintData <#GetPrintData>`_ 
* `GetPrintToFile <#GetPrintToFile>`_ 
* `GetSelection <#GetSelection>`_ 
* `GetToPage <#GetToPage>`_ 
* `IsOk <#IsOk>`_ 
* `SetAllPages <#SetAllPages>`_ 
* `SetCollate <#SetCollate>`_ 
* `SetFromPage <#SetFromPage>`_ 
* `SetMaxPage <#SetMaxPage>`_ 
* `SetMinPage <#SetMinPage>`_ 
* `SetNoCopies <#SetNoCopies>`_ 
* `SetPrintData <#SetPrintData>`_ 
* `SetPrintToFile <#SetPrintToFile>`_ 
* `SetSelection <#SetSelection>`_ 
* `SetToPage <#SetToPage>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `AllPages <#AllPages>`_ 
* `Collate <#Collate>`_ 
* `FromPage <#FromPage>`_ 
* `MaxPage <#MaxPage>`_ 
* `MinPage <#MinPage>`_ 
* `NoCopies <#NoCopies>`_ 
* `PrintData <#PrintData>`_ 
* `PrintToFile <#PrintToFile>`_ 
* `Selection <#Selection>`_ 
* `ToPage <#ToPage>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   Constructors:

   `__init__(self, wx.PrintData printData)`

   `__init__(self, wx.PrintDialogData printData)`

   |
   
   **Returns:**

   `wx.PrintDialogData <wx.PrintDialogData.html>`_
 

--------

.. method:: EnableHelp(flag)

   Enables or disables the 'Help' button.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: EnablePageNumbers(flag)

   Enables or disables the 'Page numbers' controls.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: EnablePrintToFile(flag)

   Enables or disables the 'Print to file' checkbox.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: EnableSelection(flag)

   Enables or disables the 'Selection' radio button.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: GetAllPages()

   Returns ``True`` if the user requested that all pages be printed.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetCollate()

   Returns ``True`` if the user requested that the document(s) be collated.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetEnableHelp()

   `No docstrings available for this method.` 

--------


.. method:: GetEnablePageNumbers()

   `No docstrings available for this method.` 

--------


.. method:: GetEnablePrintToFile()

   `No docstrings available for this method.` 

--------


.. method:: GetEnableSelection()

   `No docstrings available for this method.` 

--------


.. method:: GetFromPage()

   Returns the *from* page number, as entered by the user.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetMaxPage()

   Returns the *maximum* page number.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetMinPage()

   Returns the *minimum* page number.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetNoCopies()

   Returns the number of copies requested by the user.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetPrintData()

   Returns a reference to the internal `wx.PrintData` object.

   |  

   **Returns:**

   `wx.PrintData <wx.PrintData.html>`_
 

--------

.. method:: GetPrintToFile()

   Returns ``True`` if the user has selected printing to a file.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetSelection()

   Returns ``True`` if the user requested that the selection be printed (where 'selection' is a concept specific to the application).

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetToPage()

   Returns the *to* page number, as entered by the user.

   |  

   **Returns:**

   `int` 

--------

.. method:: IsOk()

   Returns ``True`` if the print data is valid for using in print dialogs. This can return ``False`` on Windows if the current printer is not set, for example. 
   On all other platforms, it returns ``True``.

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetAllPages(flag)

   |
   
   **Parameters:**

   * `flag` (bool)



--------

.. method:: SetCollate(flag)

   Sets the 'Collate' checkbox to ``True`` or ``False``.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: SetFromPage(page)

   Sets the *from* page number.

   **Parameters:**

   * `page` (int) 

--------

.. method:: SetMaxPage(page)

   Sets the *maximum* page number.

   **Parameters:**

   * `page` (int) 

--------

.. method:: SetMinPage(page)

   Sets the *minimum* page number.

   **Parameters:**

   * `page` (int) 

--------

.. method:: SetNoCopies(n)

   Sets the default number of copies the user has requested to be printed out.

   **Parameters:**

   * `n` (int) 

--------

.. method:: SetPrintData(printData)

   Sets the internal `wx.PrintData`.

   **Parameters:**

   * `printData` (`wx.PrintData <wx.PrintData.html>`_) 

--------

.. method:: SetPrintToFile(flag)

   Sets the 'Print to file' checkbox to ``True`` or ``False``.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: SetSelection(flag)

   Selects the 'Selection' radio button. The effect of printing the selection depends on how the application implements this command, if at all.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: SetToPage(page)

   Sets the *to* page number.

   **Parameters:**

   * `page` (int) 

--------

Properties
^^^^^^^^^^


.. attribute:: AllPages

   See `GetAllPages <#GetAllPages>`_ and `SetAllPages <#SetAllPages>`_

.. attribute:: Collate

   See `GetCollate <#GetCollate>`_ and `SetCollate <#SetCollate>`_

.. attribute:: FromPage

   See `GetFromPage <#GetFromPage>`_ and `SetFromPage <#SetFromPage>`_

.. attribute:: MaxPage

   See `GetMaxPage <#GetMaxPage>`_ and `SetMaxPage <#SetMaxPage>`_

.. attribute:: MinPage

   See `GetMinPage <#GetMinPage>`_ and `SetMinPage <#SetMinPage>`_

.. attribute:: NoCopies

   See `GetNoCopies <#GetNoCopies>`_ and `SetNoCopies <#SetNoCopies>`_

.. attribute:: PrintData

   See `GetPrintData <#GetPrintData>`_ and `SetPrintData <#SetPrintData>`_

.. attribute:: PrintToFile

   See `GetPrintToFile <#GetPrintToFile>`_ and `SetPrintToFile <#SetPrintToFile>`_

.. attribute:: Selection

   See `GetSelection <#GetSelection>`_ and `SetSelection <#SetSelection>`_

.. attribute:: ToPage

   See `GetToPage <#GetToPage>`_ and `SetToPage <#SetToPage>`_