X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/684761db46d96d4a919d8e94edd1e9065978e675..751731864888f00e31e6dce1092ac28a1fac5358:/docs/latex/wx/event.tex diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex index 355c16de70..331a7b3746 100644 --- a/docs/latex/wx/event.tex +++ b/docs/latex/wx/event.tex @@ -4,6 +4,9 @@ An event is a structure holding information about an event passed to a callback or member function. {\bf wxEvent} used to be a multipurpose event object, and is an abstract base class for other event classes (see below). +\perlnote{In wxPerl custome event classes should be derived from +\texttt{Wx::PlEvent} and \texttt{Wx::PlCommandEvent}.} + \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -54,9 +57,9 @@ may be temporarily changed by \helpref{StopPropagation}{wxeventstoppropagation} and \helpref{ResumePropagation}{wxeventresumepropagation} and tested with \helpref{ShouldPropagate}{wxeventshouldpropagate}. -The initial value is set to either {\tt wxEVENT\_PROPAGATION\_NONE} (by +The initial value is set to either {\tt wxEVENT\_PROPAGATE\_NONE} (by default) meaning that the event shouldn't be propagated at all or to -{\tt wxEVENT\_PROPAGATION\_MAX} (for command events) meaning that it should be +{\tt 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 @@ -81,16 +84,17 @@ Timestamp for this event. Returns a copy of the event. -Any event that is posted to the wxWindows event system for later action (via +Any event that is posted to the wxWidgets event system for later action (via \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent} or -\helpref{wxPostEvent}{wxpostevent}) must implement this method. All wxWindows +\helpref{wxPostEvent}{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 wxWindows events implement a copy constructor, so the easiest way of +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: + \begin{verbatim} wxEvent *Clone(void) const { return new MyEvent(*this); } \end{verbatim}