Made OnInit() and OnRun() logic like MSW when it

[wxWidgets.git] / include / wx / app.h

diff --git a/include/wx/app.h b/include/wx/app.h
index cb327df858f62151cb28d2c11b1b3bdad462692e..226be5346fe3ef330bec37e4be7d84914a4fdc3c 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -21,7 +21,7 @@
 // typedefs
 // ----------------------------------------------------------------------------
 
 // typedefs
 // ----------------------------------------------------------------------------
 

-#if defined(__WXMSW__) || defined (__WXPM__)
+#if (defined(__WXMSW__) && !defined(__WXMICROWIN__)) || defined (__WXPM__)

     class WXDLLEXPORT wxApp;
     typedef wxApp* (*wxAppInitializerFunction)();
 #else
     class WXDLLEXPORT wxApp;
     typedef wxApp* (*wxAppInitializerFunction)();
 #else


@@ -31,6 +31,8 @@
     typedef wxObject* (*wxAppInitializerFunction)();
 #endif
 
     typedef wxObject* (*wxAppInitializerFunction)();
 #endif
 

+class WXDLLEXPORT wxCmdLineParser;
+

 // ----------------------------------------------------------------------------
 // headers we have to include here
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers we have to include here
 // ----------------------------------------------------------------------------


@@ -38,13 +40,17 @@
 #include "wx/event.h"       // for the base class
 
 #if wxUSE_GUI
 #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
 
 #endif // wxUSE_GUI
 
 #if wxUSE_LOG
     #include "wx/log.h"
 #endif
 

+#if WXWIN_COMPATIBILITY_2_2
+    #include "wx/icon.h"
+#endif
+

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -52,6 +58,32 @@
 static const int wxPRINT_WINDOWS = 1;
 static const int wxPRINT_POSTSCRIPT = 2;
 
 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // the common part of wxApp implementations for all platforms
 // ----------------------------------------------------------------------------


@@ -59,6 +91,9 @@ static const int wxPRINT_POSTSCRIPT = 2;
 class WXDLLEXPORT wxAppBase : public wxEvtHandler
 {
 public:
 class WXDLLEXPORT wxAppBase : public wxEvtHandler
 {
 public:

+    wxAppBase();
+    virtual ~wxAppBase();
+

     // the virtual functions which may/must be overridden in the derived class
     // -----------------------------------------------------------------------
 
     // the virtual functions which may/must be overridden in the derived class
     // -----------------------------------------------------------------------
 


@@ -67,18 +102,14 @@ public:
         // the top level program window and return TRUE.
         //
         // Override: always in GUI application, rarely in console ones.
         // 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();

 
 #if wxUSE_GUI
         // a platform-dependent version of OnInit(): the code here is likely to
         // depend on the toolkit. default version does nothing.
         //
         // Override: rarely.
 
 #if wxUSE_GUI
         // a platform-dependent version of OnInit(): the code here is likely to
         // depend on the toolkit. default version does nothing.
         //
         // Override: rarely.

-    virtual bool OnInitGui() { return TRUE; }
+    virtual bool OnInitGui();

 #endif // wxUSE_GUI
 
         // called to start program execution - the default version just enters
 #endif // wxUSE_GUI
 
         // called to start program execution - the default version just enters


@@ -132,6 +163,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 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
 #endif // wxUSE_GUI
 
     // application info: name, description, vendor


@@ -163,13 +205,16 @@ public:
     // top level window functions
     // --------------------------
 
     // top level window functions
     // --------------------------
 

+        // return TRUE if our app has focus
+    virtual bool IsActive() const { return m_isActive; }
+

         // set the "main" top level window
     void SetTopWindow(wxWindow *win) { m_topWindow = win; }
 
         // return the "main" top level window (if it hadn't been set previously
         // with SetTopWindow(), will return just some top level window and, if
         // there are none, will return NULL)
         // set the "main" top level window
     void SetTopWindow(wxWindow *win) { m_topWindow = win; }
 
         // return the "main" top level window (if it hadn't been set previously
         // with SetTopWindow(), will return just some top level window and, if
         // there are none, will return NULL)

-    wxWindow *GetTopWindow() const
+    virtual wxWindow *GetTopWindow() const

     {
         if (m_topWindow)
             return m_topWindow;
     {
         if (m_topWindow)
             return m_topWindow;


@@ -189,6 +234,34 @@ public:
 
 #endif // wxUSE_GUI
 
 
 #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
     // -------------------------------------
 
     // miscellaneous customization functions
     // -------------------------------------
 


@@ -198,22 +271,28 @@ public:
         // object) - this log object is used by default by all wxLogXXX()
         // functions.
     virtual wxLog *CreateLogTarget()
         // object) - this log object is used by default by all wxLogXXX()
         // functions.
     virtual wxLog *CreateLogTarget()

-#if wxUSE_GUI
-        { return new wxLogGui; }
-#else // !GUI
-        { return new wxLogStderr; }
-#endif // wxUSE_GUI
+        #if wxUSE_GUI && wxUSE_LOGGUI && !defined(__WXMICROWIN__)
+            { return new wxLogGui; }
+        #else // !GUI
+            { return new wxLogStderr; }
+        #endif // wxUSE_GUI

 #endif // wxUSE_LOG
 
 #if wxUSE_GUI
 #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
         // 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; }
 
         // set use of best visual flag (see below)
     void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }


@@ -225,8 +304,35 @@ public:
         // printing.
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
         // printing.
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }

+
+    // called by toolkit-specific code to set the app status: active (we have
+    // focus) or not and also the last window which had focus before we were
+    // deactivated
+    virtual void SetActive(bool isActive, wxWindow *lastFocus);

 #endif // wxUSE_GUI
 
 #endif // wxUSE_GUI
 

+    // 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)
+#ifdef __WXDEBUG__
+    virtual void OnAssert(const wxChar *file, int line, const wxChar *msg);
+#endif // __WXDEBUG__
+
+    // 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
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 


@@ -243,7 +349,6 @@ public:
     int      argc;
     wxChar **argv;
 
     int      argc;
     wxChar **argv;
 

-//private:

 protected:
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction m_appInitFn;
 protected:
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction m_appInitFn;


@@ -253,19 +358,19 @@ protected:
              m_appName,         // app name
              m_className;       // class name
 
              m_appName,         // app name
              m_className;       // class name
 

+#if wxUSE_GUI
+    // the main top level window - may be NULL
+    wxWindow *m_topWindow;
+

     // if TRUE, exit the main loop when the last top level window is deleted
     bool m_exitOnFrameDelete;
 
     // if TRUE, exit the main loop when the last top level window is deleted
     bool m_exitOnFrameDelete;
 

-    // TRUE if the application wants to get debug output
-    bool m_wantDebugOutput;
-

     // 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;
 
     // 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;
 

-#if wxUSE_GUI
-    // the main top level window - may be NULL
-    wxWindow *m_topWindow;
+    // does any of our windows has focus?
+    bool m_isActive;

 #endif // wxUSE_GUI
 };
 
 #endif // wxUSE_GUI
 };
 


