X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/883117d1265abfc750b1b08582feda80c932a2cf..be2001feddfb5f388c61a5a6f64146f0193e239b:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index eb507ed17d..4fc847b33c 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -21,6 +21,8 @@ #if wxUSE_GUI #include "wx/window.h" // for wxTopLevelWindows + + #include "wx/vidmode.h" #endif // wxUSE_GUI #include "wx/build.h" @@ -32,13 +34,7 @@ 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 +#if wxUSE_GUI class WXDLLEXPORT wxEventLoop; #endif @@ -59,33 +55,6 @@ 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 WXDLLIMPEXP_CORE 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 // ---------------------------------------------------------------------------- @@ -117,7 +86,7 @@ public: // class OnInit() to do it. virtual bool OnInit(); - // this is here only temproary hopefully (FIXME) + // this is here only temporary hopefully (FIXME) virtual bool OnInitGui() { return true; } // This is the replacement for the normal main(): all program work should @@ -141,14 +110,6 @@ public: // crash. virtual void OnFatalException() { } -#if wxUSE_EXCEPTIONS - // 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(); @@ -192,17 +153,17 @@ public: // override it!) virtual void OnInitCmdLine(wxCmdLineParser& parser); - // called after successfully parsing the command line, return TRUE - // to continue and FALSE to exit (don't forget to call the base class + // 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 @@ -225,12 +186,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 @@ -256,6 +217,12 @@ public: virtual void HandleEvent(wxEvtHandler *handler, wxEventFunction func, 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() { } #endif // wxUSE_EXCEPTIONS // process all events in the wxPendingEvents list -- it is necessary to @@ -270,17 +237,30 @@ 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 // ----------------- +#ifdef __WXDEBUG__ // this function is called when an assert failure occurs, the base class // version does the normal processing (i.e. shows the usual assert failure // dialog box) // - // the arguments are the place where the assert occured, the text of the + // the arguments are the location of the failed assert (func may be empty + // if the compiler doesn't support C99 __FUNCTION__), the text of the // assert itself and the user-specified message -#ifdef __WXDEBUG__ + virtual void OnAssertFailure(const wxChar *file, + int line, + const wxChar *func, + const wxChar *cond, + const wxChar *msg); + + // old version of the function without func parameter, for compatibility + // only, override OnAssertFailure() in the new code virtual void OnAssert(const wxChar *file, int line, const wxChar *cond, @@ -293,10 +273,7 @@ public: static bool CheckBuildOptions(const char *optionsSignature, const char *componentName); #if WXWIN_COMPATIBILITY_2_4 - static bool CheckBuildOptions(const wxBuildOptions& buildOptions) - { - return CheckBuildOptions(buildOptions.m_signature, "your program"); - } + wxDEPRECATED( static bool CheckBuildOptions(const wxBuildOptions& buildOptions) ); #endif // implementation only from now on @@ -395,6 +372,14 @@ public: // 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() + { + wxAppBase *app = wx_static_cast(wxAppBase *, GetInstance()); + return app && app->m_mainLoop != NULL; + } + // execute the main GUI loop, the function returns when the loop ends virtual int MainLoop(); @@ -405,11 +390,7 @@ public: // stop the program immediately!) virtual void ExitMainLoop(); - // returns true if the program is initialized, i.e. OnInit() has been - // completed successfully - virtual bool Initialized() = 0; - - // returns TRUE if there are unprocessed events in the event queue + // 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 @@ -421,33 +402,39 @@ public: // 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 + // 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. + // 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); + +#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 // 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 @@ -469,7 +456,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; } @@ -482,11 +469,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; } @@ -516,6 +503,16 @@ public: // deactivated virtual void SetActive(bool isActive, wxWindow *lastFocus); +#if WXWIN_COMPATIBILITY_2_6 + // OBSOLETE: don't use, always returns true + // + // returns true if the program is successfully initialized + 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 @@ -525,11 +522,9 @@ protected: 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; @@ -545,17 +540,21 @@ protected: Yes } m_exitOnFrameDelete; - // TRUE if the apps whats to use the best visual on systems where + // true if the app wants to use the best visual on systems where // more than one are available (Sun, SGI, XFree86 4.0 ?) bool m_useBestVisual; - // does any of our windows has focus? + // does any of our windows have focus? bool m_isActive; DECLARE_NO_COPY_CLASS(wxAppBase) }; +#if WXWIN_COMPATIBILITY_2_6 + inline bool wxAppBase::Initialized() { return true; } +#endif // WXWIN_COMPATIBILITY_2_6 + #endif // wxUSE_GUI // ---------------------------------------------------------------------------- @@ -563,14 +562,18 @@ 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" #elif defined(__WXMGL__) #include "wx/mgl/app.h" - #elif defined(__WXGTK__) + #elif defined(__WXGTK20__) #include "wx/gtk/app.h" + #elif defined(__WXGTK__) + #include "wx/gtk1/app.h" #elif defined(__WXX11__) #include "wx/x11/app.h" #elif defined(__WXMAC__) @@ -631,41 +634,17 @@ public: { 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. #define IMPLEMENT_WXWIN_MAIN_CONSOLE \ int main(int argc, char **argv) { return wxEntry(argc, argv); } -#if !wxUSE_GUI || !defined(__WXMSW__) - #define IMPLEMENT_WXWIN_MAIN \ - IMPLEMENT_WXWIN_MAIN_CONSOLE -#elif defined(__WXMSW__) - // we need HINSTANCE declaration to define WinMain() - #include "wx/msw/wrapwin.h" - - #ifdef SW_SHOWNORMAL - #define wxSW_SHOWNORMAL SW_SHOWNORMAL - #else - #define wxSW_SHOWNORMAL 0 - #endif - - #define IMPLEMENT_WXWIN_MAIN \ - extern int wxEntry(HINSTANCE hInstance, \ - HINSTANCE hPrevInstance = NULL, \ - char *pCmdLine = NULL, \ - int nCmdShow = wxSW_SHOWNORMAL); \ - extern "C" int WINAPI WinMain(HINSTANCE hInstance, \ - HINSTANCE hPrevInstance, \ - char *lpCmdLine, \ - int nCmdShow) \ - { \ - return wxEntry(hInstance, hPrevInstance, lpCmdLine, nCmdShow); \ - } -#else - #define IMPLEMENT_WXWIN_MAIN -#endif +// port-specific header could have defined it already in some special way +#ifndef IMPLEMENT_WXWIN_MAIN + #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE +#endif // defined(IMPLEMENT_WXWIN_MAIN) #ifdef __WXUNIVERSAL__ #include "wx/univ/theme.h" @@ -688,6 +667,7 @@ public: } \ wxAppInitializer \ wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \ + DECLARE_APP(appname) \ appname& wxGetApp() { return *(appname *)wxTheApp; } // Same as IMPLEMENT_APP() normally but doesn't include themes support in @@ -711,5 +691,12 @@ public: // function #define DECLARE_APP(appname) extern appname& wxGetApp(); -#endif // _WX_APP_H_BASE_ +// declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed +// anywhere else but at the very least it suppresses icc warnings about +// defining extern symbols without prior declaration, and it shouldn't do any +// harm +extern wxAppConsole *wxCreateApp(); +extern wxAppInitializer wxTheAppInitializer; + +#endif // _WX_APP_H_BASE_