wx.aui.AuiManagerEvent

Event used to indicate various actions taken with wx.aui.AuiManager.

See wx.aui.AuiManager for available event types.

^^

Events Emitted by this Class

Handlers bound for the following event types will receive a wx.aui.AuiManagerEvent parameter.

• EVT_AUI_PANE_BUTTON: Triggered when any button is pressed for any docked panes.

• EVT_AUI_PANE_CLOSE: Triggered when a docked or floating pane is closed.

• EVT_AUI_PANE_MAXIMIZE: Triggered when a pane is maximized.

• EVT_AUI_PANE_RESTORE: Triggered when a pane is restored.

• EVT_AUI_PANE_ACTIVATED: Triggered when a pane is made ‘active’. This event is new since wxWidgets 2.9.4.

• EVT_AUI_RENDER: This event can be caught to override the default renderer in order to custom draw your wx.aui.AuiManager window (not recommended). ^^

See also

wx.aui.AuiManager, wx.aui.AuiPaneInfo

Class Hierarchy

Inheritance diagram for class AuiManagerEvent:

Methods Summary

__init__	Constructor.
CanVeto
GetButton
GetDC
GetManager
GetPane
GetVeto
SetButton	Sets the ID of the button clicked that triggered this event.
SetCanVeto	Sets whether or not this event can be vetoed.
SetDC
SetManager	Sets the wx.aui.AuiManager this event is associated with.
SetPane	Sets the pane this event is associated with.
Veto	Cancels the action indicated by this event if CanVeto is True.

Properties Summary

Button	See GetButton and SetButton
DC	See GetDC and SetDC
Manager	See GetManager and SetManager
Pane	See GetPane and SetPane

Class API

class wx.aui.AuiManagerEvent(Event)

Possible constructors:

AuiManagerEvent(type=wxEVT_NULL)

Event used to indicate various actions taken with AuiManager.

Methods

__init__(self, type=wxEVT_NULL)

Constructor.

Parameters:

type (wx.EventType) –

---

CanVeto(self)

Return type:

bool

Returns:

True if this event can be vetoed.

See also

Veto

---

GetButton(self)

Return type:

int

Returns:

The ID of the button that was clicked.

---

GetDC(self)

Return type:

DC

Todo

What is this?

---

GetManager(self)

Return type:

wx.aui.AuiManager

Returns:

The wx.aui.AuiManager this event is associated with.

---

GetPane(self)

Return type:

wx.aui.AuiPaneInfo

Returns:

The pane this event is associated with.

---

GetVeto(self)

Return type:

bool

Returns:

True if this event was vetoed.

See also

Veto

---

SetButton(self, button)

Sets the ID of the button clicked that triggered this event.

Parameters:

button (int) –

---

SetCanVeto(self, can_veto)

Sets whether or not this event can be vetoed.

Parameters:

can_veto (bool) –

---

SetDC(self, pdc)

Parameters:

pdc (wx.DC) –

Todo

What is this?

---

SetManager(self, manager)

Sets the wx.aui.AuiManager this event is associated with.

Parameters:

manager (wx.aui.AuiManager) –

---

SetPane(self, pane)

Sets the pane this event is associated with.

Parameters:

pane (wx.aui.AuiPaneInfo) –

---

Veto(self, veto=True)

Cancels the action indicated by this event if CanVeto is True.

Parameters:

veto (bool) –

Properties

Button

See GetButton and SetButton

---

DC

See GetDC and SetDC

---

Manager

See GetManager and SetManager

---

Pane

See GetPane and SetPane