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 Button class itself and the only tiny advantage of using this class is that it allows to specify the bitmap in its constructor, unlike Button. Please see the base class documentation for more information about images support in Button.

Window Styles

This class supports the following styles:

• BU_LEFT: Left-justifies the bitmap label.
• BU_TOP: Aligns the bitmap label to the top of the button.
• BU_RIGHT: Right-justifies the bitmap label.
• BU_BOTTOM: Aligns the bitmap label to the bottom of the button.

Note that the BU_EXACTFIT style supported by 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 CommandEvent parameter.

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

See also

Button

Inheritance Diagram

Inheritance diagram for class BitmapButton

Control Appearance

wxMSW

wxMAC

wxGTK

Known Subclasses

ContextHelpButton

Methods Summary

__init__	Default constructor.
Create	Button creation function for two-step creation.

Class API

---

class BitmapButton(Button)

A bitmap button is a control that contains a bitmap.

Possible constructors:

BitmapButton()

BitmapButton(parent, id=ID_ANY, bitmap=NullBitmap, pos=DefaultPosition,
             size=DefaultSize, style=BU_AUTODRAW, validator=DefaultValidator,
             name=ButtonNameStr)

Methods

---

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

---

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

Constructor, creating and showing a button.

Parameters:

• parent (Window) – Parent window. Must not be None.
• id (int) – Button identifier. The value ID_ANY indicates a default value.
• bitmap (Bitmap) – Bitmap to be displayed.
• pos (Point) – Button position. If DefaultPosition is specified then a default position is chosen.
• size (Size) – Button size. If DefaultSize is specified then the button is sized appropriately for the bitmap.
• style (long) – Window style. See BitmapButton.
• validator (Validator) – Window validator.
• name (string) – Window name.

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 , Validator

---

---

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

Button creation function for two-step creation.

For more details, see BitmapButton .

Parameters:

• parent (Window) –
• id (int) –
• bitmap (Bitmap) –
• pos (Point) –
• size (Size) –
• style (long) –
• validator (Validator) –
• name (string) –

Return type:

bool