API adaptions to MSW EnhMetafile

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

diff --git a/include/wx/app.h b/include/wx/app.h
index 7d27f9a427192e9eb6e1563855d16e8986ceaa8d..f172a41422c536684bf72a25c586736cf6b3ad3a 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -21,22 +21,35 @@
 
 #if wxUSE_GUI
     #include "wx/window.h"  // for wxTopLevelWindows
 
 #if wxUSE_GUI
     #include "wx/window.h"  // for wxTopLevelWindows

+
+    #include "wx/vidmode.h"

 #endif // wxUSE_GUI
 
 #include "wx/build.h"
 #endif // wxUSE_GUI
 
 #include "wx/build.h"

-
-class WXDLLEXPORT wxApp;
-class WXDLLEXPORT wxAppTraits;
-class WXDLLEXPORT wxCmdLineParser;
-class WXDLLEXPORT wxLog;
-class WXDLLEXPORT wxMessageOutput;
+#include "wx/init.h"        // we must declare wxEntry()
+
+class WXDLLIMPEXP_BASE wxAppConsole;
+class WXDLLIMPEXP_BASE wxAppTraits;
+class WXDLLIMPEXP_BASE wxCmdLineParser;
+class WXDLLIMPEXP_BASE wxLog;
+class WXDLLIMPEXP_BASE wxMessageOutput;
+
+// wxUSE_EVTLOOP_IN_APP is a temporary hack needed until all ports are updated
+// to use wxEventLoop, otherwise we get linking errors on wxMac, it's going to
+// disappear a.s.a.p.
+#ifdef __WXMAC__
+    #define wxUSE_EVTLOOP_IN_APP 0
+#else
+    #define wxUSE_EVTLOOP_IN_APP 1
+    class WXDLLEXPORT wxEventLoop;
+#endif

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


@@ -48,37 +61,11 @@ enum
     wxPRINT_POSTSCRIPT = 2
 };
 
     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 // 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 +83,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


@@ -126,6 +116,14 @@ public:
     // crash.
     virtual void OnFatalException() { }
 
     // crash.
     virtual void OnFatalException() { }
 

+#if wxUSE_EXCEPTIONS
+    // 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
+    // exception you should override OnRun() and put a try/catch around
+    // MainLoop() call there
+    virtual void OnUnhandledException() { }
+#endif // wxUSE_EXCEPTIONS
+

     // Called from wxExit() function, should terminate the application a.s.a.p.
     virtual void Exit();
 
     // Called from wxExit() function, should terminate the application a.s.a.p.
     virtual void Exit();
 


@@ -165,11 +163,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


@@ -222,6 +222,17 @@ public:
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 

+#if wxUSE_EXCEPTIONS
+    // call the specified handler on the given object with the given event
+    //
+    // this method only exists to allow catching the exceptions thrown by any
+    // event handler, it would lead to an extra (useless) virtual function call
+    // if the exceptions were not used, so it doesn't even exist in that case
+    virtual void HandleEvent(wxEvtHandler *handler,
+                             wxEventFunction func,
+                             wxEvent& event) const;
+#endif // wxUSE_EXCEPTIONS
+

     // process all events in the wxPendingEvents list -- it is necessary to
     // call this function to process posted events. This happens during each
     // event loop iteration in GUI mode but if there is no main loop, it may be
     // process all events in the wxPendingEvents list -- it is necessary to
     // call this function to process posted events. This happens during each
     // event loop iteration in GUI mode but if there is no main loop, it may be


@@ -254,8 +265,14 @@ public:
     // 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);
+#if WXWIN_COMPATIBILITY_2_4
+    static bool CheckBuildOptions(const wxBuildOptions& buildOptions)
+    {
+        return CheckBuildOptions(buildOptions.m_signature, "your program");
+    }
+#endif

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


@@ -266,6 +283,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 +304,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 +329,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 +358,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


@@ -340,24 +371,23 @@ public:
     // -----------------------------------------------------------------
 
         // execute the main GUI loop, the function returns when the loop ends
     // -----------------------------------------------------------------
 
         // execute the main GUI loop, the function returns when the loop ends

