X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/26c093da541a103d66b3120b9a85a799d535d10e..7e08bc5acd8ee4e2f0756f50bf98937a118f9951:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index f19a633abe..8a6a135df9 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -31,7 +31,8 @@ class WXDLLIMPEXP_FWD_BASE wxLog; class WXDLLIMPEXP_FWD_BASE wxMessageOutput; #if wxUSE_GUI - class WXDLLIMPEXP_FWD_CORE wxVideoMode; + struct WXDLLIMPEXP_FWD_CORE wxVideoMode; + class WXDLLIMPEXP_FWD_CORE wxWindow; #endif // ---------------------------------------------------------------------------- @@ -131,8 +132,10 @@ public: // so the app name could be myapp while display name could be "My App" wxString GetAppDisplayName() const { - return m_appDisplayName.empty() ? GetAppName() : m_appDisplayName; + return m_appDisplayName.empty() ? GetAppName().Capitalize() + : m_appDisplayName; } + void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; } // set/get the app class name @@ -198,6 +201,13 @@ public: // allows us to abstract the differences behind the common facade wxAppTraits *GetTraits(); + // this function provides safer access to traits object than + // wxTheApp->GetTraits() during startup or termination when the global + // application object itself may be unavailable + // + // of course, it still returns NULL in this case and the caller must check + // for it + static wxAppTraits *GetTraitsIfExists(); // event processing functions // -------------------------- @@ -211,7 +221,21 @@ public: // had been already processed or won't be processed at all, respectively virtual int FilterEvent(wxEvent& event); + // return true if we're running event loop, i.e. if the events can + // (already) be dispatched + static bool IsMainLoopRunning(); + #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 @@ -226,60 +250,35 @@ public: // exit, if you need to really handle the exceptions you need to override // OnExceptionInMainLoop() virtual void OnUnhandledException(); + + // Function called if an uncaught exception is caught inside the main + // event loop: it may return true to continue running the event loop or + // false to stop it (in the latter case it may rethrow the exception as + // well) + virtual bool OnExceptionInMainLoop(); + #endif // wxUSE_EXCEPTIONS - // event processing functions - // -------------------------- - // return true if we're running event loop, i.e. if the events can - // (already) be dispatched - static bool IsMainLoopRunning(); + // wxEventLoop redirections + // ------------------------ - // process all events in the wxPendingEvents 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 - // also called directly. + virtual void SuspendProcessingOfPendingEvents(); + virtual void ResumeProcessingOfPendingEvents(); virtual void ProcessPendingEvents(); - - // 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(); + virtual bool Pending(); + virtual bool Dispatch(); - // execute the main GUI loop, the function returns when the loop ends virtual int MainLoop(); - - // exit the main GUI loop during the next iteration (i.e. it does not - // stop the program immediately!) virtual void ExitMainLoop(); - // returns true if there are unprocessed events in the event queue - virtual bool Pending(); - - // process the first event in the event queue (blocks until an event - // appears if there are none currently, use Pending() if this is not - // wanted), returns false if the event loop should stop and true - // otherwise - virtual bool Dispatch(); + bool Yield(bool onlyIfNeeded = false); - // this virtual function is called when the application - // becomes idle and normally just sends wxIdleEvent to all interested - // parties - // - // it should return true if more idle events are needed, false if not + virtual void WakeUpIdle(); virtual bool ProcessIdle(); -#if wxUSE_EXCEPTIONS - // Function called if an uncaught exception is caught inside the main - // event loop: it may return true to continue running the event loop or - // false to stop it (in the latter case it may rethrow the exception as - // well) - virtual bool OnExceptionInMainLoop(); -#endif // wxUSE_EXCEPTIONS // debugging support // ----------------- @@ -347,7 +346,6 @@ protected: // for the first time virtual wxAppTraits *CreateTraits(); - // function used for dynamic wxApp creation static wxAppInitializerFunction ms_appInitFn; @@ -373,9 +371,11 @@ protected: // been started yet or has already terminated) wxEventLoopBase *m_mainLoop; + 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__) @@ -432,18 +432,9 @@ public: // the worker functions - usually not used directly by the user code // ----------------------------------------------------------------- - - - // 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; + // safer alternatives to Yield(), using wxWindowDisabler + virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded); + virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess); // this virtual function is called in the GUI mode when the application // becomes idle and normally just sends wxIdleEvent to all interested @@ -567,8 +558,7 @@ protected: // does any of our windows have focus? bool m_isActive; - - DECLARE_NO_COPY_CLASS(wxAppBase) + wxDECLARE_NO_COPY_CLASS(wxAppBase); }; #if WXWIN_COMPATIBILITY_2_6 @@ -596,7 +586,7 @@ protected: #elif defined(__WXX11__) #include "wx/x11/app.h" #elif defined(__WXMAC__) - #include "wx/mac/app.h" + #include "wx/osx/app.h" #elif defined(__WXCOCOA__) #include "wx/cocoa/app.h" #elif defined(__WXPM__) @@ -624,7 +614,7 @@ protected: // // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in // console mode it does nothing at all -#define wxTheApp wx_static_cast(wxApp*, wxApp::GetInstance()) +#define wxTheApp static_cast(wxApp::GetInstance()) // ---------------------------------------------------------------------------- // global functions @@ -634,20 +624,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 @@ -701,7 +691,7 @@ public: wxAppInitializer \ wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \ DECLARE_APP(appname) \ - appname& wxGetApp() { return *wx_static_cast(appname*, wxApp::GetInstance()); } + appname& wxGetApp() { return *static_cast(wxApp::GetInstance()); } // Same as IMPLEMENT_APP() normally but doesn't include themes support in // wxUniversal builds