Rebake from clean wx tree.

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

diff --git a/include/wx/msw/app.h b/include/wx/msw/app.h
index 54b58a4ee9cd90b5f85802e07fea6ae3c9d2c172..73e01be93888dc1114d150887eee8d5cf0307bfd 100644 (file)
--- a/include/wx/msw/app.h
+++ b/include/wx/msw/app.h
@@ -5,162 +5,202 @@
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __APPH__
-#define __APPH__
+#ifndef _WX_APP_H_
+#define _WX_APP_H_

 
 

-#ifdef __GNUG__
-#pragma interface "app.h"
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-
-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxApp ;
-class WXDLLEXPORT wxKeyEvent;
-class WXDLLEXPORT wxLog;
-
-#define wxPRINT_WINDOWS         1
-#define wxPRINT_POSTSCRIPT      2
-
-WXDLLEXPORT_DATA(extern wxApp*) wxTheApp;
+#include "wx/event.h"
+#include "wx/icon.h"

 
 

-void WXDLLEXPORT wxCleanUp();
-void WXDLLEXPORT wxCommonCleanUp(); // Call this from the platform's wxCleanUp()
-void WXDLLEXPORT wxCommonInit();    // Call this from the platform's initialization
-
-// 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();
-  inline ~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() ;
-
-  virtual void OnIdle(wxIdleEvent& 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; }
-
-  inline void SetPrintMode(int mode) { m_printMode = mode; }
-  inline int GetPrintMode() const { return m_printMode; }
-
-  inline void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
-  inline bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
-
-  inline wxString GetAppName() const {
-      if (m_appName != "")
-        return m_appName;
-      else return m_className;
-    }
-
-  inline void SetAppName(const wxString& name) { m_appName = name; };
-  inline wxString GetClassName() const { return m_className; }
-  inline void SetClassName(const wxString& name) { m_className = name; }
+public:
+    wxApp();
+    virtual ~wxApp();
+
+    // override base class (pure) virtuals
+    virtual bool Initialize(int& argc, wxChar **argv);
+    virtual void CleanUp();
+
+    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 wxT("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 SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
-  const wxString& GetVendorName() const { return m_vendorName; }
+protected:
+    int    m_printMode; // wxPRINT_WINDOWS, wxPRINT_POSTSCRIPT

 
 

-  wxWindow *GetTopWindow() const ;
-  inline void SetTopWindow(wxWindow *win) { m_topWindow = win; }
+public:
+    // unregister any window classes registered by GetRegisteredClassName()
+    static void UnregisterWindowClasses();

 
 

-  inline void SetWantDebugOutput(bool flag) { m_wantDebugOutput = flag; }
-  inline bool GetWantDebugOutput() { return m_wantDebugOutput; }
+#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

 
 

-  // Send idle event to all top-level windows.
-  // Returns TRUE if more idle time is requested.
-  bool SendIdleEvents();
+    // 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();

 
 

-  // Send idle event to window and all subwindows
-  // Returns TRUE if more idle time is requested.
-  bool SendIdleEvents(wxWindow* win);
+    // the same for shell32.dll: returns 400, 471, 500, 600, ... (4.70 not
+    // currently detected)
+    static int GetShell32Version();

 
 

-  inline void SetAuto3D(bool flag) { m_auto3D = flag; }
-  inline bool GetAuto3D() const { return m_auto3D; }
+    // 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;

 
 

-  // Creates a log object
-  virtual wxLog* CreateLogTarget();
+protected:
+    DECLARE_EVENT_TABLE()
+    wxDECLARE_NO_COPY_CLASS(wxApp);
+    DECLARE_DYNAMIC_CLASS(wxApp)
+};

 
 

-public:
-//  void (*work_proc)(wxApp*app); // work procedure;
-  int               argc;
-  char **           argv;
+#ifdef __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 */
+// 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;
+}

 
 

-public:
+// 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;
+}

 
 

-  // Implementation
-  static bool Initialize(WXHINSTANCE instance);
-  static void CommonInit();
-  static bool RegisterWindowClasses();
-  static void CleanUp();
-  static void CommonCleanUp();
-  virtual bool DoMessage();
-  virtual bool ProcessMessage(WXMSG* pMsg);
-  void DeletePendingObjects();
-  bool ProcessIdle();
-  int GetComCtl32Version() const;
+#endif // __WXWINCE__

 
 

-public:
-  static long       sm_lastMessageTime;
-  int               m_nCmdShow;
+// ----------------------------------------------------------------------------
+// MSW-specific wxEntry() overload and IMPLEMENT_WXWIN_MAIN definition
+// ----------------------------------------------------------------------------

 
 

-protected:
-  bool              m_keepGoing ;
-//  bool              m_resourceCollection;
-//  bool              m_pendingCleanup; // TRUE if we need to check the GDI object lists for cleanup
+// we need HINSTANCE declaration to define WinMain()
+#include "wx/msw/wrapwin.h"

 
 

-DECLARE_EVENT_TABLE()
-};
+#ifndef SW_SHOWNORMAL
+    #define SW_SHOWNORMAL 1
+#endif

 
 

-#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
-    // __APPH__
+// 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)                         \
+        {                                                                   \
+            wxDISABLE_DEBUG_SUPPORT();                                      \
+                                                                            \
+            /* 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)                             \
+    {                                                                       \
+        wxDISABLE_DEBUG_SUPPORT();                                          \
+                                                                            \
+        /* 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_