Package wx :: Package lib :: Package agw :: Module flatmenu :: Class FlatToolbarItem

[frames | no frames]

## Class FlatToolbarItem

This class represents a toolbar item.

Method Summary
| ``__init__`(self, controlType, id, label, disabledBmp, kind, shortHelp, longHelp)` Default class constructor.
| ``Enable`(self, enable)` Enables or disables the tool.
| ``GetBitmap`(self)` Returns the tool bitmap.
| ``GetCustomControl`(self)` Returns the associated custom control.
| ``GetDisabledBitmap`(self)` Returns the tool disabled bitmap.
| ``GetGroup`(self)` Returns group ID for radio item, -1 otherwise
| ``GetId`(self)` Gets the tool id.
| ``GetLabel`(self)` Returns the tool label.
| `GetLongHelp(self)`
| `GetShortHelp(self)`
| ``IsChecked`(self)` Same as IsSelected.
| ``IsCheckItem`(self)` Returns True if the item is a radio item.
| ``IsCustomControl`(self)` Returns whether the tool is a custom control or not.
| ``IsEnabled`(self)` Returns whether the tool is enabled or not.
| ``IsRadioItem`(self)` Returns True if the item is a radio item.
| ``IsRegularItem`(self)` Returns whether the tool is a standard tool or not.
| ``IsSelected`(self)` Returns whether the tool is selected or checked.
| ``IsSeparator`(self)` Returns whether the tool is a separator or not.
| ``Select`(self, select)` Selects or checks a radio or check item
| ``SetBitmap`(self, bmp)` Sets the tool bitmap.
| ``SetDisabledBitmap`(self, bmp)` Sets the tool disabled bitmap.
| ``SetGroup`(self, group)` Sets group ID for a radio item, for other items does nothing
| ``SetLabel`(self, label)` Sets the tool label.
| `SetLongHelp(self, help)`
| `SetShortHelp(self, help)`
| ``Toggle`(self)` Toggles a check item

Method Details

### __init__(self, controlType=None, id=-1, label='', disabledBmp=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap ..., kind=0, shortHelp='', longHelp='')
(Constructor)

Default class constructor.

### Enable(self, enable=True)

Enables or disables the tool.

### GetBitmap(self)

Returns the tool bitmap.

### GetCustomControl(self)

Returns the associated custom control.

### GetDisabledBitmap(self)

Returns the tool disabled bitmap.

### GetGroup(self)

Returns group ID for radio item, -1 otherwise

### GetId(self)

Gets the tool id.

### GetLabel(self)

Returns the tool label.

### IsChecked(self)

Same as IsSelected. More intuitive for check items through.

### IsCheckItem(self)

Returns True if the item is a radio item.

### IsCustomControl(self)

Returns whether the tool is a custom control or not.

### IsEnabled(self)

Returns whether the tool is enabled or not.

### IsRadioItem(self)

Returns True if the item is a radio item.

### IsRegularItem(self)

Returns whether the tool is a standard tool or not.

### IsSelected(self)

Returns whether the tool is selected or checked.

### IsSeparator(self)

Returns whether the tool is a separator or not.

### Select(self, select=True)

Selects or checks a radio or check item

### SetBitmap(self, bmp)

Sets the tool bitmap.

### SetDisabledBitmap(self, bmp)

Sets the tool disabled bitmap.

### SetGroup(self, group)

Sets group ID for a radio item, for other items does nothing

### SetLabel(self, label)

Sets the tool label.

### Toggle(self)

Toggles a check item

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:53:34 2009 | http://epydoc.sf.net