X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f8e5ed929cb84efa6581716ea3f3dcde226fac31..afbe906abdf9aa69a56571b8b20b095351dd8f34:/docs/latex/wx/event.tex diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex index f747df581b..404294e112 100644 --- a/docs/latex/wx/event.tex +++ b/docs/latex/wx/event.tex @@ -21,17 +21,10 @@ event object, and is an abstract base class for other event classes (see below). \membersection{wxEvent::wxEvent} -\func{}{wxEvent}{\param{int }{id = 0}} +\func{}{wxEvent}{\param{int }{id = 0}, \param{wxEventType }{eventType = {\tt wxEVT\_NULL}}} Constructor. Should not need to be used directly by an application. -\membersection{wxEvent::m\_eventHandle} - -\member{char*}{m\_eventHandle} - -Handle of an underlying windowing system event handle, such as -XEvent. Not guaranteed to be instantiated. - \membersection{wxEvent::m\_eventObject} \member{wxObject*}{m\_eventObject} @@ -63,6 +56,26 @@ Set to TRUE by {\bf Skip} if this event should be skipped. Timestamp for this event. +\membersection{wxEvent::Clone}\label{wxeventclone} + +\constfunc{virtual wxEvent*}{Clone}{\void} + +Returns a copy of the event. + +Any event that is posted to the wxWindows event system for later action (via +\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent} or +\helpref{wxPostEvent}{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: +\begin{verbatim} + wxEvent *Clone(void) const { return new MyEvent(*this); } +\end{verbatim} + \membersection{wxEvent::GetEventObject} \func{wxObject*}{GetEventObject}{\void}