Package wx :: Class Event
[frames | no frames]

Type Event

object --+    
         |    
    Object --+
             |
            Event

Known Subclasses:
ActivateEvent, CalculateLayoutEvent, CloseEvent, CommandEvent, DisplayChangedEvent, DropFilesEvent, EraseEvent, FocusEvent, IconizeEvent, IdleEvent, InitDialogEvent, JoystickEvent, KeyEvent, MaximizeEvent, MenuEvent, MouseCaptureChangedEvent, MouseEvent, MoveEvent, NavigationKeyEvent, NcPaintEvent, PaintEvent, PaletteChangedEvent, ProcessEvent, PyEvent, QueryLayoutInfoEvent, QueryNewPaletteEvent, ScrollWinEvent, SetCursorEvent, ShowEvent, SizeEvent, SysColourChangedEvent, TaskBarIconEvent, TimerEvent

An event is a structure holding information about an event passed to a callback or member function. wx.Event is an abstract base class for other event classes


Method Summary
  __init__(self)
  __del__(self)
  __repr__(self)
Event Clone(self)
Object GetEventObject(self)
Returns the object (usually a window) associated with the event, if any.
wxEventType GetEventType(self)
Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED.
int GetId(self)
Returns the identifier associated with this event, such as a button command id.
bool GetSkipped(self)
Returns true if the event handler should be skipped, false otherwise.
long GetTimestamp(self)
bool IsCommandEvent(self)
Returns true if the event is or is derived from wx.CommandEvent else it returns false.
  ResumePropagation(self, propagationLevel)
Resume the event propagation by restoring the propagation level.
  SetEventObject(self, obj)
Sets the originating object, or in other words, obj is normally the object that is sending the event.
  SetEventType(self, typ)
Sets the specific type of the event.
  SetId(self, Id)
Set's the ID for the event.
  SetTimestamp(self, ts)
bool ShouldPropagate(self)
Test if this event should be propagated to the parent window or not, i.e.
  Skip(self, skip)
Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns.
int StopPropagation(self)
Stop the event from propagating to its parent window.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Method Details

GetEventObject(self)

Returns the object (usually a window) associated with the event, if any.

Returns:
Object

GetEventType(self)

Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED.

Returns:
wxEventType

GetId(self)

Returns the identifier associated with this event, such as a button command id.

Returns:
int

GetSkipped(self)

Returns true if the event handler should be skipped, false otherwise. :see: Skip

Returns:
bool

IsCommandEvent(self)

Returns true if the event is or is derived from wx.CommandEvent else it returns false. Note: Exists only for optimization purposes.

Returns:
bool

ResumePropagation(self, propagationLevel)

Resume the event propagation by restoring the propagation level. (For example, you can use the value returned by an earlier call to StopPropagation.)

Parameters:
propagationLevel
           (type=int)

SetEventObject(self, obj)

Sets the originating object, or in other words, obj is normally the object that is sending the event.

Parameters:
obj
           (type=Object)

SetEventType(self, typ)

Sets the specific type of the event.

Parameters:
typ
           (type=wxEventType)

SetId(self, Id)

Set's the ID for the event. This is usually the ID of the window that is sending the event, but it can also be a command id from a menu item, etc.

Parameters:
Id
           (type=int)

ShouldPropagate(self)

Test if this event should be propagated to the parent window or not, i.e. if the propagation level is currently greater than 0.

Returns:
bool

Skip(self, skip=True)

Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns. Skip(false) (the default setting) will prevent additional event handlers from being called and control will be returned to the sender of the event immediately after the current handler has finished. Skip(True) will cause the event processing system to continue searching for a handler function for this event.

Parameters:
skip
           (type=bool)

StopPropagation(self)

Stop the event from propagating to its parent window. Returns the old propagation level value which may be later passed to ResumePropagation to allow propagating the event again.

Returns:
int

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 17:04:01 2007 http://epydoc.sf.net