X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8907154c1a8a6882c6797d1f16393ddfb23e7f3a..3dece6c4bc6b3952cf2e3c77ca52081a443677be:/include/wx/evtloop.h diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h index 2612ac024c..4a70021ec3 100644 --- a/include/wx/evtloop.h +++ b/include/wx/evtloop.h @@ -41,15 +41,18 @@ public: // dispatch a single event, return false if we should exit from the loop virtual bool Dispatch() = 0; - // is the event loop running now? - virtual bool IsRunning() const = 0; - // return currently active (running) event loop, may be NULL static wxEventLoop *GetActive() { return ms_activeLoop; } // set currently active (running) event loop static void SetActive(wxEventLoop* loop) { ms_activeLoop = loop; } + // is this event loop running now? + // + // notice that even if this event loop hasn't terminated yet but has just + // spawned a nested (e.g. modal) event loop, this would return false + bool IsRunning() const; + protected: // this function should be called before the event loop terminates, whether // this happens normally (because of Exit() call) or abnormally (because of @@ -63,6 +66,44 @@ protected: DECLARE_NO_COPY_CLASS(wxEventLoopBase) }; +#if defined(__WXMSW__) || defined(__WXMAC__) + +// this class can be used to implement a standard event loop logic using +// Pending() and Dispatch() +// +// it also handles idle processing automatically +class WXDLLEXPORT wxEventLoopManual : public wxEventLoopBase +{ +public: + wxEventLoopManual(); + + // enters a loop calling OnNextIteration(), Pending() and Dispatch() and + // terminating when Exit() is called + virtual int Run(); + + // sets the "should exit" flag and wakes up the loop so that it terminates + // soon + virtual void Exit(int rc = 0); + +protected: + // implement this to wake up the loop: usually done by posting a dummy event + // to it (called from Exit()) + virtual void WakeUp() = 0; + + // may be overridden to perform some action at the start of each new event + // loop iteration + virtual void OnNextIteration() { } + + + // the loop exit code + int m_exitcode; + + // should we exit the loop? + bool m_shouldExit; +}; + +#endif // platforms using "manual" loop + // we're moving away from old m_impl wxEventLoop model as otherwise the user // code doesn't have access to platform-specific wxEventLoop methods and this // can sometimes be very useful (e.g. under MSW this is necessary for @@ -72,7 +113,9 @@ protected: #include "wx/palmos/evtloop.h" #elif defined(__WXMSW__) #include "wx/msw/evtloop.h" -#else +#elif defined(__WXMAC__) + #include "wx/mac/evtloop.h" +#else // other platform class WXDLLEXPORT wxEventLoopImpl; @@ -86,16 +129,17 @@ public: virtual void Exit(int rc = 0); virtual bool Pending() const; virtual bool Dispatch(); - virtual bool IsRunning() const { return GetActive() == this; } protected: // the pointer to the port specific implementation class wxEventLoopImpl *m_impl; DECLARE_NO_COPY_CLASS(wxEventLoop) - }; +}; + +#endif // platforms -#endif // __WXMSW__/!__WXMSW__ +inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; } // ---------------------------------------------------------------------------- // wxModalEventLoop @@ -126,4 +170,30 @@ private: wxWindowDisabler *m_windowDisabler; }; +// ---------------------------------------------------------------------------- +// wxEventLoopActivator: helper class for wxEventLoop implementations +// ---------------------------------------------------------------------------- + +// this object sets the wxEventLoop given to the ctor as the currently active +// one and unsets it in its dtor, this is especially useful in presence of +// exceptions but is more tidy even when we don't use them +class wxEventLoopActivator +{ +public: + wxEventLoopActivator(wxEventLoop *evtLoop) + { + m_evtLoopOld = wxEventLoop::GetActive(); + wxEventLoop::SetActive(evtLoop); + } + + ~wxEventLoopActivator() + { + // restore the previously active event loop + wxEventLoop::SetActive(m_evtLoopOld); + } + +private: + wxEventLoop *m_evtLoopOld; +}; + #endif // _WX_EVTLOOP_H_