Table Of Contents

Previous topic

StatusBarPane

Next topic

StockCursor

This Page

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

To use this class, first add buttons to the sizer by calling StdDialogButtonSizer.AddButton (or StdDialogButtonSizer.SetAffirmativeButton , StdDialogButtonSizer.SetNegativeButton or 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 ID_SAVE, on Mac OS X the button will be renamed to “Save” and the ID_NO button will be renamed to “Don’t Save” in accordance with the Mac OS X Human Interface Guidelines.


class_hierarchy Inheritance Diagram

Inheritance diagram for class StdDialogButtonSizer

Inheritance diagram of StdDialogButtonSizer


method_summary Methods Summary

__init__ Constructor for a StdDialogButtonSizer.
AddButton Adds a button to the 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 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 StdDialogButtonSizer(BoxSizer)

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).

Possible constructors:

StdDialogButtonSizer()

Methods



__init__(self)

Constructor for a StdDialogButtonSizer.



AddButton(self, button)

Adds a button to the StdDialogButtonSizer.

The button must have one of the following identifiers:

  • ID_OK
  • ID_YES
  • ID_SAVE
  • ID_APPLY
  • ID_CLOSE
  • ID_NO
  • ID_CANCEL
  • ID_HELP
  • ID_CONTEXT_HELP
Parameters:button (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: 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 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 (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 (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 (Button) –