Trying to hide evidence of my negative programming skills...

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

diff --git a/include/wx/app.h b/include/wx/app.h
index 77e62a20a99815e75ce49701e0e13e63826929ca..cdd0e46cf58d3207b4dd74d437ab27efdf205ee5 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -21,7 +21,7 @@
 // typedefs
 // ----------------------------------------------------------------------------
 
 // typedefs
 // ----------------------------------------------------------------------------
 

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

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


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

+// ----------------------------------------------------------------------------
+// headers we have to include here
+// ----------------------------------------------------------------------------
+
+#include "wx/event.h"       // for the base class
+
+#if wxUSE_GUI
+    #include "wx/window.h"      // for wxTopLevelWindows
+#endif // wxUSE_GUI
+
+#if wxUSE_LOG
+    #include "wx/log.h"
+#endif
+

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


@@ -45,29 +59,44 @@ static const int wxPRINT_POSTSCRIPT = 2;
 class WXDLLEXPORT wxAppBase : public wxEvtHandler
 {
 public:
 class WXDLLEXPORT wxAppBase : public wxEvtHandler
 {
 public:

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

-
+#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.
         //
         // 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.
+        // Override: always in GUI application, rarely in console ones.
+#if wxUSE_GUI

     virtual bool OnInit() { return FALSE; };
     virtual bool OnInit() { return FALSE; };

+#else // !GUI
+    virtual bool OnInit() { return TRUE; };
+#endif // wxUSE_GUI

 
 

+#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.
         // 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
         // the main GUI loop in which events are received and processed until
         // the last window is not deleted (if GetExitOnFrameDelete) or
 
         // called to start program execution - the default version just enters
         // the main GUI loop in which events are received and processed until
         // the last window is not deleted (if GetExitOnFrameDelete) or

-        // ExitMainLoop() is called.
+        // ExitMainLoop() is called. In console mode programs, the execution
+        // of the program really starts here

         //
         //

-        // Override: rarely.
+        // Override: rarely in GUI applications, always in console ones.
+#if wxUSE_GUI

     virtual int OnRun() { return MainLoop(); };
     virtual int OnRun() { return MainLoop(); };

+#else // !GUI
+    virtual int OnRun() = 0;
+#endif // wxUSE_GUI

 
         // called after the main loop termination. This is a good place for
         // cleaning up (it may be too late in dtor) and is also useful if you
 
         // called after the main loop termination. This is a good place for
         // cleaning up (it may be too late in dtor) and is also useful if you


@@ -75,7 +104,7 @@ public:
         // value of this method.
         //
         // Override: often.
         // value of this method.
         //
         // Override: often.

-    virtual int OnExit() { return 0; }
+    virtual int OnExit();

 
         // called when a fatal exception occurs, this function should take care
         // not to do anything which might provoke a nested exception! It may be
 
         // called when a fatal exception occurs, this function should take care
         // not to do anything which might provoke a nested exception! It may be


@@ -90,6 +119,7 @@ public:
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 

+#if wxUSE_GUI

         // execute the main GUI loop, the function returns when the loop ends
     virtual int MainLoop() = 0;
 
         // execute the main GUI loop, the function returns when the loop ends
     virtual int MainLoop() = 0;
 


@@ -106,6 +136,7 @@ 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;

+#endif // wxUSE_GUI

 
     // application info: name, description, vendor
     // -------------------------------------------
 
     // application info: name, description, vendor
     // -------------------------------------------


@@ -132,16 +163,20 @@ public:
     const wxString& GetVendorName() const { return m_vendorName; }
     void SetVendorName(const wxString& name) { m_vendorName = name; }
 
     const wxString& GetVendorName() const { return m_vendorName; }
     void SetVendorName(const wxString& name) { m_vendorName = name; }
 

+#if wxUSE_GUI

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


@@ -159,6 +194,8 @@ public:
     void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
     bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
 
     void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
     bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
 

+#endif // wxUSE_GUI
+

     // miscellaneous customization functions
     // -------------------------------------
 
     // miscellaneous customization functions
     // -------------------------------------
 


@@ -167,10 +204,15 @@ public:
         // user-defined class (default implementation creates a wxLogGui
         // object) - this log object is used by default by all wxLogXXX()
         // functions.
         // user-defined class (default implementation creates a wxLogGui
         // object) - this log object is used by default by all wxLogXXX()
         // functions.

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

 #endif // wxUSE_LOG
 
 #endif // wxUSE_LOG
 

-
+#if wxUSE_GUI

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


@@ -180,6 +222,10 @@ public:
     void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
     bool GetWantDebugOutput() const { return m_wantDebugOutput; }
 
     void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
     bool GetWantDebugOutput() const { return m_wantDebugOutput; }
 

+        // set use of best visual flag (see below)
+    void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }
+    bool GetUseBestVisual() const { return m_useBestVisual; }
+

         // set/get printing mode: see wxPRINT_XXX constants.
         //
         // default behaviour is the normal one for Unix: always use PostScript
         // set/get printing mode: see wxPRINT_XXX constants.
         //
         // default behaviour is the normal one for Unix: always use PostScript


@@ -187,6 +233,12 @@ public:
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 
     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
+

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 


@@ -196,11 +248,13 @@ public:
     static wxAppInitializerFunction GetInitializerFunction()
         { return m_appInitFn; }
 
     static wxAppInitializerFunction GetInitializerFunction()
         { return m_appInitFn; }
 

+    // process all events in the wxPendingEvents list
+    virtual void ProcessPendingEvents();
+

     // access to the command line arguments
     // access to the command line arguments

-    int     argc;
-    char  **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;


@@ -210,33 +264,129 @@ protected:
              m_appName,         // app name
              m_className;       // class name
 
              m_appName,         // app name
              m_className;       // class name
 

-    // 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 application wants to get debug output
     bool m_wantDebugOutput;
 

+#if wxUSE_GUI

     // the main top level window - may be NULL
     wxWindow *m_topWindow;
     // 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;
+
+    // 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;
+
+    // does any of our windows has focus?
+    bool m_isActive;
+#endif // wxUSE_GUI

 };
 
 // ----------------------------------------------------------------------------
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 

