From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 24 Jul 2006 18:05:32 +0000 (+0000)
Subject: improved Skip() docs (replaces patch 1516341)
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/e617d19d32b9421f32d553f7c22ca426a82acda6?ds=inline

improved Skip() docs (replaces patch 1516341)


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40284 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index 5e10db1209..fc016f23f2 100644
--- a/docs/latex/wx/event.tex
+++ b/docs/latex/wx/event.tex
@@ -172,13 +172,19 @@ is currently greater than $0$.
 
 \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 called by an event handler and controls whether additional
+event handlers bound to this event will be called after the current event
+handler returns. The default behavior is equivalent to calling Skip(false)
+(which is, hence, usually unnecessary) and 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. If Skip(true) is
+called, the event processing system continues searching for a handler
+function for this event as if the current handler didn't exist.
+
+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}