.. include:: headings.inc .. _PrintDialogData: ========================================================================================================================================== |phoenix_title| **PrintDialogData** ========================================================================================================================================== This class holds information related to the visual characteristics of :ref:`PrintDialog`. It contains a :ref:`PrintData` object with underlying printing settings. .. seealso:: :ref:`Printing Framework Overview `, :ref:`PrintDialog`, :ref:`PrintDialog Overview ` | |class_hierarchy| Inheritance Diagram ===================================== Inheritance diagram for class **PrintDialogData** .. raw:: html

Inheritance diagram of PrintDialogData

| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~PrintDialogData.__init__` Default constructor. :meth:`~PrintDialogData.EnableHelp` Enables or disables the "Help" button. :meth:`~PrintDialogData.EnablePageNumbers` Enables or disables the "Page numbers" controls. :meth:`~PrintDialogData.EnablePrintToFile` Enables or disables the "Print to file" checkbox. :meth:`~PrintDialogData.EnableSelection` Enables or disables the "Selection" radio button. :meth:`~PrintDialogData.GetAllPages` Returns ``True`` if the user requested that all pages be printed. :meth:`~PrintDialogData.GetCollate` Returns ``True`` if the user requested that the document(s) be collated. :meth:`~PrintDialogData.GetFromPage` Returns the `from` page number, as entered by the user. :meth:`~PrintDialogData.GetMaxPage` Returns the `maximum` page number. :meth:`~PrintDialogData.GetMinPage` Returns the `minimum` page number. :meth:`~PrintDialogData.GetNoCopies` Returns the number of copies requested by the user. :meth:`~PrintDialogData.GetPrintData` Returns a reference to the internal :ref:`PrintData` object. :meth:`~PrintDialogData.GetPrintToFile` Returns ``True`` if the user has selected printing to a file. :meth:`~PrintDialogData.GetSelection` Returns ``True`` if the user requested that the selection be printed (where "selection" is a concept specific to the application). :meth:`~PrintDialogData.GetToPage` Returns the `"print to"` page number, as entered by the user. :meth:`~PrintDialogData.IsOk` Returns ``True`` if the print data is valid for using in print dialogs. :meth:`~PrintDialogData.SetCollate` Sets the "Collate" checkbox to ``True`` or ``False``. :meth:`~PrintDialogData.SetFromPage` Sets the `from` page number. :meth:`~PrintDialogData.SetMaxPage` Sets the `maximum` page number. :meth:`~PrintDialogData.SetMinPage` Sets the `minimum` page number. :meth:`~PrintDialogData.SetNoCopies` Sets the default number of copies the user has requested to be printed out. :meth:`~PrintDialogData.SetPrintData` Sets the internal :ref:`PrintData`. :meth:`~PrintDialogData.SetPrintToFile` Sets the "Print to file" checkbox to ``True`` or ``False``. :meth:`~PrintDialogData.SetSelection` Selects the "Selection" radio button. :meth:`~PrintDialogData.SetToPage` Sets the `"print to"` page number. :meth:`~PrintDialogData.__nonzero__` ================================================================================ ================================================================================ | |property_summary| Properties Summary ===================================== ================================================================================ ================================================================================ :attr:`~PrintDialogData.AllPages` See :meth:`~PrintDialogData.GetAllPages` :attr:`~PrintDialogData.Collate` See :meth:`~PrintDialogData.GetCollate` and :meth:`~PrintDialogData.SetCollate` :attr:`~PrintDialogData.FromPage` See :meth:`~PrintDialogData.GetFromPage` and :meth:`~PrintDialogData.SetFromPage` :attr:`~PrintDialogData.MaxPage` See :meth:`~PrintDialogData.GetMaxPage` and :meth:`~PrintDialogData.SetMaxPage` :attr:`~PrintDialogData.MinPage` See :meth:`~PrintDialogData.GetMinPage` and :meth:`~PrintDialogData.SetMinPage` :attr:`~PrintDialogData.NoCopies` See :meth:`~PrintDialogData.GetNoCopies` and :meth:`~PrintDialogData.SetNoCopies` :attr:`~PrintDialogData.PrintData` See :meth:`~PrintDialogData.GetPrintData` and :meth:`~PrintDialogData.SetPrintData` :attr:`~PrintDialogData.PrintToFile` See :meth:`~PrintDialogData.GetPrintToFile` and :meth:`~PrintDialogData.SetPrintToFile` :attr:`~PrintDialogData.Selection` See :meth:`~PrintDialogData.GetSelection` and :meth:`~PrintDialogData.SetSelection` :attr:`~PrintDialogData.ToPage` See :meth:`~PrintDialogData.GetToPage` and :meth:`~PrintDialogData.SetToPage` ================================================================================ ================================================================================ | |api| Class API =============== .. class:: PrintDialogData(Object) This class holds information related to the visual characteristics of PrintDialog. **Possible constructors**:: PrintDialogData() PrintDialogData(dialogData) PrintDialogData(printData) .. method:: __init__(self, *args, **kw) |overload| **Overloaded Implementations**: **~~~** **__init__** `(self)` Default constructor. **~~~** **__init__** `(self, dialogData)` Copy constructor. :param `dialogData`: :type `dialogData`: PrintDialogData **~~~** **__init__** `(self, printData)` Construct an object from a print dialog data object. :param `printData`: :type `printData`: PrintData **~~~** .. method:: EnableHelp(self, flag) Enables or disables the "Help" button. :param `flag`: :type `flag`: bool .. method:: EnablePageNumbers(self, flag) Enables or disables the "Page numbers" controls. :param `flag`: :type `flag`: bool .. method:: EnablePrintToFile(self, flag) Enables or disables the "Print to file" checkbox. :param `flag`: :type `flag`: bool .. method:: EnableSelection(self, flag) Enables or disables the "Selection" radio button. :param `flag`: :type `flag`: bool .. method:: GetAllPages(self) Returns ``True`` if the user requested that all pages be printed. :rtype: `bool` .. method:: GetCollate(self) Returns ``True`` if the user requested that the document(s) be collated. :rtype: `bool` .. method:: GetFromPage(self) Returns the `from` page number, as entered by the user. :rtype: `int` .. method:: GetMaxPage(self) Returns the `maximum` page number. :rtype: `int` .. method:: GetMinPage(self) Returns the `minimum` page number. :rtype: `int` .. method:: GetNoCopies(self) Returns the number of copies requested by the user. :rtype: `int` .. method:: GetPrintData(self) Returns a reference to the internal :ref:`PrintData` object. :rtype: :ref:`PrintData` .. method:: GetPrintToFile(self) Returns ``True`` if the user has selected printing to a file. :rtype: `bool` .. method:: GetSelection(self) Returns ``True`` if the user requested that the selection be printed (where "selection" is a concept specific to the application). :rtype: `bool` .. method:: GetToPage(self) Returns the `"print to"` page number, as entered by the user. :rtype: `int` .. method:: IsOk(self) 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``. :rtype: `bool` .. method:: SetCollate(self, flag) Sets the "Collate" checkbox to ``True`` or ``False``. :param `flag`: :type `flag`: bool .. method:: SetFromPage(self, page) Sets the `from` page number. :param `page`: :type `page`: int .. method:: SetMaxPage(self, page) Sets the `maximum` page number. :param `page`: :type `page`: int .. method:: SetMinPage(self, page) Sets the `minimum` page number. :param `page`: :type `page`: int .. method:: SetNoCopies(self, n) Sets the default number of copies the user has requested to be printed out. :param `n`: :type `n`: int .. method:: SetPrintData(self, printData) Sets the internal :ref:`PrintData`. :param `printData`: :type `printData`: PrintData .. method:: SetPrintToFile(self, flag) Sets the "Print to file" checkbox to ``True`` or ``False``. :param `flag`: :type `flag`: bool .. method:: SetSelection(self, flag) Selects the "Selection" radio button. The effect of printing the selection depends on how the application implements this command, if at all. :param `flag`: :type `flag`: bool .. method:: SetToPage(self, page) Sets the `"print to"` page number. :param `page`: :type `page`: int .. method:: __nonzero__(self) :rtype: `int` .. attribute:: AllPages See :meth:`~PrintDialogData.GetAllPages` .. attribute:: Collate See :meth:`~PrintDialogData.GetCollate` and :meth:`~PrintDialogData.SetCollate` .. attribute:: FromPage See :meth:`~PrintDialogData.GetFromPage` and :meth:`~PrintDialogData.SetFromPage` .. attribute:: MaxPage See :meth:`~PrintDialogData.GetMaxPage` and :meth:`~PrintDialogData.SetMaxPage` .. attribute:: MinPage See :meth:`~PrintDialogData.GetMinPage` and :meth:`~PrintDialogData.SetMinPage` .. attribute:: NoCopies See :meth:`~PrintDialogData.GetNoCopies` and :meth:`~PrintDialogData.SetNoCopies` .. attribute:: PrintData See :meth:`~PrintDialogData.GetPrintData` and :meth:`~PrintDialogData.SetPrintData` .. attribute:: PrintToFile See :meth:`~PrintDialogData.GetPrintToFile` and :meth:`~PrintDialogData.SetPrintToFile` .. attribute:: Selection See :meth:`~PrintDialogData.GetSelection` and :meth:`~PrintDialogData.SetSelection` .. attribute:: ToPage See :meth:`~PrintDialogData.GetToPage` and :meth:`~PrintDialogData.SetToPage`