]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/cursor.cpp
mention ShouldInheritColours() change
[wxWidgets.git] / src / msw / cursor.cpp
index 0662f7f903271e5c241d7184465f189a955d5a2e..3ea5cb74975026f37c3742b4806406eaccbe18f0 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        cursor.cpp
+// Name:        src/msw/cursor.cpp
 // Purpose:     wxCursor class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:       wxWindows licence
+// Copyright:   (c) 1997-2003 Julian Smart and Vadim Zeitlin
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "cursor.h"
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma implementation "cursor.h"
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
 #ifndef WX_PRECOMP
-#include <stdio.h>
-#include "wx/setup.h"
-#include "wx/list.h"
-#include "wx/utils.h"
-#include "wx/app.h"
-#include "wx/cursor.h"
-#include "wx/icon.h"
+    #include "wx/utils.h"
+    #include "wx/app.h"
+    #include "wx/bitmap.h"
+    #include "wx/icon.h"
+    #include "wx/cursor.h"
+    #include "wx/settings.h"
+    #include "wx/intl.h"
 #endif
 
+#include "wx/module.h"
+#include "wx/image.h"
 #include "wx/msw/private.h"
-#include "wx/msw/dib.h"
 
-#include "assert.h"
+// define functions missing in MicroWin
+#ifdef __WXMICROWIN__
+    static inline void DestroyCursor(HCURSOR) { }
+    static inline void SetCursor(HCURSOR) { }
+#endif // __WXMICROWIN__
 
-#if wxUSE_RESOURCE_LOADING_IN_MSW
-#include "wx/msw/curico.h"
-#include "wx/msw/curicop.h"
-#endif
+// ----------------------------------------------------------------------------
+// private classes
+// ----------------------------------------------------------------------------
 
-#if !USE_SHARED_LIBRARIES
-IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxBitmap)
-#endif
+class WXDLLEXPORT wxCursorRefData : public wxGDIImageRefData
+{
+public:
+    // the second parameter is used to tell us to delete the cursor when we're
+    // done with it (normally we shouldn't call DestroyCursor() this is why it
+    // doesn't happen by default)
+    wxCursorRefData(HCURSOR hcursor = 0, bool takeOwnership = false);
+
+    virtual ~wxCursorRefData() { Free(); }
+
+    virtual void Free();
+
+
+    // return the size of the standard cursor: notice that the system only
+    // supports the cursors of this size
+    static wxCoord GetStandardWidth();
+    static wxCoord GetStandardHeight();
+
+private:
+    bool m_destroyCursor;
+
+    // standard cursor size, computed on first use
+    static wxSize ms_sizeStd;
+};
+
+// ----------------------------------------------------------------------------
+// wxWin macros
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxGDIObject)
+
+// ----------------------------------------------------------------------------
+// globals
+// ----------------------------------------------------------------------------
+
+// Current cursor, in order to hang on to cursor handle when setting the cursor
+// globally
+static wxCursor *gs_globalCursor = NULL;
 
-wxCursorRefData::wxCursorRefData(void)
+// ----------------------------------------------------------------------------
+// private classes
+// ----------------------------------------------------------------------------
+
+class wxCursorModule : public wxModule
 {
-  m_width = 32; m_height = 32;
-  m_hCursor = 0 ;
-  m_destroyCursor = FALSE;
-}
+public:
+    virtual bool OnInit()
+    {
+        gs_globalCursor = new wxCursor;
+
+        return TRUE;
+    }
+
+    virtual void OnExit()
+    {
+        delete gs_globalCursor;
+        gs_globalCursor = (wxCursor *)NULL;
+    }
+};
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxCursorRefData
+// ----------------------------------------------------------------------------
+
+wxSize wxCursorRefData::ms_sizeStd;
 
