X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/04ef50df3a0fa3c343800c554e609f98fc7575cc..f41bc3e3f3fda37fba548440b230288c5eed0953:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index 8f0b44bbed..8324651d60 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: app.h +// Name: wx/app.h // Purpose: wxAppBase class and macros used for declaration of wxApp // derived class in the user code // Author: Julian Smart @@ -31,6 +31,8 @@ typedef wxObject* (*wxAppInitializerFunction)(); #endif +class WXDLLEXPORT wxCmdLineParser; + // ---------------------------------------------------------------------------- // headers we have to include here // ---------------------------------------------------------------------------- @@ -38,13 +40,19 @@ #include "wx/event.h" // for the base class #if wxUSE_GUI - #include "wx/window.h" // for wxTopLevelWindows + #include "wx/window.h" // for wxTopLevelWindows #endif // wxUSE_GUI #if wxUSE_LOG #include "wx/log.h" #endif +#if WXWIN_COMPATIBILITY_2_2 + #include "wx/icon.h" +#endif + +#include "wx/build.h" + // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- @@ -52,30 +60,57 @@ static const int wxPRINT_WINDOWS = 1; static const int 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 + // ---------------------------------------------------------------------------- // the common part of wxApp implementations for all platforms // ---------------------------------------------------------------------------- class WXDLLEXPORT wxAppBase : public wxEvtHandler { + DECLARE_NO_COPY_CLASS(wxAppBase) + public: wxAppBase(); + virtual ~wxAppBase(); // the virtual functions which may/must be overridden in the derived class // ----------------------------------------------------------------------- -#ifdef __WXMAC_X__ - virtual ~wxAppBase() {} // Added min for Mac X -#endif + // called during the program initialization, returning FALSE from here // prevents the program from continuing - it's a good place to create // the top level program window and return TRUE. // // Override: always in GUI application, rarely in console ones. -#if wxUSE_GUI - virtual bool OnInit() { return FALSE; }; -#else // !GUI - virtual bool OnInit() { return TRUE; }; -#endif // wxUSE_GUI + virtual bool OnInit(); + + // initializes wxMessageOutput; other responsibilities + // may be added later + virtual void DoInit(); #if wxUSE_GUI // a platform-dependent version of OnInit(): the code here is likely to @@ -116,6 +151,8 @@ public: // Override: rarely. virtual void OnFatalException() { } + virtual bool ProcessIdle() = 0; + // the worker functions - usually not used directly by the user code // ----------------------------------------------------------------- @@ -136,6 +173,17 @@ public: // process the first event in the event queue (blocks until an event // apperas if there are none currently) virtual void Dispatch() = 0; + + // process all currently pending events right now + // + // it is an error to call Yield() recursively unless the value of + // 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; #endif // wxUSE_GUI // application info: name, description, vendor @@ -196,6 +244,34 @@ public: #endif // wxUSE_GUI + // cmd line parsing stuff + // ---------------------- + + // all of these methods may be overridden in the derived class to + // customize the command line parsing (by default only a few standard + // options are handled) + // + // you also need to call wxApp::OnInit() from YourApp::OnInit() for all + // this to work + +#if wxUSE_CMDLINE_PARSER + // this one is called from OnInit() to add all supported options + // to the given parser + virtual void OnInitCmdLine(wxCmdLineParser& parser); + + // called after successfully parsing the command line, return TRUE + // to continue and FALSE to exit + virtual bool OnCmdLineParsed(wxCmdLineParser& parser); + + // 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 + virtual bool OnCmdLineError(wxCmdLineParser& parser); +#endif // wxUSE_CMDLINE_PARSER + // miscellaneous customization functions // ------------------------------------- @@ -205,7 +281,7 @@ public: // object) - this log object is used by default by all wxLogXXX() // functions. virtual wxLog *CreateLogTarget() - #if wxUSE_GUI && wxUSE_LOGGUI + #if wxUSE_GUI && wxUSE_LOGGUI && !defined(__WXMICROWIN__) { return new wxLogGui; } #else // !GUI { return new wxLogStderr; } @@ -213,14 +289,20 @@ public: #endif // wxUSE_LOG #if wxUSE_GUI + + #if WXWIN_COMPATIBILITY_2_2 // get the standard icon used by wxWin dialogs - this allows the user // to customize the standard dialogs. The 'which' parameter is one of // wxICON_XXX values - virtual wxIcon GetStdIcon(int which) const = 0; + virtual wxIcon GetStdIcon(int WXUNUSED(which)) const { return wxNullIcon; } + #endif - // VZ: what does this do exactly? - void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; } - bool GetWantDebugOutput() const { return m_wantDebugOutput; } + // Get display mode that is used use. This is only used in framebuffer wxWin ports + // (such as wxMGL). + virtual wxDisplayModeInfo GetDisplayMode() const { return wxDisplayModeInfo(); } + // 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; } // set use of best visual flag (see below) void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; } @@ -239,6 +321,48 @@ public: virtual void SetActive(bool isActive, wxWindow *lastFocus); #endif // wxUSE_GUI + // this method allows to filter all the events processed by the program, so + // you should try to return quickly from it to avoid slowing down the + // program to the crawl + // + // return value should be -1 to continue with the normal event processing, + // or TRUE or FALSE to stop further processing and pretend that the event + // had been already processed or won't be processed at all, respectively + virtual int FilterEvent(wxEvent& event); + + // debugging support + // ----------------- + + // 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 + // assert itself and the user-specified message +#ifdef __WXDEBUG__ + virtual void OnAssert(const wxChar *file, + int line, + const wxChar *cond, + const wxChar *msg); +#endif // __WXDEBUG__ + + // 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); + + // deprecated functions, please updae your code to not use them! + // ------------------------------------------------------------- + +#if WXWIN_COMPATIBILITY_2_2 + // used by obsolete wxDebugMsg only + void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; } + bool GetWantDebugOutput() const { return m_wantDebugOutput; } + + // TRUE if the application wants to get debug output + bool m_wantDebugOutput; +#endif // WXWIN_COMPATIBILITY_2_2 + // implementation only from now on // ------------------------------- @@ -264,9 +388,6 @@ protected: m_appName, // app name m_className; // class name - // TRUE if the application wants to get debug output - bool m_wantDebugOutput; - #if wxUSE_GUI // the main top level window - may be NULL wxWindow *m_topWindow; @@ -294,10 +415,10 @@ protected: #include "wx/motif/app.h" #elif defined(__WXMGL__) #include "wx/mgl/app.h" - #elif defined(__WXQT__) - #include "wx/qt/app.h" #elif defined(__WXGTK__) #include "wx/gtk/app.h" + #elif defined(__WXX11__) + #include "wx/x11/app.h" #elif defined(__WXMAC__) #include "wx/mac/app.h" #elif defined(__WXPM__) @@ -407,12 +528,12 @@ public: // 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__) +#if !wxUSE_GUI || defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXPM__) || defined(__WXMGL__) #define IMPLEMENT_WXWIN_MAIN \ extern int wxEntry( int argc, char *argv[] ); \ int main(int argc, char *argv[]) { return wxEntry(argc, argv); } #elif defined(__WXMAC__) && defined(__UNIX__) - // wxMac seems to have a specific wxEntry prototype + // wxMac seems to have a specific wxEntry prototype #define IMPLEMENT_WXWIN_MAIN \ extern int wxEntry( int argc, char *argv[], bool enterLoop = 1 ); \ int main(int argc, char *argv[]) { return wxEntry(argc, argv); } @@ -438,21 +559,41 @@ public: #define IMPLEMENT_WXWIN_MAIN #endif -// Use this macro exactly once, the argument is the name of the wxApp-derived -// class which is the class of your application. -#define IMPLEMENT_APP(appname) \ - wxApp *wxCreateApp() { return new appname; } \ - wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \ - appname& wxGetApp() { return *(appname *)wxTheApp; } \ - IMPLEMENT_WXWIN_MAIN +#ifdef __WXUNIVERSAL__ + #include "wx/univ/theme.h" + + #define IMPLEMENT_WX_THEME_SUPPORT \ + WX_USE_THEME(win32); \ + WX_USE_THEME(gtk); +#else + #define IMPLEMENT_WX_THEME_SUPPORT +#endif // 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() { return new appname; } \ + wxApp *wxCreateApp() \ + { \ + wxApp::CheckBuildOptions(wxBuildOptions()); \ + return new appname; \ + } \ wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \ appname& wxGetApp() { return *(appname *)wxTheApp; } +// Same as IMPLEMENT_APP() normally but doesn't include themes support in +// wxUniversal builds +#define IMPLEMENT_APP_NO_THEMES(appname) \ + IMPLEMENT_APP_NO_MAIN(appname) \ + IMPLEMENT_WXWIN_MAIN + +// Use this macro exactly once, the argument is the name of the wxApp-derived +// class which is the class of your application. +#define IMPLEMENT_APP(appname) \ + IMPLEMENT_APP_NO_THEMES(appname) \ + IMPLEMENT_WX_THEME_SUPPORT + +// this macro can be used multiple times and just allows you to use wxGetApp() +// function #define DECLARE_APP(appname) extern appname& wxGetApp(); #endif