X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6bf57206813a18bf720815c9708a665471394173..b404a8f3b072129c107c6d9a5e0f6f53cd34807b:/src/msw/cursor.cpp diff --git a/src/msw/cursor.cpp b/src/msw/cursor.cpp index fdbcc955b8..74f57dcf52 100644 --- a/src/msw/cursor.cpp +++ b/src/msw/cursor.cpp @@ -1,277 +1,401 @@ ///////////////////////////////////////////////////////////////////////////// -// 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" -#endif +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -#ifndef WX_PRECOMP -#include -#include "wx/setup.h" -#include "wx/list.h" -#include "wx/utils.h" -#include "wx/app.h" #include "wx/cursor.h" + +#ifndef WX_PRECOMP + #include "wx/utils.h" + #include "wx/app.h" + #include "wx/bitmap.h" + #include "wx/icon.h" + #include "wx/settings.h" + #include "wx/intl.h" + #include "wx/image.h" + #include "wx/module.h" #endif #include "wx/msw/private.h" -#include "wx/msw/dib.h" +#include "wx/msw/missing.h" // IDC_HAND -#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 +// ---------------------------------------------------------------------------- -wxCursorRefData::wxCursorRefData(void) +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; + +// ---------------------------------------------------------------------------- +// 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() + { + wxDELETE(gs_globalCursor); + } +}; + +// ============================================================================ +// implementation +// ============================================================================ + +// ---------------------------------------------------------------------------- +// wxCursorRefData +// ---------------------------------------------------------------------------- + +wxSize wxCursorRefData::ms_sizeStd; -wxCursorRefData::~wxCursorRefData(void) +wxCoord wxCursorRefData::GetStandardWidth() { - if ( m_hCursor && m_destroyCursor) - ::DestroyCursor((HICON) m_hCursor); + 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((char *)(const char *)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((char *)(const char *)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((char *)(const char *)cursor_file, &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(), "wxCURSOR_HAND"); - break; - } - case wxCURSOR_BULLSEYE: - { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_BULLSEYE"); - break; - } - case wxCURSOR_PENCIL: - { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_PENCIL"); - break; - } - case wxCURSOR_MAGNIFIER: - { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_MAGNIFIER"); - break; - } - case wxCURSOR_NO_ENTRY: - { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_NO_ENTRY"); - break; - } - case wxCURSOR_LEFT_BUTTON: - { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW); - break; - } - case wxCURSOR_RIGHT_BUTTON: +} + +#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, + wxT("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)) { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW); - break; + 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); } - case wxCURSOR_MIDDLE_BUTTON: + else if ((w != image_w) || (h != image_h)) { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor((HINSTANCE) NULL, IDC_ARROW); - break; + hotSpotX = int(hotSpotX * double(w) / double(image_w)); + hotSpotY = int(hotSpotY * double(h) / double(image_h)); + + imageSized = image.Scale(w, h); } - case wxCURSOR_SIZING: + + HCURSOR hcursor = wxBitmapToHCURSOR( wxBitmap(imageSized), + hotSpotX, hotSpotY ); + + if ( !hcursor ) { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_SIZING"); - break; + wxLogWarning(_("Failed to create cursor.")); + return; } - case wxCURSOR_WATCH: + + m_refData = new wxCursorRefData(hcursor, true /* delete it later */); +} +#endif // wxUSE_IMAGE + +// MicroWin doesn't have support needed for the other ctors +#ifdef __WXMICROWIN__ + +wxCursor::InitFromStock(wxStockCursor WXUNUSED(cursor_type)) +{ +} + +#else // !__WXMICROWIN__ + +wxCursor::wxCursor(const wxString& filename, + wxBitmapType kind, + int hotSpotX, + int hotSpotY) +{ + HCURSOR hcursor; + switch ( kind ) { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_WATCH"); - break; + case wxBITMAP_TYPE_CUR_RESOURCE: + hcursor = ::LoadCursor(wxGetInstance(), filename.t_str()); + break; + +#ifndef __WXWINCE__ + case wxBITMAP_TYPE_CUR: + hcursor = ::LoadCursorFromFile(filename.t_str()); + 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: + wxLogError( wxT("unknown cursor resource type '%d'"), kind ); + + hcursor = NULL; } - case wxCURSOR_SPRAYCAN: + + if ( hcursor ) { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_ROLLER"); - break; + m_refData = new wxCursorRefData(hcursor, true /* delete it later */); } - case wxCURSOR_PAINT_BRUSH: +} + +// Cursors by stock number +void wxCursor::InitFromStock(wxStockCursor idCursor) +{ + // all wxWidgets standard cursors + static const struct StdCursor { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_PBRUSH"); - break; - } - case wxCURSOR_POINT_LEFT: + // is this a standard Windows cursor? + bool isStd; + + // the cursor name or id + LPCTSTR name; + } stdCursors[] = { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_PLEFT"); - break; - } - case wxCURSOR_POINT_RIGHT: + { true, NULL }, // wxCURSOR_NONE + { true, IDC_ARROW }, // wxCURSOR_ARROW + { false, wxT("WXCURSOR_RIGHT_ARROW") }, // wxCURSOR_RIGHT_ARROW + { false, wxT("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, wxT("WXCURSOR_CROSS") }, // WXCURSOR_CROSS + + // See special handling below for wxCURSOR_HAND +// { false, wxT("WXCURSOR_HAND") }, // wxCURSOR_HAND + { true, IDC_HAND }, // wxCURSOR_HAND + + { true, IDC_IBEAM }, // WXCURSOR_IBEAM + { true, IDC_ARROW }, // WXCURSOR_LEFT_BUTTON + { false, wxT("WXCURSOR_MAGNIFIER") }, // wxCURSOR_MAGNIFIER + { true, IDC_ARROW }, // WXCURSOR_MIDDLE_BUTTON + { true, IDC_NO }, // WXCURSOR_NO_ENTRY + { false, wxT("WXCURSOR_PBRUSH") }, // wxCURSOR_PAINT_BRUSH + { false, wxT("WXCURSOR_PENCIL") }, // wxCURSOR_PENCIL + { false, wxT("WXCURSOR_PLEFT") }, // wxCURSOR_POINT_LEFT + { false, wxT("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, wxT("WXCURSOR_PBRUSH") }, // wxCURSOR_SPRAYCAN + { true, IDC_WAIT }, // WXCURSOR_WAIT + { true, IDC_WAIT }, // WXCURSOR_WATCH + { false, wxT("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), + wxT("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) { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_PRIGHT"); - break; + hcursor = ::LoadCursor(wxGetInstance(), wxT("WXCURSOR_HAND")); + deleteLater = true; } - case wxCURSOR_QUESTION_ARROW: + + if ( !hcursor ) { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_QARROW"); - break; + if ( !stdCursor.isStd ) + { + // it may be not obvious to the programmer why did loading fail, + // try to help by pointing to the by far the most probable reason + wxFAIL_MSG(wxT("Loading a cursor defined by wxWidgets failed, ") + wxT("did you include include/wx/msw/wx.rc file from ") + wxT("your resource file?")); + } + + wxLogLastError(wxT("LoadCursor")); } - case wxCURSOR_BLANK: + else { - M_CURSORDATA->m_hCursor = (WXHCURSOR) LoadCursor(wxGetInstance(), "wxCURSOR_BLANK"); - break; + m_refData = new wxCursorRefData(hcursor, deleteLater); } - 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 +// ---------------------------------------------------------------------------- + +wxGDIImageRefData *wxCursor::CreateData() 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; + return new wxCursorRefData; } -void wxCursor::SetHCURSOR(WXHCURSOR cursor) -{ - if ( !M_CURSORDATA ) - m_refData = new wxCursorRefData; +// ---------------------------------------------------------------------------- +// Global cursor setting +// ---------------------------------------------------------------------------- - M_CURSORDATA->m_hCursor = cursor; +const wxCursor *wxGetGlobalCursor() +{ + return gs_globalCursor; } -// Global cursor setting void wxSetCursor(const wxCursor& cursor) { - extern wxCursor *g_globalCursor; - - if ( cursor.Ok() && cursor.GetHCURSOR() ) + if ( cursor.IsOk() ) { - ::SetCursor((HCURSOR) cursor.GetHCURSOR()); + ::SetCursor(GetHcursorOf(cursor)); - if ( g_globalCursor ) - (*g_globalCursor) = cursor; + if ( gs_globalCursor ) + *gs_globalCursor = cursor; } } - -