A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://wxpython.org/Phoenix/docs/html/wx.AnyButton.html below:

wx.AnyButton — wxPython Phoenix 4.2.4a1 documentation

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¶ Properties Summary¶ Class API¶
class wx.AnyButton(Control)¶

Possible constructors:

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.


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)


GetBitmapMargins(self)¶

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

Return type:

wx.Size

Added in version 2.9.1.


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.


SetBitmapCurrent(self, bitmap)¶

Sets the bitmap to be shown when the mouse is over the button.

If bitmap is invalid, the normal bitmap will be used in the current state.

Parameters:

bitmap (wx.BitmapBundle)

Return type:

None

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


SetBitmapDisabled(self, bitmap)¶

Sets the bitmap for the disabled button appearance.

If bitmap is invalid, the disabled bitmap is set to the automatically generated greyed out version of the normal bitmap, i.e. the same bitmap as is used by default if this method is not called at all. Use SetBitmap with an invalid bitmap to remove the bitmap completely (for all states).

Parameters:

bitmap (wx.BitmapBundle)

Return type:

None

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


SetBitmapFocus(self, bitmap)¶

Sets the bitmap for the button appearance when it has the keyboard focus.

If bitmap is invalid, the normal bitmap will be used in the focused state.

Parameters:

bitmap (wx.BitmapBundle)

Return type:

None

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


SetBitmapLabel(self, bitmap)¶

Sets the bitmap label for the button.

Parameters:

bitmap (wx.BitmapBundle)

Return type:

None

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

Note

This is the bitmap used for the unselected state, and for all other states if no other bitmaps are provided.


SetBitmapMargins(self, *args, **kw)¶

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

This method is currently only implemented under MSW. If it is not called, default margin is used around the bitmap.

Added in version 2.9.1.

Overloaded Implementations:

SetBitmapMargins (self, x, y)

Parameters:
  • x (int)

  • y (int)

Return type:

None

SetBitmapMargins (self, sz)

Parameters:

sz (wx.Size)

Return type:

None



SetBitmapPosition(self, dir)¶

Set the position at which the bitmap is displayed.

This method should only be called if the button does have an associated bitmap.

Parameters:

dir (Direction) – Direction in which the bitmap should be positioned, one of wx.LEFT, wx.RIGHT, wx.TOP or wx.BOTTOM.

Return type:

None

Added in version 2.9.1.


SetBitmapPressed(self, bitmap)¶

Sets the bitmap for the selected (depressed) button appearance.

Parameters:

bitmap (wx.BitmapBundle)

Return type:

None

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


Properties¶
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


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4