1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
|
.. 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.PageSetupDialog:
==========================================================================================================================================
|phoenix_title| **wx.PageSetupDialog**
==========================================================================================================================================
This class represents the page setup common dialog.
The page setup dialog contains controls for paper size (letter, A4, A5 etc.), orientation (landscape or portrait), and, only under Windows currently, controls for setting left, top, right and bottom margin sizes in millimetres.
The exact appearance of this dialog varies among the platforms as a native dialog is used when available (currently the case for all major platforms).
When the dialog has been closed, you need to query the :ref:`wx.PageSetupDialogData` object associated with the dialog.
Note that the ``wx.OK`` and Cancel buttons do not destroy the dialog; this must be done by the application.
.. seealso:: :ref:`Printing Framework Overview <printing framework overview>`, :ref:`wx.PrintDialog`, :ref:`wx.PageSetupDialogData`
|
|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>PageSetupDialog</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.PageSetupDialog_inheritance.png" alt="Inheritance diagram of PageSetupDialog" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="39,5,120,35"/> <area shape="rect" id="node2" href="wx.PageSetupDialog.html" title="wx.PageSetupDialog" alt="" coords="5,83,155,112"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PageSetupDialog.__init__` Constructor.
:meth:`~wx.PageSetupDialog.GetPageSetupData` Returns the :ref:`wx.PageSetupDialogData` object associated with the dialog.
:meth:`~wx.PageSetupDialog.ShowModal` Shows the dialog, returning ``ID_OK`` if the user pressed ``wx.OK``, and ``ID_CANCEL`` otherwise.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.PageSetupDialog.PageSetupData` See :meth:`~wx.PageSetupDialog.GetPageSetupData`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PageSetupDialog(Object)
**Possible constructors**::
PageSetupDialog(parent, data=None)
This class represents the page setup common dialog.
.. method:: __init__(self, parent, data=None)
Constructor.
Pass a parent window, and optionally a pointer to a block of page setup data, which will be copied to the print dialog's internal data.
:param `parent`:
:type `parent`: wx.Window
:param `data`:
:type `data`: wx.PageSetupDialogData
.. method:: GetPageSetupData(self)
Returns the :ref:`wx.PageSetupDialogData` object associated with the dialog.
:rtype: :ref:`wx.PageSetupDialogData`
.. method:: ShowModal(self)
Shows the dialog, returning ``ID_OK`` if the user pressed ``wx.OK``, and ``ID_CANCEL`` otherwise.
:rtype: `int`
.. attribute:: PageSetupData
See :meth:`~wx.PageSetupDialog.GetPageSetupData`
|