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.
wxPerl note: In wxPerl custom event classes should be derived from Wx::PlEvent and Wx::PlCommandEvent.
Derived from
Include files
<wx/event.h>
See also
Members
wxEvent::wxEvent
wxEvent::m_propagationLevel
wxEvent::Clone
wxEvent::GetEventObject
wxEvent::GetEventType
wxEvent::GetId
wxEvent::GetSkipped
wxEvent::GetTimestamp
wxEvent::IsCommandEvent
wxEvent::ResumePropagation
wxEvent::SetEventObject
wxEvent::SetEventType
wxEvent::SetId
wxEvent::SetTimestamp
wxEvent::ShouldPropagate
wxEvent::Skip
wxEvent::StopPropagation
wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL)
Constructor. Should not need to be used directly by an application.
int m_propagationLevel
Indicates how many levels the event can propagate. This member is protected and should typically only be set in the constructors of the derived classes. It may be temporarily changed by StopPropagation and ResumePropagation and tested with ShouldPropagate.
The initial value is set to either wxEVENT_PROPAGATE_NONE (by default) meaning that the event shouldn't be propagated at all or to wxEVENT_PROPAGATE_MAX (for command events) meaning that it should be propagated as much as necessary.
Any positive number means that the event should be propagated but no more than the given number of times. E.g. the propagation level may be set to 1 to propagate the event to its parent only, but not to its grandparent.
virtual wxEvent* Clone() const
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); }
wxObject* GetEventObject()
Returns the object (usually a window) associated with the event, if any.
WXTYPE GetEventType()
Returns the identifier of the given event type, such as wxEVENT_TYPE_BUTTON_COMMAND.
int GetId() const
Returns the identifier associated with this event, such as a button command id.
bool GetSkipped() const
Returns true if the event handler should be skipped, false otherwise.
long GetTimestamp()
Gets the timestamp for the event.
bool IsCommandEvent() const
Returns true if the event is or is derived from wxCommandEvent else it returns false. Note: Exists only for optimization purposes.
void ResumePropagation(int propagationLevel)
Sets the propagation level to the given value (for example returned from an earlier call to StopPropagation).
void SetEventObject(wxObject* object)
Sets the originating object.
void SetEventType(WXTYPE typ)
Sets the event type.
void SetId(int id)
Sets the identifier associated with this event, such as a button command id.
void SetTimestamp(long timeStamp)
Sets the timestamp for the event.
bool ShouldPropagate() const
Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.
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.
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.