## wxEvent

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).

Derived from

wxObject

Include files

<wx/event.h>

See also

wxCommandEvent, wxMouseEvent

Members

wxEvent::wxEvent
wxEvent::m_eventObject
wxEvent::m_eventType
wxEvent::m_id
wxEvent::m_skipped
wxEvent::m_timeStamp
wxEvent::Clone
wxEvent::GetEventObject
wxEvent::GetEventType
wxEvent::GetId
wxEvent::GetSkipped
wxEvent::GetTimestamp
wxEvent::SetEventObject
wxEvent::SetEventType
wxEvent::SetId
wxEvent::SetTimestamp
wxEvent::Skip

### wxEvent::wxEvent

wxEvent(int id = 0, wxEventType eventType = `wxEVT_NULL`)

Constructor. Should not need to be used directly by an application.

### wxEvent::m_eventObject

wxObject* m_eventObject

The object (usually a window) that the event was generated from, or should be sent to.

### wxEvent::m_eventType

WXTYPE m_eventType

The type of the event, such as wxEVENT_TYPE_BUTTON_COMMAND.

### wxEvent::m_id

int m_id

Identifier for the window.

### wxEvent::m_skipped

bool m_skipped

Set to TRUE by Skip if this event should be skipped.

### wxEvent::m_timeStamp

long m_timeStamp

Timestamp for this event.

### wxEvent::Clone

virtual wxEvent* Clone() const

Returns a copy of the event.

Any event that is posted to the wxWindows event system for later action (via wxEvtHandler::AddPendingEvent or wxPostEvent) must implement this method. All wxWindows 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 wxWindows 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); }

### wxEvent::GetEventObject

wxObject* GetEventObject()

Returns the object associated with the event, if any.

### wxEvent::GetEventType

WXTYPE GetEventType()

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

### wxEvent::GetId

int GetId()

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

### wxEvent::GetSkipped

bool GetSkipped()

Returns TRUE if the event handler should be skipped, FALSE otherwise.

### wxEvent::GetTimestamp

long GetTimestamp()

Gets the timestamp for the event.

### wxEvent::SetEventObject

void SetEventObject(wxObject* object)

Sets the originating object.

### wxEvent::SetEventType

void SetEventType(WXTYPE typ)

Sets the event type.

### wxEvent::SetId

void SetId(int id)

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

### wxEvent::SetTimestamp

void SetTimestamp(long timeStamp)

Sets the timestamp for the event.

Sets the originating object.

### wxEvent::Skip

void Skip(bool skip = TRUE)

Called by an event handler to tell the event system that the event handler should be skipped, and the next valid handler used instead.