wx.lib.agw.buttonpanel.ButtonInfo¶

This class holds information about every button that is added to ButtonPanel. It is an auxiliary class that you should use every time you add a button.

Class Hierarchy¶

Inheritance diagram for class ButtonInfo:

Known Superclasses¶

wx.lib.agw.buttonpanel.Control

Methods Summary¶

`__init__`	Default class constructor.
`AddStatus`	Add a programmer-defined status in addition to the 5 default status
`CheckRefresh`	Checks whether a `ButtonPanel` repaint is needed or not. This is a convenience function.
`Draw`	Draws the button on `ButtonPanel`. Actually the drawing is done in `BPArt`.
`Enable`	Enables/disables this instance of `ButtonInfo`.
`GetBestSize`	Returns the best size for the button.
`GetBitmap`	Returns the bitmap associated with this instance of `ButtonInfo`.
`GetId`	Returns the `ButtonInfo` id.
`GetKind`	Returns the button type (standard or toggle).
`GetLongHelp`	Returns the help string shown in the statusbar.
`GetRect`	Returns the `ButtonInfo` client rectangle.
`GetShortHelp`	Returns the help string shown in a tooltip.
`GetStatus`	Returns the `ButtonInfo` status.
`GetText`	Returns the text associated to the button.
`GetTextAlignment`	Returns the text alignment in the button (bottom or right).
`GetToggled`	Returns whether a `wx.ITEM_CHECK` button is toggled or not.
`HasText`	Returns whether the button has text or not.
`IsEnabled`	Returns `True` if this instance of `ButtonInfo` is enabled for input,
`SetBitmap`	Sets the bitmap associated with this instance of `ButtonInfo`.
`SetId`	Sets the `ButtonInfo` identifier.
`SetKind`	Sets the button type (standard or toggle).
`SetLongHelp`	Sets the help string to be shown in the statusbar.
`SetRect`	Sets the `ButtonInfo` client rectangle.
`SetShortHelp`	Sets the help string to be shown in a tooltip.
`SetStatus`	Sets the `ButtonInfo` status.
`SetText`	Sets the button label text.
`SetTextAlignment`	Sets the text alignment in the button (bottom or right).
`SetToggled`	Sets a `wx.ITEM_CHECK` button toggled/not toggled.

Properties Summary¶

`Bitmap`	Returns the bitmap associated with this instance of `ButtonInfo`.
`Id`	Returns the `ButtonInfo` id.
`Rect`	Returns the `ButtonInfo` client rectangle.
`Status`	Returns the `ButtonInfo` status.

Class API¶

class ButtonInfo(Control)¶

This class holds information about every button that is added to ButtonPanel. It is an auxiliary class that you should use every time you add a button.

Methods¶

__init__(self, parent, id=wx.ID_ANY, bmp=wx.NullBitmap, status="Normal", text="", kind=wx.ITEM_NORMAL, shortHelp="", longHelp="")¶

Default class constructor.

Parameters:

parent – the parent window (ButtonPanel);
id (integer) – the button id;
bmp (wx.Bitmap) – the associated bitmap;
status (string) – button status (“Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”);
text (string) – text to be displayed either below of to the right of the button;
kind (integer) – button kind, may be wx.ITEM_NORMAL for standard buttons or wx.ITEM_CHECK for toggle buttons;
shortHelp (string) – a short help to be shown in the button tooltip;
longHelp (string) – this string is shown in the statusbar (if any) of the parent frame when the mouse pointer is inside the button.

AddStatus(self, name="Custom", bmp=wx.NullBitmap)¶

Add a programmer-defined status in addition to the 5 default status:

Normal;
Disabled;
Hover;
Pressed;
Toggled.

Parameters:	name (string) – the new status name; bmp (wx.Bitmap) – the bitmap associated with the new status.

CheckRefresh(self, status)¶

Checks whether a ButtonPanel repaint is needed or not. This is a convenience function.

