wx.BitmapButton

A bitmap button is a control that contains a bitmap.

Notice that since wxWidgets 2.9.1 bitmap display is supported by the base wx.Button class itself and the only tiny advantage of using this class is that it allows specifying the bitmap in its constructor, unlike wx.Button. Please see the base class documentation for more information about images support in wx.Button.

Window Styles

This class supports the following styles:

• wx.BU_LEFT: Left-justifies the bitmap label.

• wx.BU_TOP: Aligns the bitmap label to the top of the button.

• wx.BU_RIGHT: Right-justifies the bitmap label.

• wx.BU_BOTTOM: Aligns the bitmap label to the bottom of the button.

Note that the wx.BU_EXACTFIT style supported by wx.Button is not used by this class as bitmap buttons don’t have any minimal standard size by default.

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.

See also

wx.Button

Class Hierarchy

Inheritance diagram for class BitmapButton:

Control Appearance

wxMSW

wxGTK

wxMAC

Known Subclasses

wx.ContextHelpButton

Methods Summary

__init__	Default constructor.
Create	Button creation function for two-step creation.
CreateCloseButton	Creation function for two-step creation of “Close” button.
GetClassDefaultAttributes
NewCloseButton	Helper function creating a standard-looking “Close” button.

Class API

class wx.BitmapButton(Button)

Possible constructors:

BitmapButton() -> None

BitmapButton(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition,
             size=DefaultSize, style=0, validator=DefaultValidator,
             name=ButtonNameStr) -> None

A bitmap button is a control that contains a bitmap.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Return type:

None

---

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

Constructor, creating and showing a button.

Parameters:

• parent (wx.Window) – Parent window. Must not be None.

• id (wx.WindowID) – Button identifier. The value wx.ID_ANY indicates a default value.

• bitmap (wx.BitmapBundle) – Bitmap to be displayed.

• pos (wx.Point) – Button position. If wx.DefaultPosition is specified then a default position is chosen.

• size (wx.Size) – Button size. If wx.DefaultSize is specified then the button is sized appropriately for the bitmap.

• style (long) – Window style. See wx.BitmapButton.

• validator (wx.Validator) – Window validator.

• name (string) – Window name.

Return type:

None

Note

The bitmap parameter is normally the only bitmap you need to provide, and wxWidgets will draw the button correctly in its different states. If you want more control, call any of the functions SetBitmapPressed , SetBitmapFocus , SetBitmapDisabled .

See also

Create , wx.Validator

---

---

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

Button creation function for two-step creation.

For more details, see wx.BitmapButton.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• bitmap (wx.BitmapBundle)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• validator (wx.Validator)

• name (string)

Return type:

bool

---

CreateCloseButton(self, parent, winid, name='')

Creation function for two-step creation of “Close” button.

It is usually not necessary to use this function directly as NewCloseButton is more convenient, but, if required, it can be called on a default-constructed wx.BitmapButton object to achieve the same effect.

Parameters:

• parent (wx.Window) – The button parent window, must be not None.

• winid (wx.WindowID) – The identifier for the new button.

• name (string) – The name for the new button.

Return type:

bool

Added in version 4.1/wxWidgets-3.1.5.

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:

variant (WindowVariant)

Return type:

wx.VisualAttributes

---

static NewCloseButton(parent, winid, name='')

Helper function creating a standard-looking “Close” button.

To get the best results, platform-specific code may need to be used to create a small, title bar-like “Close” button. This function is provided to avoid the need to test for the current platform and creates the button with as native look as possible.

Parameters:

• parent (wx.Window) – The button parent window, must be not None.

• winid (wx.WindowID) – The identifier for the new button.

• name (string) – The name for the new button (available since wxWidgets 3.1.5)

Return type:

wx.BitmapButton

Returns:

The new button.

Added in version 2.9.5.