X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/079f4130b861d094c79e0952966caad8b85dab67..e276acb530f41f0b87c4576c0215201a8a767dff:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index d61b3b5613..a5b60fed2b 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -32,6 +32,7 @@ class WXDLLIMPEXP_FWD_BASE wxMessageOutput; #if wxUSE_GUI struct WXDLLIMPEXP_FWD_CORE wxVideoMode; + class WXDLLIMPEXP_FWD_CORE wxWindow; #endif // ---------------------------------------------------------------------------- @@ -221,6 +222,16 @@ public: virtual int FilterEvent(wxEvent& event); #if wxUSE_EXCEPTIONS + // execute the functor to handle the given event + // + // this is a generalization of HandleEvent() below and the base class + // implementation of CallEventHandler() still calls HandleEvent() for + // compatibility for functors which are just wxEventFunctions (i.e. methods + // of wxEvtHandler) + virtual void CallEventHandler(wxEvtHandler *handler, + wxEventFunctor& functor, + wxEvent& event) const; + // call the specified handler on the given object with the given event // // this method only exists to allow catching the exceptions thrown by any @@ -244,6 +255,13 @@ public: // (already) be dispatched static bool IsMainLoopRunning(); + // temporary suspends processing of the pending events + virtual void SuspendProcessingOfPendingEvents(); + + // resume processing of the pending events previously stopped because of a + // call to SuspendProcessingOfPendingEvents() + virtual void ResumeProcessingOfPendingEvents(); + // process all events in the wxHandlersWithPendingEvents list -- it is necessary // to call this function to process posted events. This happens during each // event loop iteration in GUI mode but if there is no main loop, it may be @@ -253,9 +271,6 @@ public: // check if there are pending events on global pending event list bool HasPendingEvents() const; - // doesn't do anything in this class, just a hook for GUI wxApp - virtual bool Yield(bool WXUNUSED(onlyIfNeeded) = false) { return true; } - // make sure that idle events are sent again virtual void WakeUpIdle(); @@ -290,6 +305,30 @@ public: virtual bool OnExceptionInMainLoop(); #endif // wxUSE_EXCEPTIONS + // Yield-related hooks + // ------------------- + + // process all currently pending events right now + // + // it is an error to call Yield() recursively unless the value of + // onlyIfNeeded is true + // + // WARNING: this function is dangerous as it can lead to unexpected + // reentrancies (i.e. when called from an event handler it + // may result in calling the same event handler again), use + // with _extreme_ care or, better, don't use at all! + // NOTE: in wxConsoleBase it doesn't do anything, just a hook for GUI wxApp + bool Yield(bool onlyIfNeeded = false) + { return DoYield(onlyIfNeeded, wxEVT_CATEGORY_ALL); } + bool YieldFor(long eventsToProcess) + { return DoYield(true, eventsToProcess); } + virtual bool IsYielding() const + { return false; } + virtual bool IsEventAllowedInsideYield(wxEventCategory WXUNUSED(cat)) const + { return true; } + // no SafeYield hooks since it uses wxWindow which is not available when wxUSE_GUI=0 + + // debugging support // ----------------- @@ -356,6 +395,9 @@ protected: // for the first time virtual wxAppTraits *CreateTraits(); + // the real yield function hook: + virtual bool DoYield(bool WXUNUSED(onlyIfNeeded), long WXUNUSED(eventsToProcess)) + { return true; } // function used for dynamic wxApp creation static wxAppInitializerFunction ms_appInitFn; @@ -382,9 +424,18 @@ protected: // been started yet or has already terminated) wxEventLoopBase *m_mainLoop; + // the array of the handlers with pending events which needs to be processed + // inside ProcessPendingEvents() + // wxEvtHandlerArray m_handlersWithPendingEvents; FIXME: enable this and remove global lists + + // helper array used by ProcessPendingEvents() + // wxEvtHandlerArray m_handlersWithPendingDelayedEvents; FIXME: enable this and remove global lists + + friend class WXDLLIMPEXP_FWD_BASE wxEvtHandler; + // the application object is a singleton anyhow, there is no sense in // copying it - DECLARE_NO_COPY_CLASS(wxAppConsoleBase) + wxDECLARE_NO_COPY_CLASS(wxAppConsoleBase); }; #if defined(__UNIX__) @@ -441,18 +492,18 @@ public: // the worker functions - usually not used directly by the user code // ----------------------------------------------------------------- + // safer alternatives to Yield(), using wxWindowDisabler + virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded); + virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess); + // returns true if the main thread is inside a Yield() call + virtual bool IsYielding() const + { return m_isInsideYield; } - // process all currently pending events right now - // - // it is an error to call Yield() recursively unless the value of - // onlyIfNeeded is true - // - // WARNING: this function is dangerous as it can lead to unexpected - // reentrancies (i.e. when called from an event handler it - // may result in calling the same event handler again), use - // with _extreme_ care or, better, don't use at all! - virtual bool Yield(bool onlyIfNeeded = false) = 0; + // returns true if events of the given event category should be immediately + // processed inside a wxApp::Yield() call or rather should be queued for + // later processing by the main event loop + virtual bool IsEventAllowedInsideYield(wxEventCategory cat) const; // this virtual function is called in the GUI mode when the application // becomes idle and normally just sends wxIdleEvent to all interested @@ -576,8 +627,11 @@ protected: // does any of our windows have focus? bool m_isActive; + // Yield() helpers: + bool m_isInsideYield; + long m_eventsToProcessInsideYield; - DECLARE_NO_COPY_CLASS(wxAppBase) + wxDECLARE_NO_COPY_CLASS(wxAppBase); }; #if WXWIN_COMPATIBILITY_2_6 @@ -643,20 +697,20 @@ protected: // ------------------------------------------------------ // Force an exit from main loop -extern void WXDLLIMPEXP_BASE wxExit(); +WXDLLIMPEXP_BASE void wxExit(); -// avoid redeclaring this function here if it had been already declated by +// avoid redeclaring this function here if it had been already declared by // wx/utils.h, this results in warnings from g++ with -Wredundant-decls #ifndef wx_YIELD_DECLARED #define wx_YIELD_DECLARED // Yield to other apps/messages -extern bool WXDLLIMPEXP_BASE wxYield(); +WXDLLIMPEXP_CORE bool wxYield(); #endif // wx_YIELD_DECLARED // Yield to other apps/messages -extern void WXDLLIMPEXP_BASE wxWakeUpIdle(); +WXDLLIMPEXP_BASE void wxWakeUpIdle(); // ---------------------------------------------------------------------------- // macros for dynamic creation of the application object