.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.PageSetupDialogData:
==========================================================================================================================================
|phoenix_title| **wx.PageSetupDialogData**
==========================================================================================================================================
This class holds a variety of information related to :ref:`wx.PageSetupDialog`.
It contains a :ref:`wx.PrintData` member which is used to hold basic printer configuration data (as opposed to the user-interface configuration settings stored by :ref:`wx.PageSetupDialogData`).
.. seealso:: :ref:`Printing Framework Overview <printing framework overview>`, :ref:`wx.PageSetupDialog`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>PageSetupDialogData</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.PageSetupDialogData_inheritance.png" alt="Inheritance diagram of PageSetupDialogData" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.PageSetupDialogData.html" title="This class holds a variety of information related to wx.PageSetupDialog." alt="" coords="5,83,196,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="57,5,145,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PageSetupDialogData.__init__` Default constructor.
:meth:`~wx.PageSetupDialogData.EnableHelp` Enables or disables the "Help" button (Windows only).
:meth:`~wx.PageSetupDialogData.EnableMargins` Enables or disables the margin controls (Windows only).
:meth:`~wx.PageSetupDialogData.EnableOrientation` Enables or disables the orientation control (Windows only).
:meth:`~wx.PageSetupDialogData.EnablePaper` Enables or disables the paper size control (Windows only).
:meth:`~wx.PageSetupDialogData.EnablePrinter` Enables or disables the "Printer" button, which invokes a printer setup dialog.
:meth:`~wx.PageSetupDialogData.GetDefaultInfo` Returns ``True`` if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).
:meth:`~wx.PageSetupDialogData.GetDefaultMinMargins` Returns ``True`` if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).
:meth:`~wx.PageSetupDialogData.GetEnableHelp` Returns ``True`` if the printer setup button is enabled.
:meth:`~wx.PageSetupDialogData.GetEnableMargins` Returns ``True`` if the margin controls are enabled (Windows only).
:meth:`~wx.PageSetupDialogData.GetEnableOrientation` Returns ``True`` if the orientation control is enabled (Windows only).
:meth:`~wx.PageSetupDialogData.GetEnablePaper` Returns ``True`` if the paper size control is enabled (Windows only).
:meth:`~wx.PageSetupDialogData.GetEnablePrinter` Returns ``True`` if the printer setup button is enabled.
:meth:`~wx.PageSetupDialogData.GetMarginBottomRight` Returns the right (x) and bottom (y) margins in millimetres.
:meth:`~wx.PageSetupDialogData.GetMarginTopLeft` Returns the left (x) and top (y) margins in millimetres.
:meth:`~wx.PageSetupDialogData.GetMinMarginBottomRight` Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
:meth:`~wx.PageSetupDialogData.GetMinMarginTopLeft` Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
:meth:`~wx.PageSetupDialogData.GetPaperId` Returns the paper id (stored in the internal :ref:`wx.PrintData` object).
:meth:`~wx.PageSetupDialogData.GetPaperSize` Returns the paper size in millimetres.
:meth:`~wx.PageSetupDialogData.GetPrintData` Returns a reference to the print data associated with this object.
:meth:`~wx.PageSetupDialogData.IsOk` Returns ``True`` if the print data associated with the dialog data is valid.
:meth:`~wx.PageSetupDialogData.SetDefaultInfo` Pass ``True`` if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).
:meth:`~wx.PageSetupDialogData.SetDefaultMinMargins` Pass ``True`` if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).
:meth:`~wx.PageSetupDialogData.SetMarginBottomRight` Sets the right (x) and bottom (y) margins in millimetres.
:meth:`~wx.PageSetupDialogData.SetMarginTopLeft` Sets the left (x) and top (y) margins in millimetres.
:meth:`~wx.PageSetupDialogData.SetMinMarginBottomRight` Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
:meth:`~wx.PageSetupDialogData.SetMinMarginTopLeft` Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
:meth:`~wx.PageSetupDialogData.SetPaperId` Sets the paper size id.
:meth:`~wx.PageSetupDialogData.SetPaperSize` Sets the paper size in millimetres.
:meth:`~wx.PageSetupDialogData.SetPrintData` Sets the print data associated with this object.
:meth:`~wx.PageSetupDialogData.__bool__`
:meth:`~wx.PageSetupDialogData.__nonzero__`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.PageSetupDialogData.MarginBottomRight` See :meth:`~wx.PageSetupDialogData.GetMarginBottomRight` and :meth:`~wx.PageSetupDialogData.SetMarginBottomRight`
:attr:`~wx.PageSetupDialogData.MarginTopLeft` See :meth:`~wx.PageSetupDialogData.GetMarginTopLeft` and :meth:`~wx.PageSetupDialogData.SetMarginTopLeft`
:attr:`~wx.PageSetupDialogData.MinMarginBottomRight` See :meth:`~wx.PageSetupDialogData.GetMinMarginBottomRight` and :meth:`~wx.PageSetupDialogData.SetMinMarginBottomRight`
:attr:`~wx.PageSetupDialogData.MinMarginTopLeft` See :meth:`~wx.PageSetupDialogData.GetMinMarginTopLeft` and :meth:`~wx.PageSetupDialogData.SetMinMarginTopLeft`
:attr:`~wx.PageSetupDialogData.PaperId` See :meth:`~wx.PageSetupDialogData.GetPaperId` and :meth:`~wx.PageSetupDialogData.SetPaperId`
:attr:`~wx.PageSetupDialogData.PaperSize` See :meth:`~wx.PageSetupDialogData.GetPaperSize` and :meth:`~wx.PageSetupDialogData.SetPaperSize`
:attr:`~wx.PageSetupDialogData.PrintData` See :meth:`~wx.PageSetupDialogData.GetPrintData` and :meth:`~wx.PageSetupDialogData.SetPrintData`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PageSetupDialogData(Object)
**Possible constructors**::
PageSetupDialogData()
PageSetupDialogData(data)
PageSetupDialogData(printData)
This class holds a variety of information related to
PageSetupDialog.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, data)`
Copy constructor.
:param `data`:
:type `data`: wx.PageSetupDialogData
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, printData)`
Construct an object from a print data object.
:param `printData`:
:type `printData`: wx.PrintData
:html:`<hr class="overloadsep" /><br />`
.. method:: EnableHelp(self, flag)
Enables or disables the "Help" button (Windows only).
:param `flag`:
:type `flag`: bool
.. method:: EnableMargins(self, flag)
Enables or disables the margin controls (Windows only).
:param `flag`:
:type `flag`: bool
.. method:: EnableOrientation(self, flag)
Enables or disables the orientation control (Windows only).
:param `flag`:
:type `flag`: bool
.. method:: EnablePaper(self, flag)
Enables or disables the paper size control (Windows only).
:param `flag`:
:type `flag`: bool
.. method:: EnablePrinter(self, flag)
Enables or disables the "Printer" button, which invokes a printer setup dialog.
:param `flag`:
:type `flag`: bool
.. method:: GetDefaultInfo(self)
Returns ``True`` if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).
:rtype: `bool`
.. method:: GetDefaultMinMargins(self)
Returns ``True`` if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).
:rtype: `bool`
.. method:: GetEnableHelp(self)
Returns ``True`` if the printer setup button is enabled.
:rtype: `bool`
.. method:: GetEnableMargins(self)
Returns ``True`` if the margin controls are enabled (Windows only).
:rtype: `bool`
.. method:: GetEnableOrientation(self)
Returns ``True`` if the orientation control is enabled (Windows only).
:rtype: `bool`
.. method:: GetEnablePaper(self)
Returns ``True`` if the paper size control is enabled (Windows only).
:rtype: `bool`
.. method:: GetEnablePrinter(self)
Returns ``True`` if the printer setup button is enabled.
:rtype: `bool`
.. method:: GetMarginBottomRight(self)
Returns the right (x) and bottom (y) margins in millimetres.
:rtype: :ref:`wx.Point`
.. method:: GetMarginTopLeft(self)
Returns the left (x) and top (y) margins in millimetres.
:rtype: :ref:`wx.Point`
.. method:: GetMinMarginBottomRight(self)
Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
Units are in millimetres.
:rtype: :ref:`wx.Point`
.. method:: GetMinMarginTopLeft(self)
Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
Units are in millimetres.
:rtype: :ref:`wx.Point`
.. method:: GetPaperId(self)
Returns the paper id (stored in the internal :ref:`wx.PrintData` object).
:rtype: :ref:`wx.PaperSize`
.. seealso:: :meth:`wx.PrintData.SetPaperId`
.. method:: GetPaperSize(self)
Returns the paper size in millimetres.
:rtype: :ref:`wx.Size`
.. method:: GetPrintData(self)
Returns a reference to the print data associated with this object.
:rtype: :ref:`wx.PrintData`
.. method:: IsOk(self)
Returns ``True`` if the print data associated with the dialog data is valid.
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:: SetDefaultInfo(self, flag)
Pass ``True`` if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).
:param `flag`:
:type `flag`: bool
.. method:: SetDefaultMinMargins(self, flag)
Pass ``True`` if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).
Units are in millimetres.
:param `flag`:
:type `flag`: bool
.. method:: SetMarginBottomRight(self, pt)
Sets the right (x) and bottom (y) margins in millimetres.
:param `pt`:
:type `pt`: wx.Point
.. method:: SetMarginTopLeft(self, pt)
Sets the left (x) and top (y) margins in millimetres.
:param `pt`:
:type `pt`: wx.Point
.. method:: SetMinMarginBottomRight(self, pt)
Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
Units are in millimetres.
:param `pt`:
:type `pt`: wx.Point
.. method:: SetMinMarginTopLeft(self, pt)
Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
Units are in millimetres.
:param `pt`:
:type `pt`: wx.Point
.. method:: SetPaperId(self, id)
Sets the paper size id.
Calling this function overrides the explicit paper dimensions passed in :meth:`SetPaperSize` .
:param `id`:
:type `id`: wx.PaperSize
.. seealso:: :meth:`wx.PrintData.SetPaperId`
.. method:: SetPaperSize(self, size)
Sets the paper size in millimetres.
If a corresponding paper id is found, it will be set in the internal :ref:`wx.PrintData` object, otherwise the paper size overrides the paper id.
:param `size`:
:type `size`: wx.Size
.. method:: SetPrintData(self, printData)
Sets the print data associated with this object.
:param `printData`:
:type `printData`: wx.PrintData
.. method:: __bool__(self)
:rtype: `int`
.. method:: __nonzero__(self)
:rtype: `int`
.. attribute:: MarginBottomRight
See :meth:`~wx.PageSetupDialogData.GetMarginBottomRight` and :meth:`~wx.PageSetupDialogData.SetMarginBottomRight`
.. attribute:: MarginTopLeft
See :meth:`~wx.PageSetupDialogData.GetMarginTopLeft` and :meth:`~wx.PageSetupDialogData.SetMarginTopLeft`
.. attribute:: MinMarginBottomRight
See :meth:`~wx.PageSetupDialogData.GetMinMarginBottomRight` and :meth:`~wx.PageSetupDialogData.SetMinMarginBottomRight`
.. attribute:: MinMarginTopLeft
See :meth:`~wx.PageSetupDialogData.GetMinMarginTopLeft` and :meth:`~wx.PageSetupDialogData.SetMinMarginTopLeft`
.. attribute:: PaperId
See :meth:`~wx.PageSetupDialogData.GetPaperId` and :meth:`~wx.PageSetupDialogData.SetPaperId`
.. attribute:: PaperSize
See :meth:`~wx.PageSetupDialogData.GetPaperSize` and :meth:`~wx.PageSetupDialogData.SetPaperSize`
.. attribute:: PrintData
See :meth:`~wx.PageSetupDialogData.GetPrintData` and :meth:`~wx.PageSetupDialogData.SetPrintData`