wx.Button

 Window Styles

This class supports the following styles:

• wx.BU_LEFT: Left-justifies the label. Windows and GTK+ only.
• wx.BU_TOP: Aligns the label to the top of the button. Windows and GTK+ only.
• wx.BU_RIGHT: Right-justifies the bitmap label. Windows and GTK+ only.
• wx.BU_BOTTOM: Aligns the label to the bottom of the button. Windows and GTK+ only.
• wx.BU_EXACTFIT: By default, all buttons are made of at least the standard button size, even if their contents is small enough to fit into a smaller size. This is done for consistency as most platforms use buttons of the same size in the native dialogs, but can be overridden by specifying this flag. If it is given, the button will be made just big enough for its contents. Notice that under MSW the button will still have at least the standard height, even with this style, if it has a non-empty label.
• wx.BU_NOTEXT: Disables the display of the text label in the button even if it has one or its id is one of the standard stock ids with an associated label: without using this style a button which is only supposed to show a bitmap but uses a standard id would display a label too.
• wx.BORDER_NONE: Creates a button without border. This is currently implemented in MSW, GTK2 and OSX/Cocoa and OSX/Carbon ports but in the latter only applies to buttons with bitmaps and using bitmap of one of the standard sizes only, namely 128x128, 48x48, 24x24 or 16x16. In all the other cases wx.BORDER_NONE is ignored under OSX/Carbon (these restrictions don’t exist in OSX/Cocoa however).

 Events Emitted by this Class

Handlers bound for the following event types will receive a wx.CommandEvent parameter.

• EVT_BUTTON: Process a wxEVT_BUTTON event, when the button is clicked.

 Class Hierarchy

 Inheritance diagram for class Button:

 

 Control Appearance

wxMSW

wxMAC

wxGTK

 Known Subclasses

wx.BitmapButton, wx.adv.CommandLinkButton

 Methods Summary

 Properties Summary

 Class API

class wx.Button(AnyButton)

Possible constructors:

Button()

Button(parent, id=ID_ANY, label="", pos=DefaultPosition,
       size=DefaultSize, style=0, validator=DefaultValidator,
       name=ButtonNameStr)

A button is a control that contains a text string, and is one of the most common elements of a GUI.

Methods

---

__init__(self, *args, **kw)

 Overloaded Implementations:

 

---

 

__init__ (self)

Default constructor.

 

---

 

__init__ (self, parent, id=ID_ANY, label=””, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr)

Constructor, creating and showing a button.

The preferred way to create standard buttons is to use default value of label. If no label is supplied and id is one of standard IDs from this list, a standard label will be used. In other words, if you use a predefined ID_XXX constant, just omit the label completely rather than specifying it. In particular, help buttons (the ones with id of ID_HELP ) under Mac OS X can’t display any label at all and while wx.Buttonwill detect if the standard “Help” label is used and ignore it, using any other label will prevent the button from correctly appearing as a help button and so should be avoided.

In addition to that, the button will be decorated with stock icons under GTK+ 2.

Parameters:

parent (wx.Window) – Parent window. Must not be None. id (wx.WindowID) – Button identifier. A value of ID_ANY indicates a default value. label (string) – Text to be displayed on the button. pos (wx.Point) – Button position. size (wx.Size) – Button size. If the default size is specified then the button is sized appropriately for the text. style (long) – Window style. See wx.Button class description. validator (wx.Validator) – Window validator. name (string) – Window name.

See also

 

Create , wx.Validator

 

---

 

---

Create(self, parent, id=ID_ANY, label="", pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ButtonNameStr)

Button creation function for two-step creation.

For more details, see wx.Button.

Parameters:	parent (wx.Window) – id (wx.WindowID) – label (string) – pos (wx.Point) – size (wx.Size) – style (long) – validator (wx.Validator) – name (string) –
Return type:	bool

---

GetAuthNeeded(self)

Returns True if an authentication needed symbol is displayed on the button.

Return type:	bool

New in version 2.9.1.

Note

 

This method always returns False if the platform is not Windows Vista or newer.

See also

 

SetAuthNeeded

---

static GetDefaultSize()

Returns the default size for the buttons.

It is advised to make all the dialog buttons of the same size and this function allows to retrieve the (platform and current font dependent size) which should be the best suited for this.

Return type:	wx.Size

---

GetLabel(self)

Returns the string label for the button.

Return type:	string

See also

 

SetLabel

---

SetAuthNeeded(self, needed=True)

Sets whether an authentication needed symbol should be displayed on the button.

Parameters:	needed (bool) –

New in version 2.9.1.

Note

 

This method doesn’t do anything if the platform is not Windows Vista or newer.

See also

 

GetAuthNeeded

---

SetDefault(self)

This sets the button to be the default item in its top-level window (e.g.

the panel or the dialog box containing it).

As normal, pressing return causes the default button to be depressed when the return key is pressed.

See also wx.Window.SetFocus which sets the keyboard focus for windows and text panel items, and wx.TopLevelWindow.SetDefaultItem .

Return type:	wx.Window
Returns:	the old default item (possibly None)

Note

 

Under Windows, only dialog box buttons respond to this function.

---

SetLabel(self, label)

Sets the string label for the button.

Parameters:	label (string) – The label to set.

Properties

---

AuthNeeded

See GetAuthNeeded and SetAuthNeeded

---

Label

See GetLabel and SetLabel