X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b236c10f77e9ed0bc3c16d1cceb4a62f7048b4f9..9804d5404a9607cda3d08ec8225f52f78b78bc72:/docs/latex/wx/event.tex diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex index 1fe7bddbb7..5e10db1209 100644 --- a/docs/latex/wx/event.tex +++ b/docs/latex/wx/event.tex @@ -6,7 +6,7 @@ event object, and is an abstract base class for other event classes (see below). For more information about events, see the \helpref{Event handling overview}{eventhandlingoverview}. -\perlnote{In wxPerl custome event classes should be derived from +\perlnote{In wxPerl custom event classes should be derived from \texttt{Wx::PlEvent} and \texttt{Wx::PlCommandEvent}.} \wxheading{Derived from} @@ -24,33 +24,17 @@ For more information about events, see the \helpref{Event handling overview}{eve \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxEvent::wxEvent}\label{wxeventctor} \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\_eventObject}\label{wxeventmeventobject} - -\member{wxObject*}{m\_eventObject} - -The object (usually a window) that the event was generated from, -or should be sent to. - -\membersection{wxEvent::m\_eventType}\label{wxeventmeventtype} - -\member{WXTYPE}{m\_eventType} - -The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND. - -\membersection{wxEvent::m\_id}\label{wxeventmid} - -\member{int}{m\_id} - -Identifier for the window. \membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel} + \member{int}{m\_propagationLevel} Indicates how many levels the event can propagate. This member is protected and @@ -68,17 +52,6 @@ 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. -\membersection{wxEvent::m\_skipped}\label{wxeventmskipped} - -\member{bool}{m\_skipped} - -Set to true by {\bf Skip} if this event should be skipped. - -\membersection{wxEvent::m\_timeStamp}\label{wxeventmtimestamp} - -\member{long}{m\_timeStamp} - -Timestamp for this event. \membersection{wxEvent::Clone}\label{wxeventclone} @@ -101,19 +74,22 @@ a new event (call it MyEvent) and then define the Clone function like this: wxEvent *Clone(void) const { return new MyEvent(*this); } \end{verbatim} + \membersection{wxEvent::GetEventObject}\label{wxeventgeteventobject} \func{wxObject*}{GetEventObject}{\void} -Returns the object associated with the +Returns the object (usually a window) associated with the event, if any. + \membersection{wxEvent::GetEventType}\label{wxeventgeteventtype} -\func{WXTYPE}{GetEventType}{\void} +\func{wxEventType}{GetEventType}{\void} Returns the identifier of the given event type, -such as wxEVENT\_TYPE\_BUTTON\_COMMAND. +such as \texttt{wxEVT\_COMMAND\_BUTTON\_CLICKED}. + \membersection{wxEvent::GetId}\label{wxeventgetid} @@ -121,17 +97,23 @@ such as wxEVENT\_TYPE\_BUTTON\_COMMAND. Returns the identifier associated with this event, such as a button command id. + \membersection{wxEvent::GetSkipped}\label{wxeventgetskipped} \constfunc{bool}{GetSkipped}{\void} Returns true if the event handler should be skipped, false otherwise. + \membersection{wxEvent::GetTimestamp}\label{wxeventgettimestamp} \func{long}{GetTimestamp}{\void} -Gets the timestamp for the event. +Gets the timestamp for the event. The timestamp is the time in milliseconds +since some fixed moment (\emph{not} necessarily the standard Unix Epoch, so +only differences between the timestamps and not their absolute values usually +make sense). + \membersection{wxEvent::IsCommandEvent}\label{wxeventiscommandevent} @@ -156,25 +138,27 @@ earlier call to \helpref{StopPropagation}{wxeventstoppropagation}). Sets the originating object. + \membersection{wxEvent::SetEventType}\label{wxeventseteventtype} -\func{void}{SetEventType}{\param{WXTYPE }{typ}} +\func{void}{SetEventType}{\param{wxEventType }{type}} Sets the event type. + \membersection{wxEvent::SetId}\label{wxeventsetid} \func{void}{SetId}{\param{int}{ id}} Sets the identifier associated with this event, such as a button command id. + \membersection{wxEvent::SetTimestamp}\label{wxeventsettimestamp} \func{void}{SetTimestamp}{\param{long }{timeStamp}} Sets the timestamp for the event. -Sets the originating object. \membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate} @@ -183,13 +167,19 @@ Sets the originating object. Test if this event should be propagated or not, i.e. if the propagation level is currently greater than $0$. + \membersection{wxEvent::Skip}\label{wxeventskip} \func{void}{Skip}{\param{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. +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. + \membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}