X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d455444a8b6497fda02978cf14528c9e3b2ab102..b5fe7ca67bf3121959a0b5a59afd00c1708f2f03:/interface/wx/event.h diff --git a/interface/wx/event.h b/interface/wx/event.h index d0ea624e1f..548ceffb06 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -333,7 +333,7 @@ public: @library{wxbase} @category{events} - @see @ref overview_events_processing + @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase */ class wxEvtHandler : public wxObject { @@ -533,7 +533,32 @@ public: @see wxWindow::HandleWindowEvent */ bool SafelyProcessEvent(wxEvent& event); + + /** + Processes the pending events previously queued using QueueEvent() or + AddPendingEvent(); you must call this function only if you are sure + there are pending events for this handler, otherwise a @c wxCHECK + will fail. + + The real processing still happens in ProcessEvent() which is called by this + function. + + Note that this function needs a valid application object (see + wxAppConsole::GetInstance()) because wxApp holds the list of the event + handlers with pending events and this function manipulates that list. + */ + void ProcessPendingEvents(); + /** + Deletes all events queued on this event handler using QueueEvent() or + AddPendingEvent(). + + Use with care because the events which are deleted are (obviously) not + processed and this may have unwanted consequences (e.g. user actions events + will be lost). + */ + void DeletePendingEvents(); + /** Searches the event table, executing an event handler function if an appropriate one is found. @@ -555,6 +580,9 @@ public: If a suitable function is called but calls wxEvent::Skip, this function will fail, and searching will continue. + + @todo this function in the header is listed as an "implementation only" function; + are we sure we want to document it? @see ProcessEvent() */