wx.AnyButton

A class for common button functionality used as the base for the various button classes.

Class Hierarchy

Inheritance diagram for class AnyButton:

Known Subclasses

wx.Button, wx.ToggleButton

Methods Summary

__init__
GetBitmap	Return the bitmap shown by the button.
GetBitmapCurrent	Returns the bitmap used when the mouse is over the button.
GetBitmapDisabled	Returns the bitmap used for the disabled state.
GetBitmapFocus	Returns the bitmap used for the focused state.
GetBitmapLabel	Returns the bitmap for the normal state.
GetBitmapMargins	Get the margins between the bitmap and the text of the button.
GetBitmapPressed	Returns the bitmap used when the button is pressed.
SetBitmap	Sets the bitmap to display in the button.
SetBitmapCurrent	Sets the bitmap to be shown when the mouse is over the button.
SetBitmapDisabled	Sets the bitmap for the disabled button appearance.
SetBitmapFocus	Sets the bitmap for the button appearance when it has the keyboard focus.
SetBitmapLabel	Sets the bitmap label for the button.
SetBitmapMargins	Set the margins between the bitmap and the text of the button.
SetBitmapPosition	Set the position at which the bitmap is displayed.
SetBitmapPressed	Sets the bitmap for the selected (depressed) button appearance.

Properties Summary

Bitmap	See GetBitmap and SetBitmap
BitmapCurrent	See GetBitmapCurrent and SetBitmapCurrent
BitmapDisabled	See GetBitmapDisabled and SetBitmapDisabled
BitmapFocus	See GetBitmapFocus and SetBitmapFocus
BitmapLabel	See GetBitmapLabel and SetBitmapLabel
BitmapMargins	See GetBitmapMargins and SetBitmapMargins
BitmapPressed	See GetBitmapPressed and SetBitmapPressed

Class API

class wx.AnyButton(Control)

Possible constructors:

AnyButton() -> None

A class for common button functionality used as the base for the various button classes.

Methods

__init__(self)

Return type:

None

---

GetBitmap(self)

Return the bitmap shown by the button.

The returned bitmap may be invalid only if the button doesn’t show any images.

Return type:

wx.Bitmap

Added in version 2.9.1.

See also

SetBitmap

---

GetBitmapCurrent(self)

Returns the bitmap used when the mouse is over the button.

The returned bitmap is only valid if SetBitmapCurrent had been previously called.

Return type:

wx.Bitmap

Added in version 2.9.1: (available as BitmapButton.GetBitmapHover() in previous versions)

---

GetBitmapDisabled(self)

Returns the bitmap used for the disabled state.

The returned bitmap is only valid if SetBitmapDisabled had been previously called.

Return type:

wx.Bitmap

Added in version 2.9.1: (available in wx.BitmapButton only in previous versions)

---

GetBitmapFocus(self)

Returns the bitmap used for the focused state.

The returned bitmap is only valid if SetBitmapFocus had been previously called.

Return type:

wx.Bitmap

Added in version 2.9.1: (available in wx.BitmapButton only in previous versions)

---

GetBitmapLabel(self)

Returns the bitmap for the normal state.

This is exactly the same as GetBitmap but uses a name backwards-compatible with wx.BitmapButton.

Return type:

wx.Bitmap

Added in version 2.9.1: (available in wx.BitmapButton only in previous versions)

See also

SetBitmap , SetBitmapLabel

---

GetBitmapMargins(self)

Get the margins between the bitmap and the text of the button.

Return type:

wx.Size

Added in version 2.9.1.

See also

SetBitmapMargins

---

GetBitmapPressed(self)

Returns the bitmap used when the button is pressed.

The returned bitmap is only valid if SetBitmapPressed had been previously called.

Return type:

wx.Bitmap

Added in version 2.9.1: (available as BitmapButton.GetBitmapSelected() in previous versions)

---

SetBitmap(self, bitmap, dir=LEFT)

Sets the bitmap to display in the button.

The bitmap is displayed together with the button label. This method sets up a single bitmap which is used in all button states, use SetBitmapDisabled , SetBitmapPressed , SetBitmapCurrent or SetBitmapFocus to change the individual images used in different states.

Parameters:

• bitmap (wx.BitmapBundle) – The bitmap bundle containing the resolution-dependent bitmaps to display in the button. At default DPI, the size of the bitmap is determined by the default bundle size, i.e. the value returned from wx.BitmapBundle.GetDefaultSize . If the bitmap bundle is invalid, any currently shown bitmaps are removed from the button.

• dir (Direction) – The position of the bitmap inside the button. By default it is positioned to the left of the text, near to the left button border. Other possible values include wx.RIGHT, wx.TOP and wx.BOTTOM.

Return type:

None

Added in version 2.9.1.

See also