Phoenix Logo

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, wx.StdDialogButtonSizer reverts to the Windows implementation.

To use this class, first add buttons to the sizer by calling wx.StdDialogButtonSizer.AddButton (or wx.StdDialogButtonSizer.SetAffirmativeButton , wx.StdDialogButtonSizer.SetNegativeButton or 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.


class_hierarchy Class Hierarchy

Inheritance diagram for class StdDialogButtonSizer:

method_summary Methods Summary

__init__ Constructor for a wx.StdDialogButtonSizer.
AddButton Adds a button to the wx.StdDialogButtonSizer.
CalcMin Implements the calculation of a box sizer’s minimal.
Realize Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit’s interface guidelines.
RecalcSizes Implements the calculation of a box sizer’s dimensions and then sets the size of its children (calling wx.Window.SetSize if the child is a window).
SetAffirmativeButton Sets the affirmative button for the sizer.
SetCancelButton Sets the cancel button for the sizer.
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).


Methods



__init__(self)

Constructor for a wx.StdDialogButtonSizer.



AddButton(self, button)

Adds a button to the 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
Parameters:button (wx.Button) –


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.

Return type: wx.Size


Realize(self)

Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit’s interface guidelines.



RecalcSizes(self)

Implements the calculation of a box sizer’s dimensions and then sets the size of its children (calling wx.Window.SetSize if the child is a window).

It is used internally only and must not be called by the user (call Layout if you want to resize). Documented for information.



SetAffirmativeButton(self, button)

Sets the affirmative button for the sizer.

This allows you to use identifiers other than the standard identifiers outlined above.

Parameters:button (wx.Button) –


SetCancelButton(self, button)

Sets the cancel button for the sizer.

This allows you to use identifiers other than the standard identifiers outlined above.

Parameters:button (wx.Button) –


SetNegativeButton(self, button)

Sets the negative button for the sizer.

This allows you to use identifiers other than the standard identifiers outlined above.

Parameters:button (wx.Button) –