X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9cf3d218700ccb80a6a2a2715413816c0b2a3ad2..6d8978f030996c834fcd29d85d95ebe261b8defc:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index 5de475c2a8..d4ff103779 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -19,6 +19,7 @@ #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 @@ -130,8 +131,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 @@ -142,6 +145,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 // ---------------------- @@ -181,9 +197,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 // -------------------------- @@ -198,6 +221,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 @@ -221,8 +254,8 @@ 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 + // 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(); @@ -316,8 +349,17 @@ 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 @@ -336,7 +378,8 @@ protected: wxEventLoopBase *CreateMainLoop(); // application info (must be set from the user code) - wxString m_vendorName, // vendor name (e.g. "ACME Inc") + 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 @@ -421,6 +464,10 @@ public: // with _extreme_ care or, better, don't use at all! virtual bool Yield(bool onlyIfNeeded = false) = 0; + // returns true if the main thread is inside a Yield() call + bool IsYielding() const + { return m_isInsideYield; } + // this virtual function is called in the GUI mode when the application // becomes idle and normally just sends wxIdleEvent to all interested // parties @@ -485,6 +532,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) // ------------------------------------------------------------------------ @@ -540,6 +590,7 @@ protected: // does any of our windows have focus? bool m_isActive; + bool m_isInsideYield; DECLARE_NO_COPY_CLASS(wxAppBase) }; @@ -569,7 +620,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__) @@ -597,7 +648,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 @@ -607,13 +658,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 +// 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 @@ -667,7 +725,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