From 310660663fee63635e870f81357b61a08fedacf0 Mon Sep 17 00:00:00 2001
From: Robin Dunn <robin@alldunn.com>
Date: Thu, 13 Jan 2005 20:54:45 +0000
Subject: [PATCH] Clarified the description of event.Skip
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
docs/latex/wx/event.tex | 11 ++++++++---
wxPython/src/_event.i | 18 ++++++++++++------
2 files changed, 20 insertions(+), 9 deletions(-)
diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index 1fe7bddbb7..f75d0de957 100644
--- 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 0b893da8b5..53bf9e1d4c 100644
--- 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.
--
2.47.2