-wxCursorRefData::~wxCursorRefData(void)
+wxCoord wxCursorRefData::GetStandardWidth()
 {
-    if ( m_hCursor && m_destroyCursor)
-#ifdef __WXWINE__
-        ::DestroyCursor((HCURSOR) m_hCursor);
-#else
-        ::DestroyCursor((HICON) m_hCursor);
-#endif
+    if ( !ms_sizeStd.x )
+        ms_sizeStd.x = wxSystemSettings::GetMetric(wxSYS_CURSOR_X);
+
+    return ms_sizeStd.x;
 }
 
-// Cursors
-wxCursor::wxCursor(void)
+wxCoord wxCursorRefData::GetStandardHeight()
 {
+    if ( !ms_sizeStd.y )
+        ms_sizeStd.y = wxSystemSettings::GetMetric(wxSYS_CURSOR_Y);
+
+    return ms_sizeStd.y;
 }
 
-wxCursor::wxCursor(const char WXUNUSED(bits)[], int WXUNUSED(width), int WXUNUSED(height),
-    int WXUNUSED(hotSpotX), int WXUNUSED(hotSpotY), const char WXUNUSED(maskBits)[])
+wxCursorRefData::wxCursorRefData(HCURSOR hcursor, bool destroy)
 {
+    m_hCursor = (WXHCURSOR)hcursor;
+
+    if ( m_hCursor )
+    {
+        m_width = GetStandardWidth();
+        m_height = GetStandardHeight();
+    }
+
+    m_destroyCursor = destroy;
 }
 
-wxCursor::wxCursor(const wxString& cursor_file, long flags, int hotSpotX, int hotSpotY)
+void wxCursorRefData::Free()
 {
-  m_refData = new wxIconRefData;
-
-  M_CURSORDATA->m_destroyCursor = FALSE;
-  M_CURSORDATA->m_hCursor = 0;
-  M_CURSORDATA->m_ok = FALSE;
-  if (flags & wxBITMAP_TYPE_CUR_RESOURCE)
-  {
-    M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), cursor_file);
-    if (M_CURSORDATA->m_hCursor)
-      M_CURSORDATA->m_ok = TRUE;
-    else
-      M_CURSORDATA->m_ok = FALSE;
-  }
-  else if (flags & wxBITMAP_TYPE_CUR)
-  {
-#if wxUSE_RESOURCE_LOADING_IN_MSW
-    M_CURSORDATA->m_hCursor = (WXHCURSOR) ReadCursorFile(WXSTRINGCAST cursor_file, wxGetInstance(), &M_CURSORDATA->m_width, &M_CURSORDATA->m_height);
-    M_CURSORDATA->m_destroyCursor = TRUE;
-#endif
-  }
-  else if (flags & wxBITMAP_TYPE_ICO)
-  {
-#if wxUSE_RESOURCE_LOADING_IN_MSW
-    M_CURSORDATA->m_hCursor = (WXHCURSOR) IconToCursor(WXSTRINGCAST cursor_file, wxGetInstance(), hotSpotX, hotSpotY, &M_CURSORDATA->m_width, &M_CURSORDATA->m_height);
-    M_CURSORDATA->m_destroyCursor = TRUE;
-#endif
-  }
-  else if (flags & wxBITMAP_TYPE_BMP)
-  {
-#if wxUSE_RESOURCE_LOADING_IN_MSW
-    HBITMAP hBitmap = 0;
-    HPALETTE hPalette = 0;
-    bool success = ReadDIB(MBSTRINGCAST cursor_file.mb_str(wxConvFile), &hBitmap, &hPalette) != 0;
-    if (!success)
-      return;
-    if (hPalette)
-      DeleteObject(hPalette);
-    POINT pnt;
-    pnt.x = hotSpotX;
-    pnt.y = hotSpotY;
-    M_CURSORDATA->m_hCursor = (WXHCURSOR) MakeCursorFromBitmap(wxGetInstance(), hBitmap, &pnt);
-    M_CURSORDATA->m_destroyCursor = TRUE;
-    DeleteObject(hBitmap);
-    if (M_CURSORDATA->m_hCursor)
-      M_CURSORDATA->m_ok = TRUE;
+    if ( m_hCursor )
+    {
+#ifndef __WXWINCE__
+        if ( m_destroyCursor )
+            ::DestroyCursor((HCURSOR)m_hCursor);
 #endif
-  }
+
+        m_hCursor = 0;
+    }
 }
 
