X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/48c90c6e1e12ddbc806324a02c8f34a5130f037b..a20a357d928b6da93bc8b92193471f51a71127ba:/interface/wx/evtloop.h diff --git a/interface/wx/evtloop.h b/interface/wx/evtloop.h index d4a7966a95..be246731b5 100644 --- a/interface/wx/evtloop.h +++ b/interface/wx/evtloop.h @@ -82,6 +82,24 @@ public: */ virtual bool Dispatch() = 0; + /** + Dispatch an event but not wait longer than the specified timeout for + it. + + If an event is received before the specified @a timeout expires, it is + processed and the function returns 1 normally or 0 if the event loop + should quite. Otherwise, i.e. if the timeout expires, the functions + returns -1 without processing any events. + + @param timeout + The maximal time to wait for the events in milliseconds. + + @return + 1 if an event was processed, 0 if the event loop should quit or -1 + if the timeout expired. + */ + virtual int DispatchTimeout(unsigned long timeout) = 0; + /** Return true if this event loop is currently running.