don't pass unnecessary arguments to FindOrCreateBrush/Pen()

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

diff --git a/include/wx/msw/private.h b/include/wx/msw/private.h
index 73c03ad10ca23121690c609d5303bf4c4ade2a58..4bed1f04b88e43d6cbf03126a16e47de99bc3523 100644 (file)
--- a/include/wx/msw/private.h
+++ b/include/wx/msw/private.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        private.h
+// Name:        wx/msw/private.h

 // Purpose:     Private declarations: as this header is only included by
 //              wxWidgets itself, it may contain identifiers which don't start
 //              with "wx".
 // Purpose:     Private declarations: as this header is only included by
 //              wxWidgets itself, it may contain identifiers which don't start
 //              with "wx".


@@ -21,14 +21,11 @@
     #include "wx/msw/microwin.h"
 #endif
 
     #include "wx/msw/microwin.h"
 #endif
 

-// Include fixes for MSLU:
-#include "wx/msw/mslu.h"
-

 #include "wx/log.h"
 
 #include "wx/log.h"
 

-class WXDLLEXPORT wxFont;
-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxWindowBase;
+class WXDLLIMPEXP_FWD_CORE wxFont;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxWindowBase;

 
 // ---------------------------------------------------------------------------
 // private constants
 
 // ---------------------------------------------------------------------------
 // private constants


@@ -108,22 +105,6 @@ extern WXDLLIMPEXP_DATA_BASE(HINSTANCE) wxhInstance;
 #endif
 #endif
 
 #endif
 #endif
 