-// Cursors by stock number
-wxCursor::wxCursor(int cursor_type)
+// ----------------------------------------------------------------------------
+// Cursors
+// ----------------------------------------------------------------------------
+
+wxCursor::wxCursor()
 {
-  m_refData = new wxIconRefData;
-
-  switch (cursor_type)
-  {
-    case wxCURSOR_WAIT:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_WAIT);
-      break;
-    case wxCURSOR_IBEAM:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_IBEAM);
-      break;
-    case wxCURSOR_CROSS:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_CROSS);
-      break;
-    case wxCURSOR_SIZENWSE:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZENWSE);
-      break;
-    case wxCURSOR_SIZENESW:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZENESW);
-      break;
-    case wxCURSOR_SIZEWE:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZEWE);
-      break;
-    case wxCURSOR_SIZENS:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZENS);
-      break;
-    case wxCURSOR_CHAR:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
-      break;
-    }
-    case wxCURSOR_HAND:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_HAND"));
-      break;
-    }
-    case wxCURSOR_BULLSEYE:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_BULLSEYE"));
-      break;
-    }
-    case wxCURSOR_PENCIL:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_PENCIL"));
-      break;
-    }
-    case wxCURSOR_MAGNIFIER:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_MAGNIFIER"));
-      break;
-    }
-    case wxCURSOR_NO_ENTRY:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_NO_ENTRY"));
-      break;
-    }
-    case wxCURSOR_LEFT_BUTTON:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
-      break;
-    }
-    case wxCURSOR_RIGHT_BUTTON:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
-      break;
-    }
-    case wxCURSOR_MIDDLE_BUTTON:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
-      break;
-    }
-    case wxCURSOR_SIZING:
-    {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_SIZING"));
-      break;
-    }
-    case wxCURSOR_WATCH:
+}
+
+wxCursor::wxCursor(const wxImage& image)
+{
+    // image has to be of the standard cursor size, otherwise we won't be able
+    // to create it
+    const int w = wxCursorRefData::GetStandardWidth();
+    const int h = wxCursorRefData::GetStandardHeight();
+
+    const int hotSpotX = image.GetOptionInt(wxCUR_HOTSPOT_X);
+    const int hotSpotY = image.GetOptionInt(wxCUR_HOTSPOT_Y);
+
+    wxASSERT_MSG( hotSpotX >= 0 && hotSpotX < w &&
+                    hotSpotY >= 0 && hotSpotY < h,
+                  _T("invalid cursor hot spot coordinates") );
+
+    HCURSOR hcursor = wxBitmapToHCURSOR
+                      (
+                        wxBitmap(image.Scale(w, h)),
+                        hotSpotX,
+                        hotSpotY
+                      );
+    if ( !hcursor )
     {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_WATCH"));
-      break;
+        wxLogWarning(_("Failed to create cursor."));
+        return;
     }
-    case wxCURSOR_SPRAYCAN:
+
+    m_refData = new wxCursorRefData(hcursor, true /* delete it later */);
+}
+
+wxCursor::wxCursor(const char WXUNUSED(bits)[],
+                   int WXUNUSED(width),
+                   int WXUNUSED(height),
+                   int WXUNUSED(hotSpotX), int WXUNUSED(hotSpotY),
+                   const char WXUNUSED(maskBits)[])
+{
+}
+
+// MicroWin doesn't have support needed for the other ctors
+#ifdef __WXMICROWIN__
+
+wxCursor::wxCursor(const wxString& WXUNUSED(filename),
+                   long WXUNUSED(kind),
+                   int WXUNUSED(hotSpotX),
+                   int WXUNUSED(hotSpotY))
+{
+}
+
+wxCursor::wxCursor(int WXUNUSED(cursor_type))
+{
+}
+
+#else // !__WXMICROWIN__
+
+wxCursor::wxCursor(const wxString& filename,
+                   long kind,
+                   int hotSpotX,
+                   int hotSpotY)
+{
+    HCURSOR hcursor;
+    switch ( kind )
     {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_ROLLER"));
-      break;
+        case wxBITMAP_TYPE_CUR_RESOURCE:
+            hcursor = ::LoadCursor(wxGetInstance(), filename);
+            break;
+
+#ifndef __WXWINCE__
+        case wxBITMAP_TYPE_CUR:
+            hcursor = ::LoadCursorFromFile(filename);
+            break;
+#endif
+
+        case wxBITMAP_TYPE_ICO:
+            hcursor = wxBitmapToHCURSOR
+                      (
+                       wxIcon(filename, wxBITMAP_TYPE_ICO),
+                       hotSpotX,
+                       hotSpotY
+                      );
+            break;
+
+        case wxBITMAP_TYPE_BMP:
+            hcursor = wxBitmapToHCURSOR
+                      (
+                       wxBitmap(filename, wxBITMAP_TYPE_BMP),
+                       hotSpotX,
+                       hotSpotY
+                      );
+            break;
+
+        default:
+            wxFAIL_MSG( _T("unknown cursor resource type") );
+
+            hcursor = NULL;
     }
-    case wxCURSOR_PAINT_BRUSH:
+
+    if ( hcursor )
     {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_PBRUSH"));
-      break;
+        m_refData = new wxCursorRefData(hcursor, true /* delete it later */);
     }
-    case wxCURSOR_POINT_LEFT:
+}
+
+// Cursors by stock number
+wxCursor::wxCursor(int idCursor)
+{
+    // all wxWindows standard cursors
+    static const struct StdCursor
     {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_PLEFT"));
-      break;
-    }
-    case wxCURSOR_POINT_RIGHT:
+        // is this a standard Windows cursor?
+        bool isStd;
+
+        // the cursor name or id
+        LPCTSTR name;
+    } stdCursors[] =
     {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_PRIGHT"));
-      break;
-    }
-    case wxCURSOR_QUESTION_ARROW:
+        {  true, NULL                        }, // wxCURSOR_NONE
+        {  true, IDC_ARROW                   }, // wxCURSOR_ARROW
+        { false, _T("wxCURSOR_RIGHT_ARROW")  }, // wxCURSOR_RIGHT_ARROW
+        { false, _T("wxCURSOR_BULLSEYE")     }, // wxCURSOR_BULLSEYE
+        {  true, IDC_ARROW                   }, // wxCURSOR_CHAR
+        {  true, IDC_CROSS                   }, // wxCURSOR_CROSS
+        { false, _T("wxCURSOR_HAND")         }, // wxCURSOR_HAND
+        {  true, IDC_IBEAM                   }, // wxCURSOR_IBEAM
+        {  true, IDC_ARROW                   }, // wxCURSOR_LEFT_BUTTON
+        { false, _T("wxCURSOR_MAGNIFIER")    }, // wxCURSOR_MAGNIFIER
+        {  true, IDC_ARROW                   }, // wxCURSOR_MIDDLE_BUTTON
+        {  true, IDC_NO                      }, // wxCURSOR_NO_ENTRY
+        { false, _T("wxCURSOR_PAINT_BRUSH")  }, // wxCURSOR_PAINT_BRUSH
+        { false, _T("wxCURSOR_PENCIL")       }, // wxCURSOR_PENCIL
+        { false, _T("wxCURSOR_POINT_LEFT")   }, // wxCURSOR_POINT_LEFT
+        { false, _T("wxCURSOR_POINT_RIGHT")  }, // wxCURSOR_POINT_RIGHT
+        {  true, IDC_HELP                    }, // wxCURSOR_QUESTION_ARROW
+        {  true, IDC_ARROW                   }, // wxCURSOR_RIGHT_BUTTON
+        {  true, IDC_SIZENESW                }, // wxCURSOR_SIZENESW
+        {  true, IDC_SIZENS                  }, // wxCURSOR_SIZENS
+        {  true, IDC_SIZENWSE                }, // wxCURSOR_SIZENWSE
+        {  true, IDC_SIZEWE                  }, // wxCURSOR_SIZEWE
+        {  true, IDC_SIZEALL                 }, // wxCURSOR_SIZING
+        { false, _T("wxCURSOR_SPRAYCAN")     }, // wxCURSOR_SPRAYCAN
+        {  true, IDC_WAIT                    }, // wxCURSOR_WAIT
+        {  true, IDC_WAIT                    }, // wxCURSOR_WATCH
+        { false, _T("wxCURSOR_BLANK")        }, // wxCURSOR_BLANK
+        {  true, IDC_APPSTARTING             }, // wxCURSOR_ARROWWAIT
+
+        // no entry for wxCURSOR_MAX
+    };
+
+    wxCOMPILE_TIME_ASSERT( WXSIZEOF(stdCursors) == wxCURSOR_MAX,
+                           CursorsIdArrayMismatch );
+
+    wxCHECK_RET( idCursor > 0 && (size_t)idCursor < WXSIZEOF(stdCursors),
+                 _T("invalid cursor id in wxCursor() ctor") );
+
+    const StdCursor& stdCursor = stdCursors[idCursor];
+
+    HCURSOR hcursor = ::LoadCursor(stdCursor.isStd ? NULL : wxGetInstance(),
+                                   stdCursor.name);
+
+    if ( !hcursor )
     {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_QARROW"));
-      break;
+        wxLogLastError(_T("LoadCursor"));
     }
