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.
__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. |
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.
Default class constructor.
Parameters: |
|
---|
Add a programmer-defined status in addition to the 5 default status:
- Normal;
- Disabled;
- Hover;
- Pressed;
- Toggled.
Parameters: |
|
---|
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. |
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. |
---|
Draws the button on ButtonPanel. Actually the drawing is done in BPArt.
Parameters: |
|
---|
Enables/disables this instance of ButtonInfo.
Parameters: | enable (bool) – True to enable the button, False otherwise. |
---|
Returns the best size for the button.
Returns: | An instance of wx.Size. |
---|
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. |
Returns the ButtonInfo id.
Returns: | An integer representing the button id. |
---|
Returns the button type (standard or toggle).
Returns: | An integer representing the button type, one of wx.ITEM_NORMAL, wx.ITEM_CHECK. |
---|
Returns the help string shown in the statusbar.
Returns: | A string containing the ButtonInfo long help string. |
---|
Returns the ButtonInfo client rectangle.
Returns: | An instance of wx.Rect. |
---|
Returns the help string shown in a tooltip.
Returns: | A string containing the ButtonInfo short help string. |
---|
Returns the ButtonInfo status.
Returns: | A string containing the ButtonInfo status (one of “Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”). |
---|
Returns the text associated to the button.
Returns: | A string containing the ButtonInfo text. |
---|
Returns the text alignment in the button (bottom or right).
Returns: | An integer representing the ButtonInfo text alignment. |
---|
Returns whether a wx.ITEM_CHECK button is toggled or not.
Returns: | True if the button is toggled, False otherwise. |
---|
Returns whether the button has text or not.
Returns: | True if this ButtonInfo instance has a label, False otherwise. |
---|
Returns the ButtonInfo id.
Returns: | An integer representing the button id. |
---|
Returns True if this instance of ButtonInfo is enabled for input, False otherwise.
Returns the ButtonInfo client rectangle.
Returns: | An instance of wx.Rect. |
---|
Sets the bitmap associated with this instance of ButtonInfo.
Parameters: |
|
---|
Sets the ButtonInfo identifier.
Parameters: | id (integer) – the identifier of the window. |
---|
Sets the button type (standard or toggle).
Parameters: | kind (integer) – one of wx.ITEM_NORMAL, wx.ITEM_CHECK. |
---|
Sets the help string to be shown in the statusbar.
Parameters: | help (string) – the string for the long help. |
---|
Sets the ButtonInfo client rectangle.
Parameters: | rect – an instance of wx.Rect. |
---|
Sets the help string to be shown in a tooltip.
Parameters: | help (string) – the string for the short help. |
---|
Sets the ButtonInfo status.
Parameters: | status (string) – one of “Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”. |
---|
Sets the button label text.
Parameters: | text (string) – the button label string. |
---|
Sets the text alignment in the button (bottom or right).
Parameters: | alignment (integer) – the text alignment in this ButtonInfo instance. |
---|
Sets a wx.ITEM_CHECK button toggled/not toggled.
Parameters: | toggle (bool) – True to toggle the button, False otherwise. |
---|
Returns the ButtonInfo status.
Returns: | A string containing the ButtonInfo status (one of “Pressed”, “Hover”, “Normal”, “Toggled”, “Disabled”). |
---|