cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarified the description of event.Skip

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn 2005-01-13 20:54:45 +00:00
parent 5568f3f768
commit 310660663f
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/latex/wx/event.tex
View File

@ -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}

18
wxPython/src/_event.i
View File

@ -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.