phoenix_title wx.aui.AuiToolBarItem

wx.aui.AuiToolBarItem is part of the AUI class framework, representing a toolbar element.

See also wx.aui.AuiToolBar and AUI Overview.

It has a unique id (except for the separators which always have id = -1), 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 (currently not implemented).


class_hierarchy Class Hierarchy

Inheritance diagram for class AuiToolBarItem:

method_summary Methods Summary

__init__

Default Constructor.

Assign

Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.

GetAlignment

GetBitmap

GetDisabledBitmap

GetHoverBitmap

GetId

Returns the toolbar item identifier.

GetKind

Returns the toolbar item kind.

GetLabel

GetLongHelp

GetMinSize

GetProportion

GetShortHelp

GetSizerItem

GetSpacerPixels

GetState

GetUserData

GetWindow

Returns the Window associated to the toolbar item.

HasDropDown

Returns whether the toolbar item has an associated drop down button.

IsActive

IsSticky

SetActive

SetAlignment

SetBitmap

SetDisabledBitmap

SetHasDropDown

Set whether this tool has a drop down button.

SetHoverBitmap

SetId

Sets the toolbar item identifier.

SetKind

Sets the wx.aui.AuiToolBarItem kind.

SetLabel

SetLongHelp

SetMinSize

SetProportion

SetShortHelp

SetSizerItem

SetSpacerPixels

SetState

SetSticky

SetUserData

SetWindow

Assigns a window to the toolbar item.


property_summary Properties Summary

Alignment

See GetAlignment and SetAlignment

Bitmap

See GetBitmap and SetBitmap

DisabledBitmap

See GetDisabledBitmap and SetDisabledBitmap

HoverBitmap

See GetHoverBitmap and SetHoverBitmap

Id

See GetId and SetId

Kind

See GetKind and SetKind

Label

See GetLabel and SetLabel

LongHelp

See GetLongHelp and SetLongHelp

MinSize

See GetMinSize and SetMinSize

Proportion

See GetProportion and SetProportion

ShortHelp

See GetShortHelp and SetShortHelp

SizerItem

See GetSizerItem and SetSizerItem

SpacerPixels

See GetSpacerPixels and SetSpacerPixels

State

See GetState and SetState

UserData

See GetUserData and SetUserData

Window

See GetWindow and SetWindow


api Class API

class wx.aui.AuiToolBarItem(object)

Possible constructors:

AuiToolBarItem()

AuiToolBarItem(c)

AuiToolBarItem is part of the AUI class framework, representing a toolbar element.

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default Constructor.



__init__ (self, c)

Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.

Parameters

c (wx.aui.AuiToolBarItem) –



Assign(self, c)

Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.

Parameters

c (wx.aui.AuiToolBarItem) –

GetAlignment(self)
Return type

int

GetBitmap(self)
Return type

Bitmap

GetDisabledBitmap(self)
Return type

Bitmap

GetHoverBitmap(self)
Return type

Bitmap

GetId(self)

Returns the toolbar item identifier.

Return type

int

GetKind(self)

Returns the toolbar item kind.

Return type

int

GetLabel(self)
Return type

string

GetLongHelp(self)
Return type

string

GetMinSize(self)
Return type

Size

GetProportion(self)
Return type

int

GetShortHelp(self)
Return type

string

GetSizerItem(self)
Return type

SizerItem

GetSpacerPixels(self)
Return type

int

GetState(self)
Return type

int

GetUserData(self)
Return type

long

GetWindow(self)

Returns the Window associated to the toolbar item.

Return type

Window

HasDropDown(self)

Returns whether the toolbar item has an associated drop down button.

Return type

bool

IsActive(self)
Return type

bool

IsSticky(self)
Return type

bool

SetActive(self, b)
Parameters

b (bool) –

SetAlignment(self, l)
Parameters

l (int) –

SetBitmap(self, bmp)
Parameters

bmp (wx.Bitmap) –

SetDisabledBitmap(self, bmp)
Parameters

bmp (wx.Bitmap) –

SetHasDropDown(self, b)

Set whether this tool has a drop down button.

This is only valid for wx.ITEM_NORMAL tools.

Parameters

b (bool) –

SetHoverBitmap(self, bmp)
Parameters

bmp (wx.Bitmap) –

SetId(self, new_id)

Sets the toolbar item identifier.

Parameters

new_id (int) –

SetKind(self, new_kind)

Sets the wx.aui.AuiToolBarItem kind.

Parameters

new_kind (int) –

SetLabel(self, s)
Parameters

s (string) –

SetLongHelp(self, s)
Parameters

s (string) –

SetMinSize(self, s)
Parameters

s (wx.Size) –

SetProportion(self, p)
Parameters

p (int) –

SetShortHelp(self, s)
Parameters

s (string) –

SetSizerItem(self, s)
Parameters

s (wx.SizerItem) –

SetSpacerPixels(self, s)
Parameters

s (int) –

SetState(self, new_state)
Parameters

new_state (int) –

SetSticky(self, b)
Parameters

b (bool) –

SetUserData(self, l)
Parameters

l (long) –

SetWindow(self, w)

Assigns a window to the toolbar item.

Parameters

w (wx.Window) –

Alignment

See GetAlignment and SetAlignment

Bitmap

See GetBitmap and SetBitmap

DisabledBitmap

See GetDisabledBitmap and SetDisabledBitmap

HoverBitmap

See GetHoverBitmap and SetHoverBitmap

Id

See GetId and SetId

Kind

See GetKind and SetKind

Label

See GetLabel and SetLabel

LongHelp

See GetLongHelp and SetLongHelp

MinSize

See GetMinSize and SetMinSize

Proportion

See GetProportion and SetProportion

ShortHelp

See GetShortHelp and SetShortHelp

SizerItem

See GetSizerItem and SetSizerItem

SpacerPixels

See GetSpacerPixels and SetSpacerPixels

State

See GetState and SetState

UserData

See GetUserData and SetUserData

Window

See GetWindow and SetWindow