Parameters:	status (bool) – the status of a newly added `ButtonInfo` or a change in the `ButtonInfo` status.

Draw(self, dc, rect)¶

Draws the button on ButtonPanel. Actually the drawing is done in BPArt.

Parameters:	dc – an instance of `wx.DC`; rect (wx.Rect) – the main caption text client rectangle.

Enable(self, enable=True)¶

Enables/disables this instance of ButtonInfo.

Parameters:	enable (bool) – `True` to enable the button, `False` otherwise.

GetBestSize(self)¶

Returns the best size for the button.

Returns:	An instance of `wx.Size`.

GetBitmap(self, status=None)¶

Returns the bitmap associated with this instance of ButtonInfo.

Parameters:	status (string) – the `ButtonInfo` status (“Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”).
Returns:	An instance of `wx.Bitmap`.

GetId(self)¶

Returns the ButtonInfo id.

Returns:	An integer representing the button id.

GetKind(self)¶

Returns the button type (standard or toggle).

Returns:	An integer representing the button type, one of `wx.ITEM_NORMAL`, `wx.ITEM_CHECK`.

GetLongHelp(self)¶

Returns the help string shown in the statusbar.

Returns:	A string containing the `ButtonInfo` long help string.

GetRect(self)¶

Returns the ButtonInfo client rectangle.

Returns:	An instance of `wx.Rect`.

GetShortHelp(self)¶

Returns the help string shown in a tooltip.

Returns:	A string containing the `ButtonInfo` short help string.

GetStatus(self)¶

Returns the ButtonInfo status.

Returns:	A string containing the `ButtonInfo` status (one of “Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”).

GetText(self)¶

Returns the text associated to the button.

Returns:	A string containing the `ButtonInfo` text.

GetTextAlignment(self)¶

Returns the text alignment in the button (bottom or right).

Returns:	An integer representing the `ButtonInfo` text alignment.

GetToggled(self)¶

Returns whether a wx.ITEM_CHECK button is toggled or not.

Returns:	`True` if the button is toggled, `False` otherwise.

HasText(self)¶

Returns whether the button has text or not.

Returns:	`True` if this `ButtonInfo` instance has a label, `False` otherwise.

IsEnabled(self)¶: Returns True if this instance of ButtonInfo is enabled for input, False otherwise.

SetBitmap(self, bmp, status="Normal")¶

Sets the bitmap associated with this instance of ButtonInfo.

Parameters:	bmp – a valid `wx.Bitmap` object; status (string) – the `ButtonInfo` status (“Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”).

SetId(self, id)¶

Sets the ButtonInfo identifier.

Parameters:	id (integer) – the identifier of the window.

SetKind(self, kind=wx.ITEM_NORMAL)¶

Sets the button type (standard or toggle).

Parameters:	kind (integer) – one of `wx.ITEM_NORMAL`, `wx.ITEM_CHECK`.

SetLongHelp(self, help="")¶

Sets the help string to be shown in the statusbar.

Parameters:	help (string) – the string for the long help.

SetRect(self, rect)¶

Sets the ButtonInfo client rectangle.

Parameters:	rect – an instance of `wx.Rect`.

SetShortHelp(self, help="")¶

Sets the help string to be shown in a tooltip.

Parameters:	help (string) – the string for the short help.

SetStatus(self, status)¶

Sets the ButtonInfo status.

Parameters:	status (string) – one of “Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”.

SetText(self, text="")¶

Sets the button label text.

Parameters:	text (string) – the button label string.

SetTextAlignment(self, alignment)¶

Sets the text alignment in the button (bottom or right).

Parameters:	alignment (integer) – the text alignment in this `ButtonInfo` instance.

SetToggled(self, toggle=True)¶

Sets a wx.ITEM_CHECK button toggled/not toggled.

Parameters:	toggle (bool) – `True` to toggle the button, `False` otherwise.

Properties¶

Bitmap¶