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

Type EraseEvent

object --+        
         |        
    Object --+    
             |    
         Event --+
                 |
                EraseEvent


An erase event is sent whenever the background of a window needs to be repainted. To intercept this event use the EVT_ERASE_BACKGROUND event binder. On some platforms, such as GTK+, this event is simulated (simply generated just before the paint event) and may cause flicker.

To paint a custom background use the GetDC method and use the returned device context if it is not None, otherwise create a temporary wx.ClientDC and draw on that.


Method Summary
EraseEvent __init__(self, Id, dc)
Constructor
  __repr__(self)
DC GetDC(self)
Returns the device context the event handler should draw upon.
    Inherited from Event
  __del__(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

__init__(self, Id=0, dc=None)
(Constructor)

Constructor

Parameters:
Id
           (type=int)

dc
           (type=DC)

Returns:
EraseEvent
Overrides:
wx.Event.__init__

GetDC(self)

Returns the device context the event handler should draw upon. If None is returned then create a temporary wx.ClientDC and use that instead.

Returns:
DC

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