ugh. Nesting the (per class) plugin sentries can require them to

[wxWidgets.git] / docs / latex / wx / event.tex

diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index d44b4b3fb874573cce562ba906efb67a62aa3090..5d4403d78f5a9af604ec4acd67498f0ac88cd428 100644 (file)
--- a/docs/latex/wx/event.tex
+++ b/docs/latex/wx/event.tex
@@ -8,6 +8,10 @@ event object, and is an abstract base class for other event classes (see below).
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/event.h>
+

 \wxheading{See also}
 
 \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
 \wxheading{See also}
 
 \helpref{wxCommandEvent}{wxcommandevent},\rtfsp


@@ -21,13 +25,6 @@ event object, and is an abstract base class for other event classes (see below).
 
 Constructor. Should not need to be used directly by an application.
 
 
 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}
 \membersection{wxEvent::m\_eventObject}
 
 \member{wxObject*}{m\_eventObject}


@@ -59,12 +56,25 @@ Set to TRUE by {\bf Skip} if this event should be skipped.
 
 Timestamp for this event.
 
 
 Timestamp for this event.
 

-\membersection{wxEvent::GetEventClass}
+\membersection{wxEvent::Clone}\label{wxeventclone}
+
+\func{virtual wxEvent*}{Clone}{\void} const
+
+Returns a copy of the event.

 
 

-\func{WXTYPE}{GetEventClass}{\void}
+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.

 
 

-Returns the identifier of the given event class,
-such as wxTYPE\_MOUSE\_EVENT.
+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}
 
 
 \membersection{wxEvent::GetEventObject}