.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxEvent 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxEvent \- 
  The event base class
 
.SH DESCRIPTION

  


   An event is a structure holding information about an event passed to a
   callback or member function.
   
    wxEvent
   
   used to be a multipurpose event object, and is an abstract base class for
   other event classes (see below).
  
  


   For more information about events, see the
   Event handling overview
   .
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/event.h
.SH MEMBERS

  
.SS  wxEvent (int id = 0wxEventType eventType = wxEVT_NULL)

     


      Constructor. Should not need to be used directly by an application.
     
    
   
  
   
  
.SS virtual wxEvent* Clone ()

     


      Returns a copy of the event.
     
     


      Any event that is posted to the wxWidgets event system for later action
      (via
      wxEvtHandler::AddPendingEvent
      or
      wxPostEvent
      ) must implement this method. All wxWidgets 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 wxWidgets 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:
     
     
    wxEvent *Clone(void) const { return new MyEvent(*this); }

    
   
  
.SS wxObject* GetEventObject ()

     


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

     


      Returns the identifier of the given event type, such as
      wxEVENT_TYPE_BUTTON_COMMAND.
     
    
   
  
.SS int GetId ()

     


      Returns the identifier associated with this event, such as a button
      command id.
     
    
   
  
.SS bool GetSkipped ()

     


      Returns true if the event handler should be skipped, false otherwise.
     
    
   
  
.SS long GetTimestamp ()

     


      Gets the timestamp for the event.
     
    
   
  
.SS bool IsCommandEvent ()

     


      Returns true if the event is or is derived from
      wxCommandEvent
      else it returns false. Note: Exists only for optimization purposes.
     
    
   
  
.SS void ResumePropagation (int propagationLevel)

     


      Sets the propagation level to the given value (for example returned from
      an earlier call to
      StopPropagation
      ).
     
    
   
  
.SS void SetEventObject (wxObject* object)

     


      Sets the originating object.
     
    
   
  
.SS void SetEventType (WXTYPE typ)

     


      Sets the event type.
     
    
   
  
.SS void SetId (int id)

     


      Sets the identifier associated with this event, such as a button command
      id.
     
    
   
  
.SS void SetTimestamp (long timeStamp)

     


      Sets the timestamp for the event.
     
    
   
  
.SS bool ShouldPropagate ()

     


      Test if this event should be propagated or not, i.e. if the propagation
      level is currently greater than 0.
     
    
   
  
.SS void Skip (bool 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 behavior) 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.
     
    
   
  
.SS int StopPropagation ()

     


      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.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxCommandEvent
  , 
  wxMouseEvent
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.