framemanager.AuiManagerEvent

Inheritance diagram for AuiManagerEvent:


digraph inheritance359e8c34b9 {
rankdir=LR;
size="8.0, 12.0";
  "framemanager.AuiManagerEvent" [style="setlinewidth(0.5)",URL="#framemanager.AuiManagerEvent",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "wx._core.PyCommandEvent" -> "framemanager.AuiManagerEvent" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.Event" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.Object" -> "wx._core.Event" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.PyCommandEvent" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.CommandEvent" -> "wx._core.PyCommandEvent" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.Object" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.CommandEvent" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.Event" -> "wx._core.CommandEvent" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Description

A specialized command event class for events sent by L{AuiManager}.

Class API

Methods

class AuiManagerEvent(eventType, id=1)

Bases: wx._core.PyCommandEvent

A specialized command event class for events sent by L{AuiManager}.

__init__()

Default class constructor.

Parameters:
  • eventType – the event kind;
  • id – the event identification number.
CanVeto()
Returns whether the event can be vetoed and has been vetoed.
Clone()

Returns a copy of the event.

Any event that is posted to the wxPython event system for later action (via L{wx.EvtHandler.AddPendingEvent} or L{wx.PostEvent}) must implement this method. All wxPython events fully implement this method, but any derived events implemented by the user should also implement this method just in case they (or some event derived from them) are ever posted.

All wxPython events implement a copy constructor, so the easiest way of implementing the Clone function is to implement a copy constructor for a new event (call it MyEvent) and then define the Clone function like this:

def Clone(self):
    return MyEvent(self)
GetButton()
Returns the associated L{AuiPaneButton} instance (if any).
GetDC()
Returns the associated L{wx.DC} device context (if any).
GetManager()
Returns the associated L{AuiManager} (if any).
GetPane()
Returns the associated L{AuiPaneInfo} structure (if any).
GetVeto()
Returns whether the event has been vetoed or not.
SetButton(b)

Associates a L{AuiPaneButton} instance to this event.

Parameter:b – a L{AuiPaneButton} instance.
SetCanVeto(can_veto)

Sets whether the event can be vetoed or not.

Parameter:can_veto – a bool flag.
SetDC(pdc)

Associates a L{wx.DC} device context to this event.

Parameter:pdc – a L{wx.DC} device context object.
SetManager(mgr)

Associates a L{AuiManager} to the current event.

Parameter:mgr – an instance of L{AuiManager}.
SetPane(p)

Associates a L{AuiPaneInfo} instance to this event.

Parameter:p – a L{AuiPaneInfo} instance.
Veto(veto=True)

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.

Parameter:veto – whether to veto the event or not.

Table Of Contents

This Page