-    virtual int MainLoop() = 0;
+    virtual int MainLoop();

 
         // exit the main loop thus terminating the application
     virtual void Exit();
 
         // exit the main GUI loop during the next iteration (i.e. it does not
         // stop the program immediately!)
 
         // exit the main loop thus terminating the application
     virtual void Exit();
 
         // exit the main GUI loop during the next iteration (i.e. it does not
         // stop the program immediately!)

-    virtual void ExitMainLoop() = 0;
-
-        // returns TRUE if the program is initialized
-    virtual bool Initialized() = 0;
+    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() = 0;
+    virtual bool Pending();

 
         // process the first event in the event queue (blocks until an event
 
         // process the first event in the event queue (blocks until an event

-        // apperas if there are none currently)
-    virtual void Dispatch() = 0;
+        // appears if there are none currently, use Pending() if this is not
+        // wanted), returns false if the event loop should stop and true
+        // otherwise
+    virtual bool Dispatch();

 
         // process all currently pending events right now
         //
 
         // process all currently pending events right now
         //


@@ -375,7 +405,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


@@ -416,11 +453,11 @@ public:
 
         // Get display mode that is used use. This is only used in framebuffer
         // wxWin ports (such as wxMGL).
 
         // Get display mode that is used use. This is only used in framebuffer
         // wxWin ports (such as wxMGL).

-    virtual wxDisplayModeInfo GetDisplayMode() const { return wxDisplayModeInfo(); }
+    virtual wxVideoMode GetDisplayMode() const { return wxVideoMode(); }

         // Set display mode to use. This is only used in framebuffer wxWin
         // ports (such as wxMGL). This method should be called from
         // wxApp::OnInitGui
         // 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; }
+    virtual bool SetDisplayMode(const wxVideoMode& 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; }


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

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

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


@@ -442,6 +487,11 @@ public:
     // deactivated
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 
     // deactivated
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 

+    // OBSOLETE: don't use, always returns true
+    //
+    // returns true if the program is successfully initialized
+    bool Initialized() { return true; }
+

 
 protected:
     // delete all objects in wxPendingDelete list
 
 protected:
     // delete all objects in wxPendingDelete list


@@ -451,6 +501,12 @@ protected:
     virtual wxAppTraits *CreateTraits();
 
 
     virtual wxAppTraits *CreateTraits();
 
 

+#if wxUSE_EVTLOOP_IN_APP
+    // the main event loop of the application (may be NULL if the loop hasn't
+    // been started yet or has already terminated)
+    wxEventLoop *m_mainLoop;
+#endif // wxUSE_EVTLOOP_IN_APP
+

     // the main top level window (may be NULL)
     wxWindow *m_topWindow;
 
     // the main top level window (may be NULL)
     wxWindow *m_topWindow;
 


@@ -501,21 +557,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 +584,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 +600,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)


@@ -552,20 +611,31 @@ 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.
 

+#define IMPLEMENT_WXWIN_MAIN_CONSOLE \
+        int main(int argc, char **argv) { return wxEntry(argc, argv); }
+

 #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)
+        IMPLEMENT_WXWIN_MAIN_CONSOLE
+#elif defined(__WXMSW__)
+    // we need HINSTANCE declaration to define WinMain()
+    #include "wx/msw/wrapwin.h"
+
+    #ifdef SW_SHOWNORMAL
+    #define wxSW_SHOWNORMAL SW_SHOWNORMAL
+    #else
+    #define wxSW_SHOWNORMAL 0
+    #endif
+

     #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 = wxSW_SHOWNORMAL);                         \
+        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 +656,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                                                        \


@@ -607,6 +678,11 @@ public:
     IMPLEMENT_APP_NO_THEMES(appname)        \
     IMPLEMENT_WX_THEME_SUPPORT
 
     IMPLEMENT_APP_NO_THEMES(appname)        \
     IMPLEMENT_WX_THEME_SUPPORT
 

+// Same as IMPLEMENT_APP(), but for console applications.
+#define IMPLEMENT_APP_CONSOLE(appname)      \
+    IMPLEMENT_APP_NO_MAIN(appname)          \
+    IMPLEMENT_WXWIN_MAIN_CONSOLE
+

 // this macro can be used multiple times and just allows you to use wxGetApp()
 // function
 #define DECLARE_APP(appname) extern appname& wxGetApp();
 // this macro can be used multiple times and just allows you to use wxGetApp()
 // function
 #define DECLARE_APP(appname) extern appname& wxGetApp();