]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/event.tex
wxRichTextAttr does not exist anymore - document instead wxTextAttr
[wxWidgets.git] / docs / latex / wx / event.tex
index 41848cf36b3ee809927b7f20a479cd0931a89efd..84c54107ca1f215a7dce8afe05a8d330dd4511c3 100644 (file)
@@ -17,6 +17,10 @@ For more information about events, see the \helpref{Event handling overview}{eve
 
 <wx/event.h>
 
 
 <wx/event.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
 \wxheading{See also}
 
 \helpref{wxCommandEvent}{wxcommandevent},\rtfsp
@@ -85,7 +89,7 @@ event, if any.
 
 \membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}
 
 
 \membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}
 
-\func{WXTYPE}{GetEventType}{\void}
+\func{wxEventType}{GetEventType}{\void}
 
 Returns the identifier of the given event type,
 such as \texttt{wxEVT\_COMMAND\_BUTTON\_CLICKED}.
 
 Returns the identifier of the given event type,
 such as \texttt{wxEVT\_COMMAND\_BUTTON\_CLICKED}.
@@ -141,7 +145,7 @@ Sets the originating object.
 
 \membersection{wxEvent::SetEventType}\label{wxeventseteventtype}
 
 
 \membersection{wxEvent::SetEventType}\label{wxeventseteventtype}
 
-\func{void}{SetEventType}{\param{WXTYPE }{typ}}
+\func{void}{SetEventType}{\param{wxEventType }{type}}
 
 Sets the event type.
 
 
 Sets the event type.
 
@@ -172,13 +176,17 @@ is currently greater than $0$.
 
 \func{void}{Skip}{\param{bool}{ skip = true}}
 
 
 \func{void}{Skip}{\param{bool}{ skip = true}}
 
-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.
+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}
 
 
 \membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}