X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0728199b911be9095406cf05059a5a180e707778..e276acb530f41f0b87c4576c0215201a8a767dff:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index b5542f913a..a5b60fed2b 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -19,18 +19,20 @@ #include "wx/event.h" // for the base class #include "wx/build.h" +#include "wx/cmdargs.h" // for wxCmdLineArgsArray used by wxApp::argv #include "wx/init.h" // we must declare wxEntry() #include "wx/intl.h" // for wxLayoutDirection -class WXDLLIMPEXP_BASE wxAppConsole; -class WXDLLIMPEXP_BASE wxAppTraits; -class WXDLLIMPEXP_BASE wxCmdLineParser; -class WXDLLIMPEXP_BASE wxEventLoopBase; -class WXDLLIMPEXP_BASE wxLog; -class WXDLLIMPEXP_BASE wxMessageOutput; +class WXDLLIMPEXP_FWD_BASE wxAppConsole; +class WXDLLIMPEXP_FWD_BASE wxAppTraits; +class WXDLLIMPEXP_FWD_BASE wxCmdLineParser; +class WXDLLIMPEXP_FWD_BASE wxEventLoopBase; +class WXDLLIMPEXP_FWD_BASE wxLog; +class WXDLLIMPEXP_FWD_BASE wxMessageOutput; #if wxUSE_GUI - struct WXDLLIMPEXP_CORE wxVideoMode; + struct WXDLLIMPEXP_FWD_CORE wxVideoMode; + class WXDLLIMPEXP_FWD_CORE wxWindow; #endif // ---------------------------------------------------------------------------- @@ -123,6 +125,19 @@ public: } void SetAppName(const wxString& name) { m_appName = name; } + // set/get the application display name: the display name is the name + // shown to the user in titles, reports, etc while the app name is + // used for paths, config, and other places the user doesn't see + // + // so the app name could be myapp while display name could be "My App" + wxString GetAppDisplayName() const + { + return m_appDisplayName.empty() ? GetAppName().Capitalize() + : m_appDisplayName; + } + + void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; } + // set/get the app class name wxString GetClassName() const { return m_className; } void SetClassName(const wxString& name) { m_className = name; } @@ -131,6 +146,19 @@ public: const wxString& GetVendorName() const { return m_vendorName; } void SetVendorName(const wxString& name) { m_vendorName = name; } + // set/get the vendor display name: the display name is shown + // in titles/reports/dialogs to the user, while the vendor name + // is used in some areas such as wxConfig, wxStandardPaths, etc + const wxString& GetVendorDisplayName() const + { + return m_vendorDisplayName.empty() ? GetVendorName() + : m_vendorDisplayName; + } + void SetVendorDisplayName(const wxString& name) + { + m_vendorDisplayName = name; + } + // cmd line parsing stuff // ---------------------- @@ -170,9 +198,16 @@ public: // either should be configurable by the user (then he can change the // default behaviour simply by overriding CreateTraits() and returning his // own traits object) or which is GUI/console dependent as then wxAppTraits - // allows us to abstract the differences behind the common fa�de + // 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 // -------------------------- @@ -187,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 @@ -210,8 +255,15 @@ public: // (already) be dispatched static bool IsMainLoopRunning(); - // process all events in the wxPendingEvents list -- it is necessary to - // call this function to process posted events. This happens during each + // 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 // also called directly. virtual void ProcessPendingEvents(); @@ -219,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(); @@ -256,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 // ----------------- @@ -305,14 +378,26 @@ public: // command line arguments (public for backwards compatibility) - int argc; - wxChar **argv; + int argc; + + // this object is implicitly convertible to either "char**" (traditional + // type of argv parameter of main()) or to "wchar_t **" (for compatibility + // with Unicode build in previous wx versions and because the command line + // can, in pr +#if wxUSE_UNICODE + wxCmdLineArgsArray argv; +#else + char **argv; +#endif protected: // the function which creates the traits object when GetTraits() needs it // 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; @@ -325,9 +410,11 @@ protected: wxEventLoopBase *CreateMainLoop(); // application info (must be set from the user code) - wxString m_vendorName, // vendor name (ACME Inc) - m_appName, // app name - m_className; // class name + wxString m_vendorName, // vendor name ("acme") + m_vendorDisplayName, // vendor display name (e.g. "ACME Inc") + m_appName, // app name ("myapp") + m_appDisplayName, // app display name ("My Application") + m_className; // class name // the class defining the application behaviour, NULL initially and created // by GetTraits() when first needed @@ -337,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__) @@ -396,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 @@ -458,7 +554,7 @@ public: virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; } // set use of best visual flag (see below) - void SetUseBestVisual( bool flag, bool forceTrueColour = false ) + void SetUseBestVisual( bool flag, bool forceTrueColour = false ) { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; } bool GetUseBestVisual() const { return m_useBestVisual; } @@ -473,6 +569,9 @@ public: // if it's unknown virtual wxLayoutDirection GetLayoutDirection() const; + // Change the theme used by the application, return true on success. + virtual bool SetNativeTheme(const wxString& WXUNUSED(theme)) { return false; } + // command line parsing (GUI-specific) // ------------------------------------------------------------------------ @@ -528,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 @@ -557,7 +659,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__) @@ -585,7 +687,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 @@ -595,13 +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 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 @@ -655,7 +764,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