-#if wxUSE_PENWIN
-    WXDLLEXPORT void wxRegisterPenWin();
-    WXDLLEXPORT void wxCleanUpPenWin();
-    WXDLLEXPORT void wxEnablePenAppHooks (bool hook);
-#endif // wxUSE_PENWIN
-
-#if wxUSE_ITSY_BITSY
-    #define IBS_HORZCAPTION    0x4000L
-    #define IBS_VERTCAPTION    0x8000L
-
-    UINT    WINAPI ibGetCaptionSize( HWND hWnd  ) ;
-    UINT    WINAPI ibSetCaptionSize( HWND hWnd, UINT nSize ) ;
-    LRESULT WINAPI ibDefWindowProc( HWND hWnd, UINT uiMsg, WPARAM wParam, LPARAM lParam ) ;
-    VOID    WINAPI ibAdjustWindowRect( HWND hWnd, LPRECT lprc ) ;
-#endif // wxUSE_ITSY_BITSY
-

 /*
  * Decide what window classes we're going to use
  * for this combination of CTl3D/FAFA settings
 /*
  * Decide what window classes we're going to use
  * for this combination of CTl3D/FAFA settings


@@ -182,6 +163,7 @@ extern LONG APIENTRY _EXPORT
 // Intel, Visual Age.
 #if defined(__WXWINCE__)
     #define wxGetOSFHandle(fd) ((HANDLE)fd)
 // Intel, Visual Age.
 #if defined(__WXWINCE__)
     #define wxGetOSFHandle(fd) ((HANDLE)fd)

+    #define wxOpenOSFHandle(h, flags) ((int)wxPtrToUInt(h))

 #elif defined(__CYGWIN__)
     #define wxGetOSFHandle(fd) ((HANDLE)get_osfhandle(fd))
 #elif defined(__VISUALC__) \
 #elif defined(__CYGWIN__)
     #define wxGetOSFHandle(fd) ((HANDLE)get_osfhandle(fd))
 #elif defined(__VISUALC__) \


@@ -191,6 +173,8 @@ extern LONG APIENTRY _EXPORT
    || defined(__MINGW32__) \
    || (defined(__MWERKS__) && defined(__MSL__))
     #define wxGetOSFHandle(fd) ((HANDLE)_get_osfhandle(fd))
    || defined(__MINGW32__) \
    || (defined(__MWERKS__) && defined(__MSL__))
     #define wxGetOSFHandle(fd) ((HANDLE)_get_osfhandle(fd))

+    #define wxOpenOSFHandle(h, flags) (_open_osfhandle(wxPtrToUInt(h), flags))
+    #define wx_fdopen _fdopen

 #endif
 
 // close the handle in the class dtor
 #endif
 
 // close the handle in the class dtor


@@ -208,10 +192,26 @@ protected:
     HANDLE m_handle;
 };
 
     HANDLE m_handle;
 };
 

+// a template to make initializing Windows styructs less painful: it zeroes all
+// the struct fields and also sets cbSize member to the correct value (and so
+// can be only used with structures which have this member...)
+template <class T>
+struct WinStruct : public T
+{
+    WinStruct()
+    {
+        ::ZeroMemory(this, sizeof(T));
+
+        // explicit qualification is required here for this to be valid C++
+        this->cbSize = sizeof(T);
+    }
+};
+
+

 #if wxUSE_GUI
 
 #if wxUSE_GUI
 

-#include <wx/gdicmn.h>
-#include <wx/colour.h>
+#include "wx/gdicmn.h"
+#include "wx/colour.h"

 
 // make conversion from wxColour and COLORREF a bit less painful
 inline COLORREF wxColourToRGB(const wxColour& c)
 
 // make conversion from wxColour and COLORREF a bit less painful
 inline COLORREF wxColourToRGB(const wxColour& c)


@@ -311,21 +311,32 @@ HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY);
     #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
 #endif // GET_X_LPARAM
 
     #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
 #endif // GET_X_LPARAM
 

-// get the current state of SHIFT/CTRL keys
-inline bool wxIsShiftDown()
+// get the current state of SHIFT/CTRL/ALT keys
+inline bool wxIsModifierDown(int vk)

 {
 {

-//    return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
-    // Returns different negative values on WinME and WinNT,
+    // GetKeyState() returns different negative values on WinME and WinNT,

     // so simply test for negative value.
     // so simply test for negative value.

-    return ::GetKeyState(VK_SHIFT) < 0;
+    return ::GetKeyState(vk) < 0;
+}
+
+inline bool wxIsShiftDown()
+{
+    return wxIsModifierDown(VK_SHIFT);

 }
 
 inline bool wxIsCtrlDown()
 {
 }
 
 inline bool wxIsCtrlDown()
 {

-//    return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
-    // Returns different negative values on WinME and WinNT,
-    // so simply test for negative value.
-    return ::GetKeyState(VK_CONTROL) < 0;
+    return wxIsModifierDown(VK_CONTROL);
+}
+
+inline bool wxIsAltDown()
+{
+    return wxIsModifierDown(VK_MENU);
+}
+
+inline bool wxIsAnyModifierDown()
+{
+    return wxIsShiftDown() || wxIsCtrlDown() || wxIsAltDown();

 }
 
 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
 }
 
 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking


@@ -335,9 +346,7 @@ inline RECT wxGetWindowRect(HWND hwnd)
     RECT rect;
 
     if ( !::GetWindowRect(hwnd, &rect) )
     RECT rect;
 
     if ( !::GetWindowRect(hwnd, &rect) )

-    {

         wxLogLastError(_T("GetWindowRect"));
         wxLogLastError(_T("GetWindowRect"));

-    }

 
     return rect;
 }
 
     return rect;
 }


@@ -347,9 +356,7 @@ inline RECT wxGetClientRect(HWND hwnd)
     RECT rect;
 
     if ( !::GetClientRect(hwnd, &rect) )
     RECT rect;
 
     if ( !::GetClientRect(hwnd, &rect) )

-    {

         wxLogLastError(_T("GetClientRect"));
         wxLogLastError(_T("GetClientRect"));

-    }

 
     return rect;
 }
 
     return rect;
 }


@@ -358,22 +365,6 @@ inline RECT wxGetClientRect(HWND hwnd)
 // small helper classes
 // ---------------------------------------------------------------------------
 
 // small helper classes
 // ---------------------------------------------------------------------------
 

-// a template to make initializing Windows styructs less painful: it zeroes all
-// the struct fields and also sets cbSize member to the correct value (and so
-// can be only used with structures which have this member...)
-template <class T>
-struct WinStruct : public T
-{
-    WinStruct()
-    {
-        ::ZeroMemory(this, sizeof(T));
-
-        // explicit qualification is required here for this to be valid C++
-        this->cbSize = sizeof(T);
-    }
-};
-
-

 // create an instance of this class and use it as the HDC for screen, will
 // automatically release the DC going out of scope
 class ScreenHDC
 // create an instance of this class and use it as the HDC for screen, will
 // automatically release the DC going out of scope
 class ScreenHDC


@@ -426,29 +417,49 @@ private:
 // dtor
 class SelectInHDC
 {
 // dtor
 class SelectInHDC
 {

+private:
+    void DoInit(HGDIOBJ hgdiobj) { m_hgdiobj = ::SelectObject(m_hdc, hgdiobj); }
+

 public:
 public:

-    SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc)
-        { m_hgdiobj = ::SelectObject(hdc, hgdiobj); }
+    SelectInHDC() : m_hdc(NULL) { }
+    SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc) { DoInit(hgdiobj); }
+
+    void Init(HDC hdc, HGDIOBJ hgdiobj)
+    {
+        wxASSERT_MSG( !m_hdc, _T("initializing twice?") );
+
+        m_hdc = hdc;
+
+        DoInit(hgdiobj);
+    }

 
 

-   ~SelectInHDC() { ::SelectObject(m_hdc, m_hgdiobj); }
+    ~SelectInHDC() { if ( m_hdc ) ::SelectObject(m_hdc, m_hgdiobj); }

 
 

-   // return true if the object was successfully selected
-   operator bool() const { return m_hgdiobj != 0; }
+    // return true if the object was successfully selected
+    operator bool() const { return m_hgdiobj != 0; }

 
 private:
 
 private:

-   HDC m_hdc;
-   HGDIOBJ m_hgdiobj;
+    HDC m_hdc;
+    HGDIOBJ m_hgdiobj;

 
 

-   DECLARE_NO_COPY_CLASS(SelectInHDC)
+    DECLARE_NO_COPY_CLASS(SelectInHDC)

 };
 
 // a class which cleans up any GDI object
 class AutoGDIObject
 {
 protected:
 };
 
 // a class which cleans up any GDI object
 class AutoGDIObject
 {
 protected:

+    AutoGDIObject() { m_gdiobj = NULL; }

     AutoGDIObject(HGDIOBJ gdiobj) : m_gdiobj(gdiobj) { }
     ~AutoGDIObject() { if ( m_gdiobj ) ::DeleteObject(m_gdiobj); }
 
     AutoGDIObject(HGDIOBJ gdiobj) : m_gdiobj(gdiobj) { }
     ~AutoGDIObject() { if ( m_gdiobj ) ::DeleteObject(m_gdiobj); }
 

+    void InitGdiobj(HGDIOBJ gdiobj)
+    {
+        wxASSERT_MSG( !m_gdiobj, _T("initializing twice?") );
+
+        m_gdiobj = gdiobj;
+    }
+

     HGDIOBJ GetObject() const { return m_gdiobj; }
 
 private:
     HGDIOBJ GetObject() const { return m_gdiobj; }
 
 private:


@@ -457,7 +468,7 @@ private:
 
 // TODO: all this asks for using a AutoHandler<T, CreateFunc> template...
 
 
 // TODO: all this asks for using a AutoHandler<T, CreateFunc> template...
 

-// a class for temporary pens
+// a class for temporary brushes

 class AutoHBRUSH : private AutoGDIObject
 {
 public:
 class AutoHBRUSH : private AutoGDIObject
 {
 public:


@@ -467,6 +478,22 @@ public:
     operator HBRUSH() const { return (HBRUSH)GetObject(); }
 };
 
     operator HBRUSH() const { return (HBRUSH)GetObject(); }
 };
 

+// a class for temporary fonts
+class AutoHFONT : private AutoGDIObject
+{
+private:
+public:
+    AutoHFONT()
+        : AutoGDIObject() { }
+
+    AutoHFONT(const LOGFONT& lf)
+        : AutoGDIObject(::CreateFontIndirect(&lf)) { }
+
+    void Init(const LOGFONT& lf) { InitGdiobj(::CreateFontIndirect(&lf)); }
+
+    operator HFONT() const { return (HFONT)GetObject(); }
+};
+

 // a class for temporary pens
 class AutoHPEN : private AutoGDIObject
 {
 // a class for temporary pens
 class AutoHPEN : private AutoGDIObject
 {


@@ -535,24 +562,104 @@ private:
     DECLARE_NO_COPY_CLASS(HDCClipper)
 };
 
     DECLARE_NO_COPY_CLASS(HDCClipper)
 };
 

+// set the given map mode for the life time of this object
+//
+// NB: SetMapMode() is not supported by CE so we also define a helper macro
+//     to avoid using it there
+#ifdef __WXWINCE__
+    #define wxCHANGE_HDC_MAP_MODE(hdc, mm)
+#else // !__WXWINCE__
+    class HDCMapModeChanger
+    {
+    public:
+        HDCMapModeChanger(HDC hdc, int mm)
+            : m_hdc(hdc)
+        {
+            m_modeOld = ::SetMapMode(hdc, mm);
+            if ( !m_modeOld )
+                wxLogLastError(_T("SelectClipRgn"));
+        }
+
+        ~HDCMapModeChanger()
+        {
+            if ( m_modeOld )
+                ::SetMapMode(m_hdc, m_modeOld);
+        }
+
+    private:
+        HDC m_hdc;
+        int m_modeOld;
+
+        DECLARE_NO_COPY_CLASS(HDCMapModeChanger)
+    };
+
+    #define wxCHANGE_HDC_MAP_MODE(hdc, mm) \
+        HDCMapModeChanger wxMAKE_UNIQUE_NAME(wxHDCMapModeChanger)(hdc, mm)
+#endif // __WXWINCE__/!__WXWINCE__
+
+// smart pointer using GlobalAlloc/GlobalFree()
+class GlobalPtr
+{
+public:
+    // allocates a block of given size
+    GlobalPtr(size_t size, unsigned flags = GMEM_MOVEABLE)
+    {
+        m_hGlobal = ::GlobalAlloc(flags, size);
+        if ( !m_hGlobal )
+            wxLogLastError(_T("GlobalAlloc"));
+    }
+
+    ~GlobalPtr()
+    {
+        if ( m_hGlobal && ::GlobalFree(m_hGlobal) )
+            wxLogLastError(_T("GlobalFree"));
+    }
+
+    // implicit conversion
+    operator HGLOBAL() const { return m_hGlobal; }
+
+private:
+    HGLOBAL m_hGlobal;
+
+    DECLARE_NO_COPY_CLASS(GlobalPtr)
+};
+

 // when working with global pointers (which is unfortunately still necessary
 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
 // many times as we lock them which just asks for using a "smart lock" class
 class GlobalPtrLock
 {
 public:
 // when working with global pointers (which is unfortunately still necessary
 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
 // many times as we lock them which just asks for using a "smart lock" class
 class GlobalPtrLock
 {
 public:

-    GlobalPtrLock(HGLOBAL hGlobal) : m_hGlobal(hGlobal)
+    // default ctor, use Init() later -- should only be used if the HGLOBAL can
+    // be NULL (in which case Init() shouldn't be called)
+    GlobalPtrLock()

     {
     {

+        m_hGlobal = NULL;
+        m_ptr = NULL;
+    }
+
+    // initialize the object, may be only called if we were created using the
+    // default ctor; HGLOBAL must not be NULL
+    void Init(HGLOBAL hGlobal)
+    {
+        m_hGlobal = hGlobal;
+
+        // NB: GlobalLock() is a macro, not a function, hence don't use the
+        //     global scope operator with it (and neither with GlobalUnlock())

         m_ptr = GlobalLock(hGlobal);
         if ( !m_ptr )
         m_ptr = GlobalLock(hGlobal);
         if ( !m_ptr )

-        {

             wxLogLastError(_T("GlobalLock"));
             wxLogLastError(_T("GlobalLock"));

-        }
+    }
+
+    // initialize the object, HGLOBAL must not be NULL
+    GlobalPtrLock(HGLOBAL hGlobal)
+    {
+        Init(hGlobal);

     }
 
     ~GlobalPtrLock()
     {
     }
 
     ~GlobalPtrLock()
     {

-        if ( !GlobalUnlock(m_hGlobal) )
+        if ( m_hGlobal && !GlobalUnlock(m_hGlobal) )

         {
 #ifdef __WXDEBUG__
             // this might happen simply because the block became unlocked
         {
 #ifdef __WXDEBUG__
             // this might happen simply because the block became unlocked


@@ -565,6 +672,7 @@ public:
         }
     }
 
         }
     }
 

+    void *Get() const { return m_ptr; }

     operator void *() const { return m_ptr; }
 
 private:
     operator void *() const { return m_ptr; }
 
 private:


@@ -616,7 +724,7 @@ public:
     {
         if ( IsRegistered() )
         {
     {
         if ( IsRegistered() )
         {

-            if ( !::UnregisterClass(m_clsname, wxhInstance) )
+            if ( !::UnregisterClass(m_clsname.wx_str(), wxhInstance) )

             {
                 wxLogLastError(_T("UnregisterClass"));
             }
             {
                 wxLogLastError(_T("UnregisterClass"));
             }


@@ -748,7 +856,8 @@ enum wxWinVersion
     wxWinVersion_2003 = 0x0502,
 
     wxWinVersion_6 = 0x0600,
     wxWinVersion_2003 = 0x0502,
 
     wxWinVersion_6 = 0x0600,

-    wxWinVersion_NT6 = 0x0600
+    wxWinVersion_Vista = wxWinVersion_6,
+    wxWinVersion_NT6 = wxWinVersion_6

 };
 
 WXDLLIMPEXP_BASE wxWinVersion wxGetWinVersion();
 };
 
 WXDLLIMPEXP_BASE wxWinVersion wxGetWinVersion();


@@ -778,7 +887,7 @@ extern WXDLLEXPORT wxString wxGetWindowClass(WXHWND hWnd);
 
 // get the window id (should be unsigned, hence this is not wxWindowID which
 // is, for mainly historical reasons, signed)
 
 // get the window id (should be unsigned, hence this is not wxWindowID which
 // is, for mainly historical reasons, signed)

-extern WXDLLEXPORT WXWORD wxGetWindowId(WXHWND hWnd);
+extern WXDLLEXPORT int wxGetWindowId(WXHWND hWnd);

 
 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
 // different
 
 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
 // different


@@ -791,16 +900,19 @@ inline bool wxStyleHasBorder(long style)
                      wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
 }
 
                      wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
 }
 

-// Deferred window moving
-bool wxMoveWindowDeferred(HDWP& hdwp, wxWindowBase* win, HWND hWnd, int x, int y, int width, int height);
-

 // ----------------------------------------------------------------------------
 // functions mapping HWND to wxWindow
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // functions mapping HWND to wxWindow
 // ----------------------------------------------------------------------------
 

-// this function simply checks whether the given hWnd corresponds to a wxWindow
+// this function simply checks whether the given hwnd corresponds to a wxWindow

 // and returns either that window if it does or NULL otherwise
 // and returns either that window if it does or NULL otherwise

-extern WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
+extern WXDLLEXPORT wxWindow* wxFindWinFromHandle(HWND hwnd);
+
+// without STRICT WXHWND is the same as HWND anyhow
+inline wxWindow* wxFindWinFromHandle(WXHWND hWnd)
+{
+    return wxFindWinFromHandle(wx_static_cast(HWND, hWnd));
+}

 
 // find the window for HWND which is part of some wxWindow, i.e. unlike
 // wxFindWinFromHandle() above it will also work for "sub controls" of a
 
 // find the window for HWND which is part of some wxWindow, i.e. unlike
 // wxFindWinFromHandle() above it will also work for "sub controls" of a


@@ -851,38 +963,28 @@ inline void *wxSetWindowUserData(HWND hwnd, void *data)
 
 #else // __WIN32__
 
 
 #else // __WIN32__
 

-#ifdef __VISUALC__
-    // strangely enough, VC++ 7.1 gives warnings about 32 -> 64 bit conversions
-    // in the functions below, even in spite of the explicit casts
-    #pragma warning(disable:4311)
-    #pragma warning(disable:4312)
-#endif
-
-inline void *wxGetWindowProc(HWND hwnd)
+// note that the casts to LONG_PTR here are required even on 32-bit machines
+// for the 64-bit warning mode of later versions of MSVC (C4311/4312)
+inline WNDPROC wxGetWindowProc(HWND hwnd)

 {
 {

-    return (void *)::GetWindowLong(hwnd, GWL_WNDPROC);
+    return (WNDPROC)(LONG_PTR)::GetWindowLong(hwnd, GWL_WNDPROC);

 }
 
 inline void *wxGetWindowUserData(HWND hwnd)
 {
 }
 
 inline void *wxGetWindowUserData(HWND hwnd)
 {

-    return (void *)::GetWindowLong(hwnd, GWL_USERDATA);
+    return (void *)(LONG_PTR)::GetWindowLong(hwnd, GWL_USERDATA);

 }
 
 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
 {
 }
 
 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
 {

-    return (WNDPROC)::SetWindowLong(hwnd, GWL_WNDPROC, (LONG)func);
+    return (WNDPROC)(LONG_PTR)::SetWindowLong(hwnd, GWL_WNDPROC, (LONG_PTR)func);

 }
 
 inline void *wxSetWindowUserData(HWND hwnd, void *data)
 {
 }
 
 inline void *wxSetWindowUserData(HWND hwnd, void *data)
 {

-    return (void *)::SetWindowLong(hwnd, GWL_USERDATA, (LONG)data);
+    return (void *)(LONG_PTR)::SetWindowLong(hwnd, GWL_USERDATA, (LONG_PTR)data);

 }
 
 }
 

-#ifdef __VISUALC__
-    #pragma warning(default:4311)
-    #pragma warning(default:4312)
-#endif
-

 #endif // __WIN64__/__WIN32__
 
 #endif // wxUSE_GUI
 #endif // __WIN64__/__WIN32__
 
 #endif // wxUSE_GUI