Clarified the description of event.Skip
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
5568f3f768
commit
310660663f
@ -187,9 +187,14 @@ is currently greater than $0$.
|
|||||||
|
|
||||||
\func{void}{Skip}{\param{bool}{ skip = true}}
|
\func{void}{Skip}{\param{bool}{ skip = true}}
|
||||||
|
|
||||||
Called by an event handler to tell the event system that the
|
Called by an event handler, it controls whether additional event
|
||||||
event handler should be skipped, and the next valid handler used
|
handlers bound to this event will be called after the current event
|
||||||
instead.
|
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}
|
\membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}
|
||||||
|
|
||||||
|
@ -368,17 +368,23 @@ public:
|
|||||||
void SetEventObject(wxObject *obj);
|
void SetEventObject(wxObject *obj);
|
||||||
long GetTimestamp() const;
|
long GetTimestamp() const;
|
||||||
void SetTimestamp(long ts = 0);
|
void SetTimestamp(long ts = 0);
|
||||||
int GetId() const;
|
int GetId() const;
|
||||||
void SetId(int Id);
|
void SetId(int Id);
|
||||||
|
|
||||||
|
|
||||||
bool IsCommandEvent() const;
|
bool IsCommandEvent() const;
|
||||||
|
|
||||||
// Can instruct event processor that we wish to ignore this event
|
DocDeclStr(
|
||||||
// (treat as if the event table entry had not been found): this must be done
|
void , Skip(bool skip = true),
|
||||||
// to allow the event processing by the base classes (calling event.Skip()
|
"Called by an event handler, it controls whether additional event
|
||||||
// is the analog of calling the base class verstion of a virtual function)
|
handlers bound to this event will be called after the current event
|
||||||
void Skip(bool skip = true);
|
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;
|
bool GetSkipped() const;
|
||||||
|
|
||||||
// Determine if this event should be propagating to the parent window.
|
// Determine if this event should be propagating to the parent window.
|
||||||
|
Loading…
Reference in New Issue
Block a user