X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c8c7cc23e709bebc7dba5d6e1bbf62b4a556184..b9efe021b554fa3967d1442cf758435c5cd5ae8f:/include/wx/app.h?ds=sidebyside diff --git a/include/wx/app.h b/include/wx/app.h index ccc781568e..02c5aee54d 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -92,7 +92,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 @@ -121,7 +121,7 @@ public: // 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() { throw; } + 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 @@ -173,17 +173,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 @@ -206,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 @@ -251,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 // ----------------- @@ -259,7 +263,7 @@ public: // 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 place where the assert occurred, the text of the // assert itself and the user-specified message #ifdef __WXDEBUG__ virtual void OnAssert(const wxChar *file, @@ -274,10 +278,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 @@ -376,6 +377,18 @@ 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() + { +#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(); @@ -386,7 +399,7 @@ public: // stop the program immediately!) virtual void ExitMainLoop(); - // 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 @@ -398,23 +411,23 @@ 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 @@ -424,7 +437,7 @@ public: // 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 @@ -446,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; } @@ -463,7 +476,7 @@ public: // 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 wxVideoMode& 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; } @@ -527,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; @@ -545,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" @@ -613,47 +628,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" - - #ifndef SW_SHOWNORMAL - #define SW_SHOWNORMAL 1 - #endif - - // WinMain() is always ANSI, even in Unicode build, under normal Windows - // but is always Unicode under CE - #ifdef __WXWINCE__ - typedef wchar_t *wxCmdLineArgType; - #else - typedef char *wxCmdLineArgType; - #endif - - #define IMPLEMENT_WXWIN_MAIN \ - extern int wxEntry(HINSTANCE hInstance, \ - HINSTANCE hPrevInstance = NULL, \ - wxCmdLineArgType pCmdLine = NULL, \ - int nCmdShow = SW_SHOWNORMAL); \ - extern "C" int WINAPI WinMain(HINSTANCE hInstance, \ - HINSTANCE hPrevInstance, \ - wxCmdLineArgType 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 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"