fix memory leak of FrameSite (see #3935)

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

diff --git a/include/wx/msw/app.h b/include/wx/msw/app.h
index 0b79229f8b55cf256e54512a2c525df2851af238..62c6668f1aa408bb11967638407e11b2bb8b79f4 100644 (file)
--- a/include/wx/msw/app.h
+++ b/include/wx/msw/app.h
@@ -12,158 +12,192 @@
 #ifndef _WX_APP_H_
 #define _WX_APP_H_
 
 #ifndef _WX_APP_H_
 #define _WX_APP_H_
 

-#ifdef __GNUG__
-#pragma interface "app.h"
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"

 #include "wx/event.h"
 #include "wx/event.h"

+#include "wx/icon.h"

 
 

-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxApp ;
-class WXDLLEXPORT wxKeyEvent;
-class WXDLLEXPORT wxLog;
-
-static const int wxPRINT_WINDOWS = 1;
-static const int wxPRINT_POSTSCRIPT = 2;
-
-WXDLLEXPORT_DATA(extern wxApp*) wxTheApp;
-
-// Force an exit from main loop
-void WXDLLEXPORT wxExit();
-
-// Yield to other apps/messages
-bool WXDLLEXPORT wxYield();
+class WXDLLIMPEXP_FWD_CORE wxFrame;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxApp;
+class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
+class WXDLLIMPEXP_FWD_BASE wxLog;

 
 // Represents the application. Derive OnInit and declare
 // a new App object to start application
 
 // Represents the application. Derive OnInit and declare
 // a new App object to start application

-class WXDLLEXPORT wxApp: public wxEvtHandler
+class WXDLLIMPEXP_CORE wxApp : public wxAppBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxApp)
-  wxApp();
-  ~wxApp();
-
-  static void SetInitializerFunction(wxAppInitializerFunction fn) { m_appInitFn = fn; }
-  static wxAppInitializerFunction GetInitializerFunction() { return m_appInitFn; }
-
-  virtual int MainLoop();
-  void ExitMainLoop();
-  bool Initialized();
-  virtual bool Pending() ;
-  virtual void Dispatch() ;
-
-  void OnIdle(wxIdleEvent& event);
-  void OnEndSession(wxCloseEvent& event);
-  void OnQueryEndSession(wxCloseEvent& event);
-
-  // Generic
-  virtual bool OnInit() { return FALSE; };
-
-  // No specific tasks to do here.
-  virtual bool OnInitGui() { return TRUE; }
-
-  // Called to set off the main loop
-  virtual int OnRun() { return MainLoop(); };
-  virtual int OnExit() { return 0; }
-
-  // called when a fatal exception occurs, this function should take care not
-  // to do anything which might provoke a nested exception!
-  virtual void OnFatalException() { }
-
-  void SetPrintMode(int mode) { m_printMode = mode; }
-  int GetPrintMode() const { return m_printMode; }
+public:
+    wxApp();
+    virtual ~wxApp();
+
+    // override base class (pure) virtuals
+    virtual bool Initialize(int& argc, wxChar **argv);
+    virtual void CleanUp();
+
+    virtual bool Yield(bool onlyIfNeeded = false);
+    virtual void WakeUpIdle();
+
+    virtual void SetPrintMode(int mode) { m_printMode = mode; }
+    virtual int GetPrintMode() const { return m_printMode; }
+
+    // implementation only
+    void OnIdle(wxIdleEvent& event);
+    void OnEndSession(wxCloseEvent& event);
+    void OnQueryEndSession(wxCloseEvent& event);
+
+#if wxUSE_EXCEPTIONS
+    virtual bool OnExceptionInMainLoop();
+#endif // wxUSE_EXCEPTIONS
+
+    // MSW-specific from now on
+    // ------------------------
+
+    // this suffix should be appended to all our Win32 class names to obtain a
+    // variant registered without CS_[HV]REDRAW styles
+    static const wxChar *GetNoRedrawClassSuffix() { return _T("NR"); }
+
+    // get the name of the registered Win32 class with the given (unique) base
+    // name: this function constructs the unique class name using this name as
+    // prefix, checks if the class is already registered and registers it if it
+    // isn't and returns the name it was registered under (or NULL if it failed)
+    //
+    // the registered class will always have CS_[HV]REDRAW and CS_DBLCLKS
+    // styles as well as any additional styles specified as arguments here; and
+    // there will be also a companion registered class identical to this one
+    // but without CS_[HV]REDRAW whose name will be the same one but with
+    // GetNoRedrawClassSuffix()
+    //
+    // the background brush argument must be either a COLOR_XXX standard value
+    // or (default) -1 meaning that the class paints its background itself
+    static const wxChar *GetRegisteredClassName(const wxChar *name,
+                                                int bgBrushCol = -1,
+                                                int extraStyles = 0);
+
+    // return true if this name corresponds to one of the classes we registered
+    // in the previous GetRegisteredClassName() calls
+    static bool IsRegisteredClassName(const wxString& name);

 
 

