AuiManagerEvent¶A specialized command event class for events sent by AuiManager.
Methods Summary¶| __init__ | Default class constructor. |
| CanVeto | Returns whether the event can be vetoed and has been vetoed. |
| GetButton | Returns the associated AuiPaneButton instance (if any). |
| GetDC | Returns the associated wx.DC device context (if any). |
| GetManager | Returns the associated AuiManager (if any). |
| GetPane | Returns the associated AuiPaneInfo structure (if any). |
| GetVeto | Returns whether the event has been vetoed or not. |
| SetButton | Associates a AuiPaneButton instance to this event. |
| SetCanVeto | Sets whether the event can be vetoed or not. |
| SetDC | Associates a wx.DC device context to this event. |
| SetManager | Associates a AuiManager to the current event. |
| SetPane | Associates a AuiPaneInfo instance to this event. |
| Veto | Prevents the change announced by this event from happening. |
Class API¶A specialized command event class for events sent by AuiManager.
Default class constructor.
| Parameters: |
|
|---|
Returns the associated AuiPaneButton instance (if any).
Returns the associated AuiManager (if any).
Returns the associated AuiPaneInfo structure (if any).
Associates a AuiPaneButton instance to this event.
| Parameters: | b – a AuiPaneButton instance. |
|---|
Sets whether the event can be vetoed or not.
| Parameters: | can_veto – a bool flag. True if the event can be vetoed, False otherwise. |
|---|
Associates a wx.DC device context to this event.
| Parameters: | pdc – a wx.DC device context object. |
|---|
Associates a AuiManager to the current event.
| Parameters: | mgr – an instance of AuiManager. |
|---|
Associates a AuiPaneInfo instance to this event.
| Parameters: | p – a AuiPaneInfo instance. |
|---|
Prevents the change announced by this event from happening.
It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising.
| Parameters: | veto – True to veto the event, False otherwise. |
|---|
Inheritance Diagram
