blind fix for watcom

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

diff --git a/include/wx/app.h b/include/wx/app.h
index 7d27f9a427192e9eb6e1563855d16e8986ceaa8d..3698f65a09e5219691a405ab488c27ef17a9deea 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -24,19 +24,20 @@
 #endif // wxUSE_GUI
 
 #include "wx/build.h"
 #endif // wxUSE_GUI
 
 #include "wx/build.h"

+#include "wx/init.h"        // we must declare wxEntry()

 
 

-class WXDLLEXPORT wxApp;
-class WXDLLEXPORT wxAppTraits;
-class WXDLLEXPORT wxCmdLineParser;
-class WXDLLEXPORT wxLog;
-class WXDLLEXPORT wxMessageOutput;
+class WXDLLIMPEXP_BASE wxAppConsole;
+class WXDLLIMPEXP_BASE wxAppTraits;
+class WXDLLIMPEXP_BASE wxCmdLineParser;
+class WXDLLIMPEXP_BASE wxLog;
+class WXDLLIMPEXP_BASE wxMessageOutput;

 
 // ----------------------------------------------------------------------------
 // typedefs
 // ----------------------------------------------------------------------------
 
 // the type of the function used to create a wxApp object on program start up
 
 // ----------------------------------------------------------------------------
 // typedefs
 // ----------------------------------------------------------------------------
 
 // the type of the function used to create a wxApp object on program start up

-typedef wxApp* (*wxAppInitializerFunction)();
+typedef wxAppConsole* (*wxAppInitializerFunction)();

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


@@ -56,7 +57,7 @@ enum
 // 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.
 // 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
+class WXDLLIMPEXP_CORE wxDisplayModeInfo

 {
 public:
     wxDisplayModeInfo() : m_ok(FALSE) {}
 {
 public:
     wxDisplayModeInfo() : m_ok(FALSE) {}


@@ -74,11 +75,12 @@ private:
 };
 #endif // wxUSE_GUI
 
 };
 #endif // wxUSE_GUI
 

+

 // ----------------------------------------------------------------------------
 // wxAppConsole: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxAppConsole: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxAppConsole : public wxEvtHandler
