]> git.saurik.com Git - wxWidgets.git/commitdiff
docstring update
authorRobin Dunn <robin@alldunn.com>
Tue, 24 Oct 2006 00:34:30 +0000 (00:34 +0000)
committerRobin Dunn <robin@alldunn.com>
Tue, 24 Oct 2006 00:34:30 +0000 (00:34 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42315 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

wxPython/src/_event.i

index 33f832615a7058a5d3325dbfbe69c992d72a766f..62437e014badd72970ba0356d6785a350b828a8b 100644 (file)
@@ -433,14 +433,13 @@ it returns false. Note: Exists only for optimization purposes.", "");
 
     DocDeclStr(
         void , Skip(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 setting) 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.", "");
 
     DocDeclStr(
         bool , GetSkipped() const,