Clarified the description of event.Skip

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

diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index 1fe7bddbb7065835534235a9cecc763a4e1ddb8b..f75d0de957482986db92ec399b537a2ad5051e56 100644 (file)
--- a/docs/latex/wx/event.tex
+++ b/docs/latex/wx/event.tex
@@ -187,9 +187,14 @@ is currently greater than $0$.
 
 \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 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.
+
 
 \membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}
 

diff --git a/wxPython/src/_event.i b/wxPython/src/_event.i
index 0b893da8b5444088eab2cd8440a4f01e3f9d5c2b..53bf9e1d4ce888d6e0c252f468b076412cbfa6ff 100644 (file)
--- a/wxPython/src/_event.i
+++ b/wxPython/src/_event.i
@@ -368,17 +368,23 @@ public:
     void SetEventObject(wxObject *obj);
     long GetTimestamp() const;
     void SetTimestamp(long ts = 0);
-    int GetId() const;
+    int  GetId() const;
     void SetId(int Id);
 
 
     bool IsCommandEvent() const;
 
-    // Can instruct event processor that we wish to ignore this event
-    // (treat as if the event table entry had not been found): this must be done
-    // to allow the event processing by the base classes (calling event.Skip()
-    // is the analog of calling the base class verstion of a virtual function)
-    void Skip(bool skip = true);
+    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.
+", "");
+    
     bool GetSkipped() const;
 
     // Determine if this event should be propagating to the parent window.