@@ -278,10 +383,12 @@ protected:
         #include "wx/msw/app.h"
     #elif defined(__WXMOTIF__)
         #include "wx/motif/app.h"
         #include "wx/msw/app.h"
     #elif defined(__WXMOTIF__)
         #include "wx/motif/app.h"

-    #elif defined(__WXQT__)
-        #include "wx/qt/app.h"
+    #elif defined(__WXMGL__)
+        #include "wx/mgl/app.h"

     #elif defined(__WXGTK__)
         #include "wx/gtk/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__)
     #elif defined(__WXMAC__)
         #include "wx/mac/app.h"
     #elif defined(__WXPM__)


@@ -324,7 +431,7 @@ extern void WXDLLEXPORT wxWakeUpIdle();
 
 // Post a message to the given eventhandler which will be processed during the
 // next event loop iteration
 
 // Post a message to the given eventhandler which will be processed during the
 // next event loop iteration

-inline void WXDLLEXPORT wxPostEvent(wxEvtHandler *dest, wxEvent& event)
+inline void wxPostEvent(wxEvtHandler *dest, wxEvent& event)

 {
     wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
 
 {
     wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
 


@@ -349,6 +456,27 @@ extern bool WXDLLEXPORT wxInitialize();
 // wxUninitialize()
 extern void WXDLLEXPORT wxUninitialize();
 
 // 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
 
 // ----------------------------------------------------------------------------
 #endif // !wxUSE_GUI
 
 // ----------------------------------------------------------------------------


@@ -370,56 +498,46 @@ public:
 // be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this
 // code if required.
 
 // 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); }
     #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
+    #define IMPLEMENT_WXWIN_MAIN \
+        extern int wxEntry( int argc, char *argv[], bool enterLoop = 1 ); \
+        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
 
 #elif defined(__WXMSW__) && defined(WXUSINGDLL)
     // NT defines APIENTRY, 3.x not
     #if !defined(WXAPIENTRY)
         #define WXAPIENTRY WXFAR wxSTDCALL
     #endif
 

-    // Patch from Mumit Khan to allow DLL compilation under mingw. Note that
-    // this includes <windows.h> which is a bad thing because it prevents
-    // wxWindows to work with MFC, so for now I'm making this change for
-    // mingw/cygwin only (these don't work with MFC yet). GRG Mar/2000
-    #ifdef(__GNUWIN32__)
-        #include <windows.h>
-        #include "wx/msw/winundef.h"
-
-        #define IMPLEMENT_WXWIN_MAIN \
-            extern "C" int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int);\
-            int WINAPI WinMain(HINSTANCE hInstance, \
-                               HINSTANCE hPrevInstance,\
-                               LPSTR m_lpCmdLine, int nCmdShow )\
-            {\
-                return wxEntry((WXHINSTANCE) hInstance, \
-                               (WXHINSTANCE) hPrevInstance,\
-                               m_lpCmdLine, nCmdShow);\
-            }
-    #else
-        #define IMPLEMENT_WXWIN_MAIN \
-            int WXAPIENTRY WinMain(HINSTANCE hInstance, \
-                                   HINSTANCE hPrevInstance,\
-                                   LPSTR m_lpCmdLine, int nCmdShow )\
-            {\
-                return wxEntry((WXHINSTANCE) hInstance, \
-                               (WXHINSTANCE) hPrevInstance,\
-                               m_lpCmdLine, nCmdShow);\
-            }
-    #endif
+    #include <windows.h>
+    #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
 
 #else
     #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.
 
 // Use this macro if you want to define your own main() or WinMain() function
 // and call wxEntry() from there.


@@ -428,6 +546,20 @@ public:
     wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
     appname& wxGetApp() { return *(appname *)wxTheApp; }
 
     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
 #define DECLARE_APP(appname) extern appname& wxGetApp();
 
 #endif