Phoenix Logo

phoenix_title wx.Button

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

It may be placed on a dialog box or on a wx.Panel panel, or indeed on almost any other window.

By default, i.e. if none of the alignment styles are specified, the label is centered both horizontally and vertically. If the button has both a label and a bitmap, the alignment styles above specify the location of the rectangle combining both the label and the bitmap and the bitmap position set with wx.Button.SetBitmapPosition defines the relative position of the bitmap with respect to the label (however currently non-default alignment combinations are not implemented on all platforms).

Since version 2.9.1 wx.Button supports showing both text and an image (currently only when using wxMSW, wxGTK or OSX/Cocoa ports), see SetBitmap and SetBitmapLabel SetBitmapDisabled &c methods. In the previous wxWidgets versions this functionality was only available in (the now trivial) wx.BitmapButton class which was only capable of showing an image without text.

A button may have either a single image for all states or different images for the following states (different images are not currently supported under OS X where the normal image is used for all states):

  • normal: the default state
  • disabled: bitmap shown when the button is disabled.
  • pressed: bitmap shown when the button is pushed (e.g. while the user keeps the mouse button pressed on it)
  • focus: bitmap shown when the button has keyboard focus (but is not pressed as in this case the button is in the pressed state)
  • current: bitmap shown when the mouse is over the button (but it is not pressed although it may have focus). Notice that if current bitmap is not specified but the current platform UI uses hover images for the buttons (such as Windows or GTK+), then the focus bitmap is used for hover state as well. This makes it possible to set focus bitmap only to get reasonably good behaviour on all platforms.

All of the bitmaps must be of the same size and the normal bitmap must be set first (to a valid bitmap), before setting any other ones. Also, if the size of the bitmaps is changed later, you need to change the size of the normal bitmap before setting any other bitmaps with the new size (and you do need to reset all of them as their original values can be lost when the normal bitmap size changes).

The position of the image inside the button be configured using SetBitmapPosition By default the image is on the left of the text.

Please also notice that GTK+ uses a global setting called gtk-button-images to determine if the images should be shown in the buttons at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no images will be shown, consistently with the native behaviour.

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

events 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 Class Hierarchy

Inheritance diagram for class Button:


appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__ Default constructor.
Create Button creation function for two-step creation.
GetAuthNeeded Returns True if an authentication needed symbol is displayed on the button.
GetClassDefaultAttributes  
GetDefaultSize Returns the default size for the buttons.
GetLabel Returns the string label for the button.
SetAuthNeeded Sets whether an authentication needed symbol should be displayed on the button.
SetDefault This sets the button to be the default item in its top-level window (e.g.
SetLabel Sets the string label for the button.

property_summary Properties Summary

AuthNeeded See GetAuthNeeded and SetAuthNeeded
Label See GetLabel and SetLabel

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

overload 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 OS X can’t display any label at all and while wx.Button will 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:
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 GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters:variant (WindowVariant) –
Return type: wx.VisualAttributes


static GetDefaultSize(win=None)

Returns the default size for the buttons.

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

The optional win argument is new since wxWidgets 3.1.3 and allows to get a per-monitor DPI specific size.

Parameters:win (wx.Window) –
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