-  void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
-  bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
+protected:
+    int    m_printMode; // wxPRINT_WINDOWS, wxPRINT_POSTSCRIPT

 
 

-  const wxString& GetAppName() const {
-      if (m_appName != _T(""))
-        return m_appName;
-      else return m_className;
-    }
+public:
+    // unregister any window classes registered by GetRegisteredClassName()
+    static void UnregisterWindowClasses();

 
 

-  void SetAppName(const wxString& name) { m_appName = name; };
-  wxString GetClassName() const { return m_className; }
-  void SetClassName(const wxString& name) { m_className = name; }
+#if wxUSE_RICHEDIT
+    // initialize the richedit DLL of (at least) given version, return true if
+    // ok (Win95 has version 1, Win98/NT4 has 1 and 2, W2K has 3)
+    static bool InitRichEdit(int version = 2);
+#endif // wxUSE_RICHEDIT

 
 

-  void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
-  const wxString& GetVendorName() const { return m_vendorName; }
+    // returns 400, 470, 471 for comctl32.dll 4.00, 4.70, 4.71 or 0 if it
+    // wasn't found at all
+    static int GetComCtl32Version();

 
 

-  wxWindow *GetTopWindow() const ;
-  void SetTopWindow(wxWindow *win) { m_topWindow = win; }
+    // the same for shell32.dll: returns 400, 471, 500, 600, ... (4.70 not
+    // currently detected)
+    static int GetShell32Version();

 
 

-  void SetWantDebugOutput(bool flag) { m_wantDebugOutput = flag; }
-  bool GetWantDebugOutput() { return m_wantDebugOutput; }
+    // the SW_XXX value to be used for the frames opened by the application
+    // (currently seems unused which is a bug -- TODO)
+    static int m_nCmdShow;

 
 

-  // Send idle event to all top-level windows.
-  // Returns TRUE if more idle time is requested.
-  bool SendIdleEvents();
+protected:
+    DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxApp)
+    DECLARE_DYNAMIC_CLASS(wxApp)
+};

 
 

-  // Send idle event to window and all subwindows
-  // Returns TRUE if more idle time is requested.
-  bool SendIdleEvents(wxWindow* win);
+#ifdef __WXWINCE__

 
 

-  void SetAuto3D(bool flag) { m_auto3D = flag; }
-  bool GetAuto3D() const { return m_auto3D; }
+// under CE provide a dummy implementation of GetComCtl32Version() returning
+// the value passing all ">= 470" tests (which are the only ones used in our
+// code currently) as commctrl.dll under CE 2.0 and later support comctl32.dll
+// functionality
+inline int wxApp::GetComCtl32Version()
+{
+    return 471;
+}

 
 

-  // Creates a log object
-  virtual wxLog* CreateLogTarget();
+// this is not currently used at all under CE so it's not really clear what do
+// we need to return from here
+inline int wxApp::GetShell32Version()
+{
+    return 0;
+}

 
 

-public:
-  int               argc;
-  wxChar **         argv;
+#endif // __WXWINCE__

 
 

-protected:
-  bool              m_wantDebugOutput ;
-  wxString          m_className;
-  wxString          m_appName,
-                    m_vendorName;
-  wxWindow *        m_topWindow;
-  bool              m_exitOnFrameDelete;
-  bool              m_showOnInit;
-  int               m_printMode; // wxPRINT_WINDOWS, wxPRINT_POSTSCRIPT
-  bool              m_auto3D ;   // Always use 3D controls, except
-                                 // where overriden
-  static wxAppInitializerFunction m_appInitFn;
-
-/* Windows-specific wxApp definitions */
+// ----------------------------------------------------------------------------
+// MSW-specific wxEntry() overload and IMPLEMENT_WXWIN_MAIN definition
+// ----------------------------------------------------------------------------

 
 

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

 
 

