Table Of Contents

Previous topic

ToolBar

Next topic

ToolBarToolStyle

This Page

phoenix_title ToolBarToolBase

A toolbar tool represents one item on the toolbar.

It has a unique id (except for the separators), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar.


class_hierarchy Inheritance Diagram

Inheritance diagram for class ToolBarToolBase

Inheritance diagram of ToolBarToolBase


api Class API



class ToolBarToolBase(Object)

A toolbar tool represents one item on the toolbar.

Possible constructors:

ToolBarToolBase(tbar=None, toolid=ID_SEPARATOR, label='',
                bmpNormal=NullBitmap, bmpDisabled=NullBitmap, kind=ITEM_NORMAL,
                clientData=None, shortHelpString='',
                longHelpString='')

ToolBarToolBase(tbar, control, label)

Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, tbar=None, toolid=ID_SEPARATOR, label=’‘, bmpNormal=NullBitmap, bmpDisabled=NullBitmap, kind=ITEM_NORMAL, clientData=None, shortHelpString=’‘, longHelpString=’‘)

Parameters:
  • tbar (ToolBarBase) –
  • toolid (int) –
  • label (string) –
  • bmpNormal (Bitmap) –
  • bmpDisabled (Bitmap) –
  • kind (ItemKind) –
  • clientData (PyUserData) –
  • shortHelpString (string) –
  • longHelpString (string) –



__init__ (self, tbar, control, label)

Parameters:
  • tbar (ToolBarBase) –
  • control (Control) –
  • label (string) –





Attach(self, tbar)
Parameters:tbar (ToolBarBase) –


CanBeToggled(self)
Return type:bool


Detach(self)


Enable(self, enable)
Parameters:enable (bool) –
Return type:bool


GetBitmap(self)
Return type: Bitmap


GetClientData(self)
Return type:PyUserData


GetControl(self)
Return type: Control


GetDisabledBitmap(self)
Return type: Bitmap


GetDropdownMenu(self)
Return type: Menu


GetId(self)
Return type:int


GetKind(self)
Return type: ItemKind


GetLabel(self)
Return type:string


GetLongHelp(self)
Return type:string


GetNormalBitmap(self)
Return type: Bitmap


GetShortHelp(self)
Return type:string


GetStyle(self)
Return type:int


GetToolBar(self)
Return type:ToolBarBase


IsButton(self)
Return type:bool


IsControl(self)
Return type:bool


IsEnabled(self)
Return type:bool


IsSeparator(self)
Return type:bool


IsStretchable(self)
Return type:bool


IsStretchableSpace(self)
Return type:bool


IsToggled(self)
Return type:bool


MakeStretchable(self)


SetClientData(self, clientData)
Parameters:clientData (PyUserData) –


SetDisabledBitmap(self, bmp)
Parameters:bmp (Bitmap) –


SetDropdownMenu(self, menu)
Parameters:menu (Menu) –


SetLabel(self, label)
Parameters:label (string) –


SetLongHelp(self, help)
Parameters:help (string) –
Return type:bool


SetNormalBitmap(self, bmp)
Parameters:bmp (Bitmap) –


SetShortHelp(self, help)
Parameters:help (string) –
Return type:bool


SetToggle(self, toggle)
Parameters:toggle (bool) –
Return type:bool


Toggle(self, *args, **kw)

overload Overloaded Implementations:



Toggle (self, toggle)

Parameters:toggle (bool) –
Return type:bool



Toggle (self)




Properties



Bitmap

See GetBitmap



ClientData

See GetClientData and SetClientData



Control

See GetControl



DisabledBitmap

See GetDisabledBitmap and SetDisabledBitmap



DropdownMenu

See GetDropdownMenu and SetDropdownMenu



Id

See GetId



Kind

See GetKind



Label

See GetLabel and SetLabel



LongHelp

See GetLongHelp and SetLongHelp



NormalBitmap

See GetNormalBitmap and SetNormalBitmap



ShortHelp

See GetShortHelp and SetShortHelp



Style

See GetStyle



ToolBar

See GetToolBar