X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1bd98e415000d06b5e4def7b92535e9ebb388f9b..0bd2681966523df88ad5cf8e505b532843e58d74:/docs/latex/wx/event.tex diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex index 1a4306e851..84c54107ca 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} @@ -17,6 +17,10 @@ For more information about events, see the \helpref{Event handling overview}{eve +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxCommandEvent}{wxcommandevent},\rtfsp @@ -24,32 +28,16 @@ For more information about events, see the \helpref{Event handling overview}{eve \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxEvent::wxEvent} + +\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} - -\member{wxObject*}{m\_eventObject} - -The object (usually a window) that the event was generated from, -or should be sent to. - -\membersection{wxEvent::m\_eventType} - -\member{WXTYPE}{m\_eventType} -The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND. +\membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel} -\membersection{wxEvent::m\_id} - -\member{int}{m\_id} - -Identifier for the window. - -\membersection{wxEvent::m\_propagationLevel} \member{int}{m\_propagationLevel} @@ -68,17 +56,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} - -\member{bool}{m\_skipped} - -Set to true by {\bf Skip} if this event should be skipped. - -\membersection{wxEvent::m\_timeStamp} - -\member{long}{m\_timeStamp} - -Timestamp for this event. \membersection{wxEvent::Clone}\label{wxeventclone} @@ -101,37 +78,46 @@ 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} + +\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} -\func{WXTYPE}{GetEventType}{\void} +\membersection{wxEvent::GetEventType}\label{wxeventgeteventtype} + +\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} +\membersection{wxEvent::GetId}\label{wxeventgetid} \constfunc{int}{GetId}{\void} Returns the identifier associated with this event, such as a button command id. -\membersection{wxEvent::GetSkipped} + +\membersection{wxEvent::GetSkipped}\label{wxeventgetskipped} \constfunc{bool}{GetSkipped}{\void} Returns true if the event handler should be skipped, false otherwise. -\membersection{wxEvent::GetTimestamp} + +\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} @@ -150,31 +136,33 @@ Sets the propagation level to the given value (for example returned from an earlier call to \helpref{StopPropagation}{wxeventstoppropagation}). -\membersection{wxEvent::SetEventObject} +\membersection{wxEvent::SetEventObject}\label{wxeventseteventobject} \func{void}{SetEventObject}{\param{wxObject* }{object}} Sets the originating object. -\membersection{wxEvent::SetEventType} -\func{void}{SetEventType}{\param{WXTYPE }{typ}} +\membersection{wxEvent::SetEventType}\label{wxeventseteventtype} + +\func{void}{SetEventType}{\param{wxEventType }{type}} Sets the event type. -\membersection{wxEvent::SetId} + +\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} + +\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 +171,23 @@ 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. +This method can be used inside an event handler to control whether further +event handlers bound to this event will be called after the current one +returns. Without Skip() (or equivalently if Skip(false) is used), +the event will not be processed any more. If Skip(true) is called, the event +processing system continues searching for a further handler function for this +event, even though it has been processed already in the current handler. + +In general, it is recommended to skip all non-command events to allow the +default handling to take place. The command events are, however, normally not +skipped as usually a single command such as a button click or menu item +selection must only be processed by one handler. + \membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}