-  // Implementation
-  static bool Initialize();
-  static void CleanUp();
-
-  static bool RegisterWindowClasses();
-  // Convert Windows to argc, argv style
-  void ConvertToStandardCommandArgs(char* p);
-  virtual bool DoMessage();
-  virtual bool ProcessMessage(WXMSG* pMsg);
-  void DeletePendingObjects();
-  bool ProcessIdle();
-#if wxUSE_THREADS
-  void ProcessPendingEvents();
+#ifndef SW_SHOWNORMAL
+    #define SW_SHOWNORMAL 1

 #endif
 #endif

-  int GetComCtl32Version() const;

 
 

-public:
-  int               m_nCmdShow;
-
-protected:
-  bool              m_keepGoing ;
-
-DECLARE_EVENT_TABLE()
-};
-
-#if !defined(_WINDLL) || (defined(_WINDLL) && defined(WXMAKINGDLL))
-int WXDLLEXPORT wxEntry(WXHINSTANCE hInstance, WXHINSTANCE hPrevInstance, char *lpszCmdLine,
-                    int nCmdShow, bool enterLoop = TRUE);
+// WinMain() is always ANSI, even in Unicode build, under normal Windows
+// but is always Unicode under CE
+#ifdef __WXWINCE__
+    typedef wchar_t *wxCmdLineArgType;

 #else
 #else

-int WXDLLEXPORT wxEntry(WXHINSTANCE hInstance);
+    typedef char *wxCmdLineArgType;

 #endif
 
 #endif
 

-#endif
-    // _WX_APP_H_
+// wxMSW-only overloads of wxEntry() and wxEntryStart() which take the
+// parameters passed to WinMain() instead of those passed to main()
+extern WXDLLIMPEXP_CORE bool
+    wxEntryStart(HINSTANCE hInstance,
+                HINSTANCE hPrevInstance = NULL,
+                wxCmdLineArgType pCmdLine = NULL,
+                int nCmdShow = SW_SHOWNORMAL);
+
+extern WXDLLIMPEXP_CORE int
+    wxEntry(HINSTANCE hInstance,
+            HINSTANCE hPrevInstance = NULL,
+            wxCmdLineArgType pCmdLine = NULL,
+            int nCmdShow = SW_SHOWNORMAL);
+
+#if defined(__BORLANDC__) && wxUSE_UNICODE
+    // Borland C++ has the following nonstandard behaviour: when the -WU
+    // command line flag is used, the linker expects to find wWinMain instead
+    // of WinMain. This flag causes the compiler to define _UNICODE and
+    // UNICODE symbols and there's no way to detect its use, so we have to
+    // define both WinMain and wWinMain so that IMPLEMENT_WXWIN_MAIN works
+    // for both code compiled with and without -WU.
+    // See http://sourceforge.net/tracker/?func=detail&atid=309863&aid=1935997&group_id=9863
+    // for more details.
+    #define IMPLEMENT_WXWIN_MAIN_BORLAND_NONSTANDARD                        \
+        extern "C" int WINAPI wWinMain(HINSTANCE hInstance,                 \
+                                      HINSTANCE hPrevInstance,              \
+                                      wchar_t * WXUNUSED(lpCmdLine),        \
+                                      int nCmdShow)                         \
+        {                                                                   \
+            /* NB: wxEntry expects lpCmdLine argument to be char*, not */   \
+            /*     wchar_t*, but fortunately it's not used anywhere    */   \
+            /*     and we can simply pass NULL in:                     */   \
+            return wxEntry(hInstance, hPrevInstance, NULL, nCmdShow);       \
+        }
+#else
+    #define IMPLEMENT_WXWIN_MAIN_BORLAND_NONSTANDARD
+#endif // defined(__BORLANDC__) && wxUSE_UNICODE
+
+#define IMPLEMENT_WXWIN_MAIN \
+    extern "C" int WINAPI WinMain(HINSTANCE hInstance,                      \
+                                  HINSTANCE hPrevInstance,                  \
+                                  wxCmdLineArgType WXUNUSED(lpCmdLine),     \
+                                  int nCmdShow)                             \
+    {                                                                       \
+        /* NB: We pass NULL in place of lpCmdLine to behave the same as  */ \
+        /*     Borland-specific wWinMain() above. If it becomes needed   */ \
+        /*     to pass lpCmdLine to wxEntry() here, you'll have to fix   */ \
+        /*     wWinMain() above too.                                     */ \
+        return wxEntry(hInstance, hPrevInstance, NULL, nCmdShow);           \
+    }                                                                       \
+    IMPLEMENT_WXWIN_MAIN_BORLAND_NONSTANDARD
+
+
+#endif // _WX_APP_H_