-    case wxCURSOR_BLANK:
+    else
     {
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), _T("wxCURSOR_BLANK"));
-      break;
+        m_refData = new wxCursorRefData(hcursor);
     }
-    default:
-    case wxCURSOR_ARROW:
-      M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
-      break;
-  }
 }
 
-wxCursor::~wxCursor(void)
+#endif // __WXMICROWIN__/!__WXMICROWIN__
+
+wxCursor::~wxCursor()
 {
-//    FreeResource(TRUE);
 }
 
-bool wxCursor::FreeResource(bool WXUNUSED(force))
+// ----------------------------------------------------------------------------
+// other wxCursor functions
+// ----------------------------------------------------------------------------
+
+bool wxCursor::operator==(const wxCursor& cursor) const
 {
-  if (M_CURSORDATA && M_CURSORDATA->m_hCursor && M_CURSORDATA->m_destroyCursor)
-  {
-    DestroyCursor((HCURSOR) M_CURSORDATA->m_hCursor);
-    M_CURSORDATA->m_hCursor = 0;
-  }
-  return TRUE;
+    if ( !m_refData )
+        return !cursor.m_refData;
+
+    return cursor.m_refData &&
+                ((wxCursorRefData *)m_refData)->m_hCursor ==
+                ((wxCursorRefData *)cursor.m_refData)->m_hCursor;
 }
 
-void wxCursor::SetHCURSOR(WXHCURSOR cursor)
+wxGDIImageRefData *wxCursor::CreateData() const
 {
-  if ( !M_CURSORDATA )
-    m_refData = new wxCursorRefData;
-
-  M_CURSORDATA->m_hCursor = cursor;
+    return new wxCursorRefData;
 }
 
+// ----------------------------------------------------------------------------
 // Global cursor setting
-void wxSetCursor(const wxCursor& cursor)
+// ----------------------------------------------------------------------------
+
+const wxCursor *wxGetGlobalCursor()
 {
-    extern wxCursor *g_globalCursor;
+    return gs_globalCursor;
+}
 
-    if ( cursor.Ok() && cursor.GetHCURSOR() )
+void wxSetCursor(const wxCursor& cursor)
+{
+    if ( cursor.Ok() )
     {
-        ::SetCursor((HCURSOR) cursor.GetHCURSOR());
+        ::SetCursor(GetHcursorOf(cursor));
 
-        if ( g_globalCursor )
-            (*g_globalCursor) = cursor;
+        if ( gs_globalCursor )
+            *gs_globalCursor = cursor;
     }
 }