/////////////////////////////////////////////////////////////////////////////
-// 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
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "cursor.h"
#endif
#endif
#ifndef WX_PRECOMP
- #include "wx/list.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 "wx/msw/missing.h" // IDC_HAND
-#if wxUSE_RESOURCE_LOADING_IN_MSW
- #include "wx/msw/curico.h"
- #include "wx/msw/curicop.h"
-#endif
+// define functions missing in MicroWin
+#ifdef __WXMICROWIN__
+ static inline void DestroyCursor(HCURSOR) { }
+ static inline void SetCursor(HCURSOR) { }
+#endif // __WXMICROWIN__
+
+// ----------------------------------------------------------------------------
+// private classes
+// ----------------------------------------------------------------------------
+
+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, wxCursorBase)
+IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxGDIObject)
// ----------------------------------------------------------------------------
// globals
{
gs_globalCursor = new wxCursor;
- return TRUE;
+ return true;
}
virtual void OnExit()
// wxCursorRefData
// ----------------------------------------------------------------------------
-wxCursorRefData::wxCursorRefData()
+wxSize wxCursorRefData::ms_sizeStd;
+
+wxCoord wxCursorRefData::GetStandardWidth()
{
- m_width = 32;
- m_height = 32;
+ if ( !ms_sizeStd.x )
+ ms_sizeStd.x = wxSystemSettings::GetMetric(wxSYS_CURSOR_X);
+
+ return ms_sizeStd.x;
+}
+
+wxCoord wxCursorRefData::GetStandardHeight()
+{
+ if ( !ms_sizeStd.y )
+ ms_sizeStd.y = wxSystemSettings::GetMetric(wxSYS_CURSOR_Y);
+
+ return ms_sizeStd.y;
+}
+
+wxCursorRefData::wxCursorRefData(HCURSOR hcursor, bool destroy)
+{
+ m_hCursor = (WXHCURSOR)hcursor;
+
+ if ( m_hCursor )
+ {
+ m_width = GetStandardWidth();
+ m_height = GetStandardHeight();
+ }
- m_destroyCursor = FALSE;
+ m_destroyCursor = destroy;
}
void wxCursorRefData::Free()
{
if ( m_hCursor )
{
+#ifndef __WXWINCE__
if ( m_destroyCursor )
::DestroyCursor((HCURSOR)m_hCursor);
+#endif
m_hCursor = 0;
}
{
}
+#if wxUSE_IMAGE
+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();
+
+ int hotSpotX = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
+ int hotSpotY = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+ int image_w = image.GetWidth();
+ int image_h = image.GetHeight();
+
+ wxASSERT_MSG( hotSpotX >= 0 && hotSpotX < image_w &&
+ hotSpotY >= 0 && hotSpotY < image_h,
+ _T("invalid cursor hot spot coordinates") );
+
+ wxImage imageSized(image); // final image of correct size
+
+ // if image is too small then place it in the center, resize it if too big
+ if ((w > image_w) && (h > image_h))
+ {
+ wxPoint offset((w - image_w)/2, (h - image_h)/2);
+ hotSpotX = hotSpotX + offset.x;
+ hotSpotY = hotSpotY + offset.y;
+
+ imageSized = image.Size(wxSize(w, h), offset);
+ }
+ else if ((w != image_w) || (h != image_h))
+ {
+ hotSpotX = int(hotSpotX * double(w) / double(image_w));
+ hotSpotY = int(hotSpotY * double(h) / double(image_h));
+
+ imageSized = image.Scale(w, h);
+ }
+
+ HCURSOR hcursor = wxBitmapToHCURSOR( wxBitmap(imageSized),
+ hotSpotX, hotSpotY );
+
+ if ( !hcursor )
+ {
+ wxLogWarning(_("Failed to create cursor."));
+ return;
+ }
+
+ m_refData = new wxCursorRefData(hcursor, true /* delete it later */);
+}
+#endif
+
wxCursor::wxCursor(const char WXUNUSED(bits)[],
int WXUNUSED(width),
int WXUNUSED(height),
{
}
-wxCursor::wxCursor(const wxString& cursor_file,
- long flags,
- int hotSpotX, int hotSpotY)
+// 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))
{
- wxCursorRefData *refData = new wxCursorRefData;
- m_refData = refData;
+}
- refData->m_destroyCursor = FALSE;
+#else // !__WXMICROWIN__
- if (flags == wxBITMAP_TYPE_CUR_RESOURCE)
- {
-#ifdef __WIN95__
- refData->m_hCursor = (WXHCURSOR) LoadImage(wxGetInstance(), cursor_file, IMAGE_CURSOR, 0, 0, 0);
-#else
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), cursor_file);
-#endif
- }
- else if (flags == wxBITMAP_TYPE_CUR)
- {
-#ifdef __WIN95__
- refData->m_hCursor = (WXHCURSOR) LoadImage(wxGetInstance(), cursor_file, IMAGE_CURSOR, 0, 0, LR_LOADFROMFILE);
-#else
-#if wxUSE_RESOURCE_LOADING_IN_MSW
- refData->m_hCursor = (WXHCURSOR) ReadCursorFile(WXSTRINGCAST cursor_file, wxGetInstance(), &refData->m_width, &refData->m_height);
- refData->m_destroyCursor = TRUE;
-#endif
-#endif
- }
- else if (flags == wxBITMAP_TYPE_ICO)
+wxCursor::wxCursor(const wxString& filename,
+ long kind,
+ int hotSpotX,
+ int hotSpotY)
+{
+ HCURSOR hcursor;
+ switch ( kind )
{
-#if wxUSE_RESOURCE_LOADING_IN_MSW
- refData->m_hCursor = (WXHCURSOR) IconToCursor(WXSTRINGCAST cursor_file, wxGetInstance(), hotSpotX, hotSpotY, &refData->m_width, &refData->m_height);
- refData->m_destroyCursor = TRUE;
+ 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;
}
- else if (flags == wxBITMAP_TYPE_BMP)
+
+ if ( hcursor )
{
-#if wxUSE_RESOURCE_LOADING_IN_MSW
- HBITMAP hBitmap = 0;
- HPALETTE hPalette = 0;
- bool success = wxReadDIB(WXSTRINGCAST cursor_file, &hBitmap, &hPalette) != 0;
- if (!success)
- return;
- if (hPalette)
- DeleteObject(hPalette);
- POINT pnt;
- pnt.x = hotSpotX;
- pnt.y = hotSpotY;
- refData->m_hCursor = (WXHCURSOR) MakeCursorFromBitmap(wxGetInstance(), hBitmap, &pnt);
- refData->m_destroyCursor = TRUE;
- DeleteObject(hBitmap);
-#endif
+ m_refData = new wxCursorRefData(hcursor, true /* delete it later */);
}
-
-#if WXWIN_COMPATIBILITY_2
- refData->SetOk();
-#endif // WXWIN_COMPATIBILITY_2
}
// Cursors by stock number
-wxCursor::wxCursor(int cursor_type)
+wxCursor::wxCursor(int idCursor)
{
- wxCursorRefData *refData = new wxCursorRefData;
- m_refData = refData;
-
- switch (cursor_type)
- {
- case wxCURSOR_WAIT:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_WAIT);
- break;
- case wxCURSOR_IBEAM:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_IBEAM);
- break;
- case wxCURSOR_CROSS:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_CROSS);
- break;
- case wxCURSOR_SIZENWSE:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZENWSE);
- break;
- case wxCURSOR_SIZENESW:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZENESW);
- break;
- case wxCURSOR_SIZEWE:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZEWE);
- break;
- case wxCURSOR_SIZENS:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_SIZENS);
- break;
- case wxCURSOR_CHAR:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
- break;
- }
- case wxCURSOR_HAND:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_HAND"));
- break;
- }
- case wxCURSOR_BULLSEYE:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_BULLSEYE"));
- break;
- }
- case wxCURSOR_PENCIL:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_PENCIL"));
- break;
- }
- case wxCURSOR_MAGNIFIER:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_MAGNIFIER"));
- break;
- }
- case wxCURSOR_NO_ENTRY:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_NO_ENTRY"));
- break;
- }
- case wxCURSOR_LEFT_BUTTON:
+ // all wxWidgets standard cursors
+ static const struct StdCursor
{
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
- break;
- }
- case wxCURSOR_RIGHT_BUTTON:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
- break;
- }
- case wxCURSOR_MIDDLE_BUTTON:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
- break;
- }
- case wxCURSOR_SIZING:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_SIZING"));
- break;
- }
- case wxCURSOR_WATCH:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_WATCH"));
- break;
- }
- case wxCURSOR_SPRAYCAN:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_ROLLER"));
- break;
- }
- case wxCURSOR_PAINT_BRUSH:
- {
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_PBRUSH"));
- break;
- }
- case wxCURSOR_POINT_LEFT:
+ // is this a standard Windows cursor?
+ bool isStd;
+
+ // the cursor name or id
+ LPCTSTR name;
+ } stdCursors[] =
{
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_PLEFT"));
- break;
- }
- case wxCURSOR_POINT_RIGHT:
+ { 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
+
+ // Displays as an I-beam on XP, so use a cursor file
+// { true, IDC_CROSS }, // WXCURSOR_CROSS
+ { false, _T("WXCURSOR_CROSS") }, // WXCURSOR_CROSS
+
+ // See special handling below for wxCURSOR_HAND
+// { false, _T("WXCURSOR_HAND") }, // wxCURSOR_HAND
+ { true, IDC_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_PBRUSH") }, // wxCURSOR_PAINT_BRUSH
+ { false, _T("WXCURSOR_PENCIL") }, // wxCURSOR_PENCIL
+ { false, _T("WXCURSOR_PLEFT") }, // wxCURSOR_POINT_LEFT
+ { false, _T("WXCURSOR_PRIGHT") }, // 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_PBRUSH") }, // 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];
+ bool deleteLater = !stdCursor.isStd;
+
+ HCURSOR hcursor = ::LoadCursor(stdCursor.isStd ? NULL : wxGetInstance(),
+ stdCursor.name);
+
+ // IDC_HAND may not be available on some versions of Windows.
+ if ( !hcursor && idCursor == wxCURSOR_HAND)
{
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_PRIGHT"));
- break;
+ hcursor = ::LoadCursor(wxGetInstance(), _T("WXCURSOR_HAND"));
+ deleteLater = true;
}
- case wxCURSOR_QUESTION_ARROW:
+
+ if ( !hcursor )
{
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_QARROW"));
- break;
+ wxLogLastError(_T("LoadCursor"));
}
- case wxCURSOR_BLANK:
+ else
{
- refData->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), wxT("wxCURSOR_BLANK"));
- break;
+ m_refData = new wxCursorRefData(hcursor, deleteLater);
}
- default:
- case wxCURSOR_ARROW:
- refData->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW);
- break;
- }
}
+#endif // __WXMICROWIN__/!__WXMICROWIN__
+
wxCursor::~wxCursor()
{
}
+// ----------------------------------------------------------------------------
+// other wxCursor functions
+// ----------------------------------------------------------------------------
+
+bool wxCursor::operator==(const wxCursor& cursor) const
+{
+ if ( !m_refData )
+ return !cursor.m_refData;
+
+ return cursor.m_refData &&
+ ((wxCursorRefData *)m_refData)->m_hCursor ==
+ ((wxCursorRefData *)cursor.m_refData)->m_hCursor;
+}
+
+wxGDIImageRefData *wxCursor::CreateData() const
+{
+ return new wxCursorRefData;
+}
+
// ----------------------------------------------------------------------------
// Global cursor setting
// ----------------------------------------------------------------------------