X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e0954e729dabaad5603d9970d123d6b96ed73463..02cecc4dc2c07b3e4b109edf44c4c87a2fed87d9:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index b82a6efc2d..c3b87dd018 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -19,18 +19,19 @@ #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; #endif // ---------------------------------------------------------------------------- @@ -123,6 +124,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 +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 // ---------------------- @@ -170,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 // -------------------------- @@ -197,10 +231,10 @@ public: wxEvent& event) const; // Called when an unhandled C++ exception occurs inside OnRun(): note that - // the exception type is lost by now, so if you really want to handle the - // exception you should override OnRun() and put a try/catch around - // MainLoop() call there or use OnExceptionInMainLoop() - virtual void OnUnhandledException() { } + // the main event loop has already terminated by now and the program will + // exit, if you need to really handle the exceptions you need to override + // OnExceptionInMainLoop() + virtual void OnUnhandledException(); #endif // wxUSE_EXCEPTIONS // event processing functions @@ -210,8 +244,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(); @@ -305,8 +339,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 @@ -325,9 +368,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 @@ -345,7 +390,8 @@ protected: #if defined(__UNIX__) #include "wx/unix/app.h" #else - typedef wxAppConsoleBase wxAppConsole; + // this has to be a class and not a typedef as we forward declare it + class wxAppConsole : public wxAppConsoleBase { }; #endif // ---------------------------------------------------------------------------- @@ -408,6 +454,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 @@ -457,7 +507,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; } @@ -472,6 +522,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) // ------------------------------------------------------------------------ @@ -496,10 +549,6 @@ public: wxDEPRECATED( bool Initialized() ); #endif // WXWIN_COMPATIBILITY_2_6 - // perform standard OnIdle behaviour, ensure that this is always called - void OnIdle(wxIdleEvent& event); - - protected: // delete all objects in wxPendingDelete list void DeletePendingObjects(); @@ -531,6 +580,7 @@ protected: // does any of our windows have focus? bool m_isActive; + bool m_isInsideYield; DECLARE_NO_COPY_CLASS(wxAppBase) }; @@ -560,7 +610,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__) @@ -588,7 +638,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 @@ -600,9 +650,16 @@ protected: // Force an exit from main loop extern void WXDLLIMPEXP_BASE 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(); +#endif // wx_YIELD_DECLARED + // Yield to other apps/messages extern void WXDLLIMPEXP_BASE wxWakeUpIdle(); @@ -658,7 +715,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