X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4f356748c628f4c9e2a1e062ef76789ec221cb25..05c3f0fc73d9124061c08e3d707b4e3d6bab4ff4:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index a9bf03c287..e24b165c2b 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -21,22 +21,35 @@ #if wxUSE_GUI #include "wx/window.h" // for wxTopLevelWindows + + #include "wx/vidmode.h" #endif // wxUSE_GUI #include "wx/build.h" - -class WXDLLEXPORT wxApp; -class WXDLLEXPORT wxAppTraits; -class WXDLLEXPORT wxCmdLineParser; -class WXDLLEXPORT wxLog; -class WXDLLEXPORT wxMessageOutput; +#include "wx/init.h" // we must declare wxEntry() + +class WXDLLIMPEXP_BASE wxAppConsole; +class WXDLLIMPEXP_BASE wxAppTraits; +class WXDLLIMPEXP_BASE wxCmdLineParser; +class WXDLLIMPEXP_BASE wxLog; +class WXDLLIMPEXP_BASE wxMessageOutput; + +// wxUSE_EVTLOOP_IN_APP is a temporary hack needed until all ports are updated +// to use wxEventLoop, otherwise we get linking errors on wxMac, it's going to +// disappear a.s.a.p. +#ifdef __WXMAC__ + #define wxUSE_EVTLOOP_IN_APP 0 +#else + #define wxUSE_EVTLOOP_IN_APP 1 + class WXDLLEXPORT wxEventLoop; +#endif // ---------------------------------------------------------------------------- // typedefs // ---------------------------------------------------------------------------- // the type of the function used to create a wxApp object on program start up -typedef wxApp* (*wxAppInitializerFunction)(); +typedef wxAppConsole* (*wxAppInitializerFunction)(); // ---------------------------------------------------------------------------- // constants @@ -48,37 +61,11 @@ enum wxPRINT_POSTSCRIPT = 2 }; -// ---------------------------------------------------------------------------- -// support for framebuffer ports -// ---------------------------------------------------------------------------- - -#if wxUSE_GUI -// VS: Fullscreen/framebuffer application needs to choose display mode prior -// to wxWindows initialization. This class holds information about display -// mode. It is used by wxApp::Set/GetDisplayMode. -class WXDLLEXPORT wxDisplayModeInfo -{ -public: - wxDisplayModeInfo() : m_ok(FALSE) {} - wxDisplayModeInfo(unsigned width, unsigned height, unsigned depth) - : m_width(width), m_height(height), m_depth(depth), m_ok(TRUE) {} - - unsigned GetWidth() const { return m_width; } - unsigned GetHeight() const { return m_height; } - unsigned GetDepth() const { return m_depth; } - bool IsOk() const { return m_ok; } - -private: - unsigned m_width, m_height, m_depth; - bool m_ok; -}; -#endif // wxUSE_GUI - // ---------------------------------------------------------------------------- // wxAppConsole: wxApp for non-GUI applications // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxAppConsole : public wxEvtHandler +class WXDLLIMPEXP_BASE wxAppConsole : public wxEvtHandler { public: // ctor and dtor @@ -89,12 +76,25 @@ public: // the virtual functions which may/must be overridden in the derived class // ----------------------------------------------------------------------- + // This is the very first function called for a newly created wxApp object, + // it is used by the library to do the global initialization. If, for some + // reason, you must override it (instead of just overriding OnInit(), as + // usual, for app-specific initializations), do not forget to call the base + // class version! + virtual bool Initialize(int& argc, wxChar **argv); + + // This gives wxCocoa a chance to call OnInit() with a memory pool in place + virtual bool CallOnInit() { return OnInit(); } + // Called before OnRun(), this is a good place to do initialization -- if // anything fails, return false from here to prevent the program from // continuing. The command line is normally parsed here, call the base // class OnInit() to do it. virtual bool OnInit(); + // this is here only temporary hopefully (FIXME) + virtual bool OnInitGui() { return true; } + // This is the replacement for the normal main(): all program work should // be done here. When OnRun() returns, the programs starts shutting down. virtual int OnRun() = 0; @@ -103,6 +103,11 @@ public: // any cleanup matching the initializations done there. virtual int OnExit(); + // This is the very last function called on wxApp object before it is + // destroyed. If you override it (instead of overriding OnExit() as usual) + // do not forget to call the base class version! + virtual void CleanUp(); + // Called when a fatal exception occurs, this function should take care not // to do anything which might provoke a nested exception! It may be // overridden if you wish to react somehow in non-default way (core dump @@ -111,6 +116,20 @@ public: // crash. virtual void OnFatalException() { } +#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(); + + // 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 + virtual void OnUnhandledException() { } +#endif // wxUSE_EXCEPTIONS + // Called from wxExit() function, should terminate the application a.s.a.p. virtual void Exit(); @@ -150,19 +169,21 @@ public: #if wxUSE_CMDLINE_PARSER // this one is called from OnInit() to add all supported options - // to the given parser + // to the given parser (don't forget to call the base class version if you + // override it!) virtual void OnInitCmdLine(wxCmdLineParser& parser); - // called after successfully parsing the command line, return TRUE - // to continue and FALSE to exit + // called after successfully parsing the command line, return true + // to continue and false to exit (don't forget to call the base class + // version if you override it!) virtual bool OnCmdLineParsed(wxCmdLineParser& parser); - // called if "--help" option was specified, return TRUE to continue - // and FALSE to exit + // called if "--help" option was specified, return true to continue + // and false to exit virtual bool OnCmdLineHelp(wxCmdLineParser& parser); // called if incorrect command line options were given, return - // FALSE to abort and TRUE to continue + // false to abort and true to continue virtual bool OnCmdLineError(wxCmdLineParser& parser); #endif // wxUSE_CMDLINE_PARSER @@ -185,12 +206,12 @@ public: // user-defined class (default implementation creates a wxLogGui // object) -- this log object is used by default by all wxLogXXX() // functions. - virtual wxLog *CreateLogTarget(); + wxDEPRECATED( virtual wxLog *CreateLogTarget() ); #endif // wxUSE_LOG // similar to CreateLogTarget() but for the global wxMessageOutput // object - virtual wxMessageOutput *CreateMessageOutput(); + wxDEPRECATED( virtual wxMessageOutput *CreateMessageOutput() ); #endif // WXWIN_COMPATIBILITY_2_4 @@ -207,6 +228,17 @@ public: // had been already processed or won't be processed at all, respectively virtual int FilterEvent(wxEvent& event); +#if wxUSE_EXCEPTIONS + // call the specified handler on the given object with the given event + // + // this method only exists to allow catching the exceptions thrown by any + // event handler, it would lead to an extra (useless) virtual function call + // if the exceptions were not used, so it doesn't even exist in that case + virtual void HandleEvent(wxEvtHandler *handler, + wxEventFunction func, + wxEvent& event) const; +#endif // wxUSE_EXCEPTIONS + // 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 @@ -219,6 +251,10 @@ public: // make sure that idle events are sent again virtual void WakeUpIdle() { } + // this is just a convenience: by providing its implementation here we + // avoid #ifdefs in the code using it + static bool IsMainLoopRunning() { return false; } + // debugging support // ----------------- @@ -239,8 +275,11 @@ public: // check that the wxBuildOptions object (constructed in the application // itself, usually the one from IMPLEMENT_APP() macro) matches the build // options of the library and abort if it doesn't - static bool CheckBuildOptions(const wxBuildOptions& buildOptions); - + static bool CheckBuildOptions(const char *optionsSignature, + const char *componentName); +#if WXWIN_COMPATIBILITY_2_4 + wxDEPRECATED( static bool CheckBuildOptions(const wxBuildOptions& buildOptions) ); +#endif // implementation only from now on // ------------------------------- @@ -251,6 +290,13 @@ public: static wxAppInitializerFunction GetInitializerFunction() { return ms_appInitFn; } + // accessors for ms_appInstance field (external code might wish to modify + // it, this is why we provide a setter here as well, but you should really + // know what you're doing if you call it), wxTheApp is usually used instead + // of GetInstance() + static wxAppConsole *GetInstance() { return ms_appInstance; } + static void SetInstance(wxAppConsole *app) { ms_appInstance = app; } + // command line arguments (public for backwards compatibility) int argc; @@ -265,6 +311,10 @@ protected: // function used for dynamic wxApp creation static wxAppInitializerFunction ms_appInitFn; + // the one and only global application object + static wxAppConsole *ms_appInstance; + + // application info (must be set from the user code) wxString m_vendorName, // vendor name (ACME Inc) m_appName, // app name @@ -286,7 +336,7 @@ protected: #if wxUSE_GUI -class WXDLLEXPORT wxAppBase : public wxAppConsole +class WXDLLIMPEXP_CORE wxAppBase : public wxAppConsole { public: wxAppBase(); @@ -295,6 +345,11 @@ public: // the virtual functions which may/must be overridden in the derived class // ----------------------------------------------------------------------- + // very first initialization function + // + // Override: very rarely + virtual bool Initialize(int& argc, wxChar **argv); + // a platform-dependent version of OnInit(): the code here is likely to // depend on the toolkit. default version does nothing. // @@ -310,53 +365,79 @@ public: // Override: rarely in GUI applications, always in console ones. virtual int OnRun(); - // exit the main loop thus terminating the application - virtual void Exit(); + // a matching function for OnInit() + virtual int OnExit(); + + // very last clean up function + // + // Override: very rarely + virtual void CleanUp(); // the worker functions - usually not used directly by the user code // ----------------------------------------------------------------- + // return true if we're running main loop, i.e. if the events can + // (already) be dispatched + static bool IsMainLoopRunning() + { +#if wxUSE_EVTLOOP_IN_APP + wxAppBase *app = wx_static_cast(wxAppBase *, GetInstance()); + return app && app->m_mainLoop != NULL; +#else + return false; +#endif + } + // execute the main GUI loop, the function returns when the loop ends - virtual int MainLoop() = 0; + virtual int MainLoop(); + + // exit the main loop thus terminating the application + virtual void Exit(); // exit the main GUI loop during the next iteration (i.e. it does not // stop the program immediately!) - virtual void ExitMainLoop() = 0; + virtual void ExitMainLoop(); - // returns TRUE if the program is initialized - virtual bool Initialized() = 0; - - // returns TRUE if there are unprocessed events in the event queue - virtual bool Pending() = 0; + // 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 - // apperas if there are none currently) - virtual void Dispatch() = 0; + // 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(); // process all currently pending events right now // // it is an error to call Yield() recursively unless the value of - // onlyIfNeeded is TRUE + // 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; + virtual bool Yield(bool onlyIfNeeded = false) = 0; // this virtual function is called in the GUI mode 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 bool ProcessIdle() = 0; + // it should return true if more idle events are needed, false if not + virtual bool ProcessIdle(); + + // Send idle event to window and all subwindows + // Returns true if more idle time is requested. + virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event); + + // Perform standard OnIdle behaviour: call from port's OnIdle + void OnIdle(wxIdleEvent& event); // top level window functions // -------------------------- - // return TRUE if our app has focus + // return true if our app has focus virtual bool IsActive() const { return m_isActive; } // set the "main" top level window @@ -378,7 +459,7 @@ public: // control the exit behaviour: by default, the program will exit the // main loop (and so, usually, terminate) when the last top-level // program window is deleted. Beware that if you disable this behaviour - // (with SetExitOnFrameDelete(FALSE)), you'll have to call + // (with SetExitOnFrameDelete(false)), you'll have to call // ExitMainLoop() explicitly from somewhere. void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag ? Yes : No; } @@ -391,11 +472,11 @@ public: // Get display mode that is used use. This is only used in framebuffer // wxWin ports (such as wxMGL). - virtual wxDisplayModeInfo GetDisplayMode() const { return wxDisplayModeInfo(); } + virtual wxVideoMode GetDisplayMode() const { return wxVideoMode(); } // Set display mode to use. This is only used in framebuffer wxWin // ports (such as wxMGL). This method should be called from // wxApp::OnInitGui - virtual bool SetDisplayMode(const wxDisplayModeInfo& WXUNUSED(info)) { return TRUE; } + virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; } // set use of best visual flag (see below) void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; } @@ -409,6 +490,14 @@ public: int GetPrintMode() const { return wxPRINT_POSTSCRIPT; } + // command line parsing (GUI-specific) + // ------------------------------------------------------------------------ + +#if wxUSE_CMDLINE_PARSER + virtual bool OnCmdLineParsed(wxCmdLineParser& parser); + virtual void OnInitCmdLine(wxCmdLineParser& parser); +#endif + // miscellaneous other stuff // ------------------------------------------------------------------------ @@ -417,12 +506,26 @@ public: // deactivated virtual void SetActive(bool isActive, wxWindow *lastFocus); + // OBSOLETE: don't use, always returns true + // + // returns true if the program is successfully initialized + bool Initialized() { return true; } + protected: + // delete all objects in wxPendingDelete list + void DeletePendingObjects(); + // override base class method to use GUI traits virtual wxAppTraits *CreateTraits(); +#if wxUSE_EVTLOOP_IN_APP + // the main event loop of the application (may be NULL if the loop hasn't + // been started yet or has already terminated) + wxEventLoop *m_mainLoop; +#endif // wxUSE_EVTLOOP_IN_APP + // the main top level window (may be NULL) wxWindow *m_topWindow; @@ -437,7 +540,7 @@ protected: Yes } m_exitOnFrameDelete; - // TRUE if the apps whats to use the best visual on systems where + // true if the apps whats to use the best visual on systems where // more than one are available (Sun, SGI, XFree86 4.0 ?) bool m_useBestVisual; @@ -455,7 +558,9 @@ protected: // ---------------------------------------------------------------------------- #if wxUSE_GUI - #if defined(__WXMSW__) + #if defined(__WXPALMOS__) + #include "wx/palmos/app.h" + #elif defined(__WXMSW__) #include "wx/msw/app.h" #elif defined(__WXMOTIF__) #include "wx/motif/app.h" @@ -473,21 +578,24 @@ protected: #include "wx/os2/app.h" #endif #else // !GUI - // can't use typedef because wxApp forward declared as a class - class WXDLLEXPORT wxApp : public wxAppConsole - { - }; + // allow using just wxApp (instead of wxAppConsole) in console programs + typedef wxAppConsole wxApp; #endif // GUI/!GUI // ---------------------------------------------------------------------------- // the global data // ---------------------------------------------------------------------------- -// the one and only application object - use of wxTheApp in application code -// is discouraged, consider using DECLARE_APP() after which you may call -// wxGetApp() which will return the object of the correct type (i.e. MyApp and -// not wxApp) -WXDLLEXPORT_DATA(extern wxApp*) wxTheApp; +// for compatibility, we define this macro to access the global application +// object of type wxApp +// +// note that instead of using of wxTheApp in application code you should +// consider using DECLARE_APP() after which you may call wxGetApp() which will +// return the object of the correct type (i.e. MyApp and not wxApp) +// +// 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 ((wxApp *)wxApp::GetInstance()) // ---------------------------------------------------------------------------- // global functions @@ -497,51 +605,13 @@ WXDLLEXPORT_DATA(extern wxApp*) wxTheApp; // ------------------------------------------------------ // Force an exit from main loop -extern void WXDLLEXPORT wxExit(); +extern void WXDLLIMPEXP_BASE wxExit(); // Yield to other apps/messages -extern bool WXDLLEXPORT wxYield(); +extern bool WXDLLIMPEXP_BASE wxYield(); // Yield to other apps/messages -extern void WXDLLEXPORT wxWakeUpIdle(); - - -// console applications may avoid using DECLARE_APP and IMPLEMENT_APP macros -// and call these functions instead at the program startup and termination -// ------------------------------------------------------------------------- - -#if !wxUSE_GUI - -// initialize the library (may be called as many times as needed, but each -// call to wxInitialize() must be matched by wxUninitialize()) -extern bool WXDLLEXPORT wxInitialize(); - -// clean up - the library can't be used any more after the last call to -// wxUninitialize() -extern void WXDLLEXPORT wxUninitialize(); - -// create an object of this class on stack to initialize/cleanup thel ibrary -// automatically -class WXDLLEXPORT wxInitializer -{ -public: - // initialize the library - wxInitializer() { m_ok = wxInitialize(); } - - // has the initialization been successful? (explicit test) - bool IsOk() const { return m_ok; } - - // has the initialization been successful? (implicit test) - operator bool() const { return m_ok; } - - // dtor only does clean up if we initialized the library properly - ~wxInitializer() { if ( m_ok ) wxUninitialize(); } - -private: - bool m_ok; -}; - -#endif // !wxUSE_GUI +extern void WXDLLIMPEXP_BASE wxWakeUpIdle(); // ---------------------------------------------------------------------------- // macros for dynamic creation of the application object @@ -551,47 +621,24 @@ private: // creator function. wxApp can then call this function to create a new app // object. Convoluted, but necessary. -class WXDLLEXPORT wxAppInitializer +class WXDLLIMPEXP_BASE wxAppInitializer { public: wxAppInitializer(wxAppInitializerFunction fn) { wxApp::SetInitializerFunction(fn); } }; -// Here's a macro you can use if your compiler really, really wants main() to -// be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this -// code if required. +// the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if +// your compiler really, really wants main() to be in your main program (e.g. +// hello.cpp). Now IMPLEMENT_APP should add this code if required. -#if !wxUSE_GUI || defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXPM__) || defined(__WXMGL__) || defined(__WXCOCOA__) - #define IMPLEMENT_WXWIN_MAIN \ - extern int wxEntry( int argc, char **argv ); \ - int main(int argc, char **argv) { return wxEntry(argc, argv); } -#elif defined(__WXMAC__) - // wxMac seems to have a specific wxEntry prototype - #define IMPLEMENT_WXWIN_MAIN \ - extern int wxEntry( int argc, char **argv, bool enterLoop = TRUE ); \ +#define IMPLEMENT_WXWIN_MAIN_CONSOLE \ int main(int argc, char **argv) { return wxEntry(argc, argv); } -#elif defined(__WXMSW__) && defined(WXUSINGDLL) - // NT defines APIENTRY, 3.x not - #if !defined(WXAPIENTRY) - #define WXAPIENTRY WXFAR wxSTDCALL - #endif - #include - #include "wx/msw/winundef.h" - - #define IMPLEMENT_WXWIN_MAIN \ - extern "C" int WXAPIENTRY WinMain(HINSTANCE hInstance,\ - HINSTANCE hPrevInstance,\ - LPSTR m_lpCmdLine, int nCmdShow)\ - {\ - return wxEntry((WXHINSTANCE) hInstance,\ - (WXHINSTANCE) hPrevInstance,\ - m_lpCmdLine, nCmdShow);\ - } -#else - #define IMPLEMENT_WXWIN_MAIN -#endif +// port-specific header could have defined it already in some special wau +#ifndef IMPLEMENT_WXWIN_MAIN + #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE +#endif // defined(IMPLEMENT_WXWIN_MAIN) #ifdef __WXUNIVERSAL__ #include "wx/univ/theme.h" @@ -605,13 +652,15 @@ public: // Use this macro if you want to define your own main() or WinMain() function // and call wxEntry() from there. -#define IMPLEMENT_APP_NO_MAIN(appname) \ - wxApp *wxCreateApp() \ - { \ - wxApp::CheckBuildOptions(wxBuildOptions()); \ - return new appname; \ - } \ - wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \ +#define IMPLEMENT_APP_NO_MAIN(appname) \ + wxAppConsole *wxCreateApp() \ + { \ + wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \ + "your program"); \ + return new appname; \ + } \ + wxAppInitializer \ + wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \ appname& wxGetApp() { return *(appname *)wxTheApp; } // Same as IMPLEMENT_APP() normally but doesn't include themes support in @@ -626,9 +675,14 @@ public: IMPLEMENT_APP_NO_THEMES(appname) \ IMPLEMENT_WX_THEME_SUPPORT +// Same as IMPLEMENT_APP(), but for console applications. +#define IMPLEMENT_APP_CONSOLE(appname) \ + IMPLEMENT_APP_NO_MAIN(appname) \ + IMPLEMENT_WXWIN_MAIN_CONSOLE + // this macro can be used multiple times and just allows you to use wxGetApp() // function #define DECLARE_APP(appname) extern appname& wxGetApp(); -#endif - // _WX_APP_H_BASE_ +#endif // _WX_APP_H_BASE_ +