+class WXDLLIMPEXP_BASE wxAppConsole : public wxEvtHandler

 {
 public:
     // ctor and dtor
 {
 public:
     // ctor and dtor


@@ -96,6 +98,9 @@ public:
     // class version!
     virtual bool Initialize(int& argc, wxChar **argv);
 
     // class version!
     virtual bool Initialize(int& argc, wxChar **argv);
 

+    // This gives wxCocoa a chance to call OnInit() with a memory pool in place
+    virtual bool CallOnInit() { return OnInit(); }
+

     // Called before OnRun(), this is a good place to do initialization -- if
     // anything fails, return false from here to prevent the program from
     // continuing. The command line is normally parsed here, call the base
     // Called before OnRun(), this is a good place to do initialization -- if
     // anything fails, return false from here to prevent the program from
     // continuing. The command line is normally parsed here, call the base


@@ -165,11 +170,13 @@ public:
 
 #if wxUSE_CMDLINE_PARSER
     // this one is called from OnInit() to add all supported options
 
 #if wxUSE_CMDLINE_PARSER
     // this one is called from OnInit() to add all supported options

-    // to the given parser
+    // to the given parser (don't forget to call the base class version if you
+    // override it!)

     virtual void OnInitCmdLine(wxCmdLineParser& parser);
 
     // called after successfully parsing the command line, return TRUE
     virtual void OnInitCmdLine(wxCmdLineParser& parser);
 
     // called after successfully parsing the command line, return TRUE

-    // to continue and FALSE to exit
+    // 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
     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 
     // called if "--help" option was specified, return TRUE to continue


@@ -250,12 +257,12 @@ public:
                           const wxChar *cond,
                           const wxChar *msg);
 #endif // __WXDEBUG__
                           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
     // 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);
-
+    static bool CheckBuildOptions(const char *optionsSignature,
+                                  const char *componentName);

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


@@ -266,6 +273,13 @@ public:
     static wxAppInitializerFunction GetInitializerFunction()
         { return ms_appInitFn; }
 
     static wxAppInitializerFunction GetInitializerFunction()
         { return ms_appInitFn; }
 

+    // accessors for ms_appInstance field (external code might wish to modify
+    // it, this is why we provide a setter here as well, but you should really
+    // know what you're doing if you call it), wxTheApp is usually used instead
+    // of GetInstance()
+    static wxAppConsole *GetInstance() { return ms_appInstance; }
+    static void SetInstance(wxAppConsole *app) { ms_appInstance = app; }
+

 
     // command line arguments (public for backwards compatibility)
     int      argc;
 
     // command line arguments (public for backwards compatibility)
     int      argc;


@@ -280,6 +294,10 @@ protected:
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 

+    // the one and only global application object
+    static wxAppConsole *ms_appInstance;
+
+

     // application info (must be set from the user code)
     wxString m_vendorName,      // vendor name (ACME Inc)
              m_appName,         // app name
     // application info (must be set from the user code)
     wxString m_vendorName,      // vendor name (ACME Inc)
              m_appName,         // app name


@@ -301,7 +319,7 @@ protected:
 
 #if wxUSE_GUI
 
 
 #if wxUSE_GUI
 

-class WXDLLEXPORT wxAppBase : public wxAppConsole
+class WXDLLIMPEXP_CORE wxAppBase : public wxAppConsole

 {
 public:
     wxAppBase();
 {
 public:
     wxAppBase();


@@ -330,6 +348,9 @@ public:
         // Override: rarely in GUI applications, always in console ones.
     virtual int OnRun();
 
         // Override: rarely in GUI applications, always in console ones.
     virtual int OnRun();
 

+        // a matching function for OnInit()
+    virtual int OnExit();
+

         // very last clean up function
         //
         // Override: very rarely
         // very last clean up function
         //
         // Override: very rarely


@@ -375,7 +396,14 @@ public:
         // parties
         //
         // it should return TRUE if more idle events are needed, FALSE if not
         // parties
         //
         // it should return TRUE if more idle events are needed, FALSE if not

-    virtual bool ProcessIdle() = 0;
+    virtual bool ProcessIdle() ;
+
+        // Send idle event to window and all subwindows
+        // 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);

 
 
     // top level window functions
 
 
     // top level window functions


@@ -434,6 +462,13 @@ public:
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 
 
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 
 

+    // command line parsing (GUI-specific)
+    // ------------------------------------------------------------------------
+
+    virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
+    virtual void OnInitCmdLine(wxCmdLineParser& parser);
+
+

     // miscellaneous other stuff
     // ------------------------------------------------------------------------
 
     // miscellaneous other stuff
     // ------------------------------------------------------------------------
 


@@ -501,21 +536,24 @@ protected:
         #include "wx/os2/app.h"
     #endif
 #else // !GUI
         #include "wx/os2/app.h"
     #endif
 #else // !GUI

-    // can't use typedef because wxApp forward declared as a class
-    class WXDLLEXPORT wxApp : public wxAppConsole
-    {
-    };
+    // allow using just wxApp (instead of wxAppConsole) in console programs
+    typedef wxAppConsole wxApp;

 #endif // GUI/!GUI
 
 // ----------------------------------------------------------------------------
 // the global data
 // ----------------------------------------------------------------------------
 
 #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;
+// for compatibility, we define this macro to access the global application
+// object of type wxApp
+//
+// note that instead of using of wxTheApp in application code you should
+// 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)
+//
+// the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
+// console mode it does nothing at all
+#define wxTheApp ((wxApp *)wxApp::GetInstance())

 
 // ----------------------------------------------------------------------------
 // global functions
 
 // ----------------------------------------------------------------------------
 // global functions


@@ -525,13 +563,13 @@ WXDLLEXPORT_DATA(extern wxApp*) wxTheApp;
 // ------------------------------------------------------
 
 // Force an exit from main loop
 // ------------------------------------------------------
 
 // Force an exit from main loop

-extern void WXDLLEXPORT wxExit();
+extern void WXDLLIMPEXP_BASE wxExit();

 
 // Yield to other apps/messages
 
 // Yield to other apps/messages

-extern bool WXDLLEXPORT wxYield();
+extern bool WXDLLIMPEXP_BASE wxYield();

 
 // Yield to other apps/messages
 
 // Yield to other apps/messages

-extern void WXDLLEXPORT wxWakeUpIdle();
+extern void WXDLLIMPEXP_BASE wxWakeUpIdle();

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


@@ -541,7 +579,7 @@ extern void WXDLLEXPORT wxWakeUpIdle();
 // creator function. wxApp can then call this function to create a new app
 // object. Convoluted, but necessary.
 
 // creator function. wxApp can then call this function to create a new app
 // object. Convoluted, but necessary.
 

-class WXDLLEXPORT wxAppInitializer
+class WXDLLIMPEXP_BASE wxAppInitializer

 {
 public:
     wxAppInitializer(wxAppInitializerFunction fn)
 {
 public:
     wxAppInitializer(wxAppInitializerFunction fn)


@@ -554,18 +592,20 @@ public:
 
 #if !wxUSE_GUI || !defined(__WXMSW__)
     #define IMPLEMENT_WXWIN_MAIN                                              \
 
 #if !wxUSE_GUI || !defined(__WXMSW__)
     #define IMPLEMENT_WXWIN_MAIN                                              \

-        extern int wxEntry( int& argc, char **argv );                         \

         int main(int argc, char **argv) { return wxEntry(argc, argv); }
 #elif defined(__WXMSW__) && defined(WXUSINGDLL)
         int main(int argc, char **argv) { return wxEntry(argc, argv); }
 #elif defined(__WXMSW__) && defined(WXUSINGDLL)

+    // we need HINSTANCE declaration to define WinMain()
+    #include "wx/msw/wrapwin.h"
+

     #define IMPLEMENT_WXWIN_MAIN \
     #define IMPLEMENT_WXWIN_MAIN \

-        extern int wxEntry(WXHINSTANCE hInstance,                             \
-                           WXHINSTANCE hPrevInstance,                         \
-                           char *pCmdLine,                                    \
-                           int nCmdShow);                                     \
-        extern "C" int wxSTDCALL WinMain(WXHINSTANCE hInstance,               \
-                                         WXHINSTANCE hPrevInstance,           \
-                                         char *lpCmdLine,                     \
-                                         int nCmdShow)                        \
+        extern int wxEntry(HINSTANCE hInstance,                               \
+                           HINSTANCE hPrevInstance = NULL,                    \
+                           char *pCmdLine = NULL,                             \
+                           int nCmdShow = SW_NORMAL);                         \
+        extern "C" int WINAPI WinMain(HINSTANCE hInstance,                    \
+                                      HINSTANCE hPrevInstance,                \
+                                      char *lpCmdLine,                        \
+                                      int nCmdShow)                           \

         {                                                                     \
             return wxEntry(hInstance, hPrevInstance, lpCmdLine, nCmdShow);    \
         }
         {                                                                     \
             return wxEntry(hInstance, hPrevInstance, lpCmdLine, nCmdShow);    \
         }


@@ -586,9 +626,10 @@ public:
 // 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)                                      \
 // 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()                                                    \
+    wxAppConsole *wxCreateApp()                                             \

     {                                                                       \
     {                                                                       \

-        wxApp::CheckBuildOptions(wxBuildOptions());                         \
+        wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE,         \
+                                        "your program");                    \

         return new appname;                                                 \
     }                                                                       \
     wxAppInitializer                                                        \
         return new appname;                                                 \
     }                                                                       \
     wxAppInitializer                                                        \