Package wx :: Package lib :: Package agw :: Module buttonpanel :: Class ButtonInfo
[frames | no frames]

Type ButtonInfo

object --+            
         |            
    Object --+        
             |        
    EvtHandler --+    
                 |    
           Control --+
                     |
                    ButtonInfo


Method Summary
  __init__(self, parent, id, bmp, status, text, kind, shortHelp, longHelp)
Default class constructor.
  AddStatus(self, name, bmp)
Add a programmer-defined status in addition to the 5 default status: - Normal; - Disabled; - Hover; - Pressed; - Toggled.
  CheckRefresh(self, status)
Checks whether a ButtonPanel repaint is needed or not.
  Draw(self, dc, rect)
Draws the button on ButtonPanel.
  Enable(self, enable)
  GetBestSize(self)
Returns the best size for the button.
  GetBitmap(self, status)
Returns the associated bitmap.
  GetId(self)
Returns the button id.
  GetKind(self)
Returns the button type (standard or toggle).
  GetLongHelp(self)
Returns the help string shown in the statusbar.
  GetRect(self)
Returns the button rect.
  GetShortHelp(self)
Returns the help string shown in a tootip.
  GetStatus(self)
Returns the button status.
  GetText(self)
Returns the text associated to the button.
  GetTextAlignment(self)
Returns the text alignment in the button (bottom or right).
  GetToggled(self)
Returns whether a wx.ITEM_CHECK button is toggled or not.
  HasText(self)
Returns whether the button has text or not.
  IsEnabled(self)
  SetBitmap(self, bmp, status)
Sets the associated bitmap.
  SetId(self, id)
Sets the button id.
  SetKind(self, kind)
Sets the button type (standard or toggle).
  SetLongHelp(self, help)
Sets the help string to be shown in the statusbar.
  SetRect(self, rect)
Sets the button rect.
  SetShortHelp(self, help)
Sets the help string to be shown in a tootip.
  SetStatus(self, status)
Sets the button status.
  SetText(self, text)
Sets the text of the button.
  SetTextAlignment(self, alignment)
Sets the text alignment in the button (bottom or right).
  SetToggled(self, toggle)
Sets a wx.ITEM_CHECK button toggled/not toggled.

Property Summary
  Bitmap: Returns the associated bitmap.
  Id: Returns the button id.
  Rect: Returns the button rect.
  Status: Returns the button status.

Method Details

__init__(self, parent, id=-1, bmp=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap ..., status='Normal', text='', kind=0, shortHelp='', longHelp='')
(Constructor)

Default class constructor.

Parameters:
- parent: the parent window (ButtonPanel);
- id: the button id;
- bmp: the associated bitmap;
- status: button status (pressed, hovered, normal).
- text: text to be displayed either below of to the right of the button
- kind: button kind, may be wx.ITEM_NORMAL for standard buttons or
  wx.ITEM_CHECK for toggle buttons;
- shortHelp: a short help to be shown in the button tooltip;
- longHelp: this string is shown in the statusbar (if any) of the parent
  frame when the mouse pointer is inside the button.
Overrides:
wx.lib.agw.buttonpanel.Control.__init__

AddStatus(self, name='Custom', bmp=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap ...)

Add a programmer-defined status in addition to the 5 default status: - Normal; - Disabled; - Hover; - Pressed; - Toggled.

CheckRefresh(self, status)

Checks whether a ButtonPanel repaint is needed or not. Convenience function.

Draw(self, dc, rect)

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

Overrides:
wx.lib.agw.buttonpanel.Control.Draw

GetBestSize(self)

Returns the best size for the button.

Overrides:
wx.lib.agw.buttonpanel.Control.GetBestSize

GetBitmap(self, status=None)

Returns the associated bitmap.

GetId(self)

Returns the button id.

Overrides:
wx.lib.agw.buttonpanel.Control.GetId

GetKind(self)

Returns the button type (standard or toggle).

GetLongHelp(self)

Returns the help string shown in the statusbar.

GetRect(self)

Returns the button rect.

GetShortHelp(self)

Returns the help string shown in a tootip.

GetStatus(self)

Returns the button status.

GetText(self)

Returns the text associated to the button.

GetTextAlignment(self)

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

GetToggled(self)

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

HasText(self)

Returns whether the button has text or not.

SetBitmap(self, bmp, status='Normal')

Sets the associated bitmap.

SetId(self, id)

Sets the button id.

SetKind(self, kind=0)

Sets the button type (standard or toggle).

SetLongHelp(self, help='')

Sets the help string to be shown in the statusbar.

SetRect(self, rect)

Sets the button rect.

SetShortHelp(self, help='')

Sets the help string to be shown in a tootip.

SetStatus(self, status)

Sets the button status.

SetText(self, text='')

Sets the text of the button.

SetTextAlignment(self, alignment)

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

SetToggled(self, toggle=True)

Sets a wx.ITEM_CHECK button toggled/not toggled.


Property Details

Bitmap

Returns the associated bitmap.

Get Method:
GetBitmap(self, status)
Set Method:
SetBitmap(self, bmp, status)

Id

Returns the button id.

Get Method:
GetId(self)
Set Method:
SetId(self, id)

Rect

Returns the button rect.

Get Method:
GetRect(self)
Set Method:
SetRect(self, rect)

Status

Returns the button status.

Get Method:
GetStatus(self)
Set Method:
SetStatus(self, status)

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:51:33 2009 http://epydoc.sf.net