-#if defined(__WXMSW__)
-    #include "wx/msw/app.h"
-#elif defined(__WXMOTIF__)
-    #include "wx/motif/app.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/app.h"
-#elif defined(__WXGTK__)
-    #include "wx/gtk/app.h"
-#elif defined(__WXMAC__)
-    #include "wx/mac/app.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/app.h"
-#endif
+#if wxUSE_GUI
+    #if 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(__WXQT__)
+        #include "wx/qt/app.h"
+    #elif defined(__WXGTK__)
+        #include "wx/gtk/app.h"
+    #elif defined(__WXMAC__)
+        #include "wx/mac/app.h"
+    #elif defined(__WXPM__)
+        #include "wx/os2/app.h"
+    #elif defined(__WXSTUBS__)
+        #include "wx/stubs/app.h"
+    #endif
+#else // !GUI
+    // can't use typedef because wxApp forward declared as a class
+    class WXDLLEXPORT wxApp : public wxAppBase
+    {
+    };
+#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;
+
+// ----------------------------------------------------------------------------
+// global functions
+// ----------------------------------------------------------------------------
+
+// event loop related functions only work in GUI programs
+// ------------------------------------------------------
+
+// Force an exit from main loop
+extern void WXDLLEXPORT wxExit();
+
+// Yield to other apps/messages
+extern bool WXDLLEXPORT wxYield();
+
+// Yield to other apps/messages
+extern void WXDLLEXPORT wxWakeUpIdle();
+
+// Post a message to the given eventhandler which will be processed during the
+// next event loop iteration
+inline void wxPostEvent(wxEvtHandler *dest, wxEvent& event)
+{
+    wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
+
+#if wxUSE_GUI
+    dest->AddPendingEvent(event);
+#else
+    dest->ProcessEvent(event);
+#endif // wxUSE_GUI
+}
+
+// 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

 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object
 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object


@@ -257,41 +407,52 @@ 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 defined(__AIX__) || defined(__HPUX__)
+#if !wxUSE_GUI || defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXPM__)

     #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)
 #elif defined(__WXMSW__) && defined(WXUSINGDLL)
     // NT defines APIENTRY, 3.x not
     #if !defined(WXAPIENTRY)

-        #ifdef __WATCOMC__
-            #define WXAPIENTRY PASCAL
-        #else
-            #define WXAPIENTRY FAR PASCAL
-        #endif
+        #define WXAPIENTRY WXFAR wxSTDCALL

     #endif
 
     #endif
 

+    #include <windows.h>
+    #include "wx/msw/winundef.h"
+

     #define IMPLEMENT_WXWIN_MAIN \
     #define IMPLEMENT_WXWIN_MAIN \

-        int WXAPIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,\
-                               LPSTR m_lpCmdLine, int nCmdShow )\
+        extern "C" int WXAPIENTRY WinMain(HINSTANCE hInstance,\
+                                          HINSTANCE hPrevInstance,\
+                                          LPSTR m_lpCmdLine, int nCmdShow)\

         {\
         {\

-            return wxEntry((WXHINSTANCE) hInstance, \
+            return wxEntry((WXHINSTANCE) hInstance,\

                            (WXHINSTANCE) hPrevInstance,\
                            m_lpCmdLine, nCmdShow);\
         }
                            (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; }      \
+// 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
 
     wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
     appname& wxGetApp() { return *(appname *)wxTheApp; } \
     IMPLEMENT_WXWIN_MAIN
 

+// 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; }         \
+    wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
+    appname& wxGetApp() { return *(appname *)wxTheApp; }
+

 #define DECLARE_APP(appname) extern appname& wxGetApp();
 
 #endif
 #define DECLARE_APP(appname) extern appname& wxGetApp();
 
 #endif