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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
|
.. 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.StdDialogButtonSizer:
==========================================================================================================================================
|phoenix_title| **wx.StdDialogButtonSizer**
==========================================================================================================================================
This class creates button layouts which conform to the standard button spacing and ordering defined by the platform or toolkit's user interface guidelines (if such things exist).
By using this class, you can ensure that all your standard dialogs look correct on all major platforms. Currently it conforms to the Windows, GTK+ and Mac OS X human interface guidelines.
When there aren't interface guidelines defined for a particular platform or toolkit, :ref:`wx.StdDialogButtonSizer` reverts to the Windows implementation.
To use this class, first add buttons to the sizer by calling :meth:`wx.StdDialogButtonSizer.AddButton` (or :meth:`wx.StdDialogButtonSizer.SetAffirmativeButton` , :meth:`wx.StdDialogButtonSizer.SetNegativeButton` or :meth:`wx.StdDialogButtonSizer.SetCancelButton` ) and then call Realize in order to create the actual button layout used. Other than these special operations, this sizer works like any other sizer.
If you add a button with ``wx.ID_SAVE``, on Mac OS X the button will be renamed to "Save" and the ``wx.ID_NO`` button will be renamed to "Don't Save" in accordance with the Mac OS X Human Interface Guidelines.
.. seealso:: :ref:`wx.Sizer`, :ref:`Sizers Overview <sizers overview>`, :meth:`wx.Dialog.CreateButtonSizer`
|
|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>StdDialogButtonSizer</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.StdDialogButtonSizer_inheritance.png" alt="Inheritance diagram of StdDialogButtonSizer" 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.BoxSizer.html" title="wx.BoxSizer" alt="" coords="45,160,144,189"/> <area shape="rect" id="node4" href="wx.StdDialogButtonSizer.html" title="wx.StdDialogButtonSizer" alt="" coords="5,237,184,267"/> <area shape="rect" id="node2" href="wx.Sizer.html" title="wx.Sizer" alt="" coords="57,83,131,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="53,5,135,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StdDialogButtonSizer.__init__` Constructor for a :ref:`wx.StdDialogButtonSizer`.
:meth:`~wx.StdDialogButtonSizer.AddButton` Adds a button to the :ref:`wx.StdDialogButtonSizer`.
:meth:`~wx.StdDialogButtonSizer.CalcMin` Implements the calculation of a box sizer's minimal.
:meth:`~wx.StdDialogButtonSizer.Realize` Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.
:meth:`~wx.StdDialogButtonSizer.RecalcSizes` Implements the calculation of a box sizer's dimensions and then sets the size of its children (calling :meth:`wx.Window.SetSize` if the child is a window).
:meth:`~wx.StdDialogButtonSizer.SetAffirmativeButton` Sets the affirmative button for the sizer.
:meth:`~wx.StdDialogButtonSizer.SetCancelButton` Sets the cancel button for the sizer.
:meth:`~wx.StdDialogButtonSizer.SetNegativeButton` Sets the negative button for the sizer.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StdDialogButtonSizer(BoxSizer)
**Possible constructors**::
StdDialogButtonSizer()
This class creates button layouts which conform to the standard button
spacing and ordering defined by the platform or toolkit's user
interface guidelines (if such things exist).
.. method:: __init__(self)
Constructor for a :ref:`wx.StdDialogButtonSizer`.
.. method:: AddButton(self, button)
Adds a button to the :ref:`wx.StdDialogButtonSizer`.
The `button` must have one of the following identifiers:
- ``wx.ID_OK``
- ``wx.ID_YES``
- ``wx.ID_SAVE``
- ``wx.ID_APPLY``
- ``wx.ID_CLOSE``
- ``wx.ID_NO``
- ``wx.ID_CANCEL``
- ``wx.ID_HELP``
- ``wx.ID_CONTEXT_HELP``
:param `button`:
:type `button`: wx.Button
.. method:: CalcMin(self)
Implements the calculation of a box sizer's minimal.
It is used internally only and must not be called by the user. Documented for information.
:rtype: :ref:`wx.Size`
.. method:: Realize(self)
Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.
.. method:: RecalcSizes(self)
Implements the calculation of a box sizer's dimensions and then sets the size of its children (calling :meth:`wx.Window.SetSize` if the child is a window).
It is used internally only and must not be called by the user (call :meth:`Layout` if you want to resize). Documented for information.
.. method:: SetAffirmativeButton(self, button)
Sets the affirmative button for the sizer.
This allows you to use identifiers other than the standard identifiers outlined above.
:param `button`:
:type `button`: wx.Button
.. method:: SetCancelButton(self, button)
Sets the cancel button for the sizer.
This allows you to use identifiers other than the standard identifiers outlined above.
:param `button`:
:type `button`: wx.Button
.. method:: SetNegativeButton(self, button)
Sets the negative button for the sizer.
This allows you to use identifiers other than the standard identifiers outlined above.
:param `button`:
:type `button`: wx.Button
|