src/msw/cursor.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/cursor.cpp
   3 // Purpose:     wxCursor class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1997-2003 Julian Smart and Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #include "wx/cursor.h"
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/utils.h"
  31     #include "wx/app.h"
  32     #include "wx/bitmap.h"
  33     #include "wx/icon.h"
  34     #include "wx/settings.h"
  35     #include "wx/intl.h"
  36     #include "wx/image.h"
  37     #include "wx/module.h"
  38 #endif
  39
  40 #include "wx/msw/private.h"
  41 #include "wx/msw/missing.h" // IDC_HAND
  42
  43 // define functions missing in MicroWin
  44 #ifdef __WXMICROWIN__
  45     static inline void DestroyCursor(HCURSOR) { }
  46     static inline void SetCursor(HCURSOR) { }
  47 #endif // __WXMICROWIN__
  48
  49 // ----------------------------------------------------------------------------
  50 // private classes
  51 // ----------------------------------------------------------------------------
  52
  53 class WXDLLEXPORT wxCursorRefData : public wxGDIImageRefData
  54 {
  55 public:
  56     // the second parameter is used to tell us to delete the cursor when we're
  57     // done with it (normally we shouldn't call DestroyCursor() this is why it
  58     // doesn't happen by default)
  59     wxCursorRefData(HCURSOR hcursor = 0, bool takeOwnership = false);
  60
  61     virtual ~wxCursorRefData() { Free(); }
  62
  63     virtual void Free();
  64
  65
  66     // return the size of the standard cursor: notice that the system only
  67     // supports the cursors of this size
  68     static wxCoord GetStandardWidth();
  69     static wxCoord GetStandardHeight();
  70
  71 private:
  72     bool m_destroyCursor;
  73
  74     // standard cursor size, computed on first use
  75     static wxSize ms_sizeStd;
  76 };
  77
  78 // ----------------------------------------------------------------------------
  79 // wxWin macros
  80 // ----------------------------------------------------------------------------
  81
  82 IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxGDIObject)
  83
  84 // ----------------------------------------------------------------------------
  85 // globals
  86 // ----------------------------------------------------------------------------
  87
  88 // Current cursor, in order to hang on to cursor handle when setting the cursor
  89 // globally
  90 static wxCursor *gs_globalCursor = NULL;
  91
  92 // ----------------------------------------------------------------------------
  93 // private classes
  94 // ----------------------------------------------------------------------------
  95
  96 class wxCursorModule : public wxModule
  97 {
  98 public:
  99     virtual bool OnInit()
 100     {
 101         gs_globalCursor = new wxCursor;
 102
 103         return true;
 104     }
 105
 106     virtual void OnExit()
 107     {
 108         delete gs_globalCursor;
 109         gs_globalCursor = NULL;
 110     }
 111 };
 112
 113 // ============================================================================
 114 // implementation
 115 // ============================================================================
 116
 117 // ----------------------------------------------------------------------------
 118 // wxCursorRefData
 119 // ----------------------------------------------------------------------------
 120
 121 wxSize wxCursorRefData::ms_sizeStd;
 122
 123 wxCoord wxCursorRefData::GetStandardWidth()
 124 {
 125     if ( !ms_sizeStd.x )
 126         ms_sizeStd.x = wxSystemSettings::GetMetric(wxSYS_CURSOR_X);
 127
 128     return ms_sizeStd.x;
 129 }
 130
 131 wxCoord wxCursorRefData::GetStandardHeight()
 132 {
 133     if ( !ms_sizeStd.y )
 134         ms_sizeStd.y = wxSystemSettings::GetMetric(wxSYS_CURSOR_Y);
 135
 136     return ms_sizeStd.y;
 137 }
 138
 139 wxCursorRefData::wxCursorRefData(HCURSOR hcursor, bool destroy)
 140 {
 141     m_hCursor = (WXHCURSOR)hcursor;
 142
 143     if ( m_hCursor )
 144     {
 145         m_width = GetStandardWidth();
 146         m_height = GetStandardHeight();
 147     }
 148
 149     m_destroyCursor = destroy;
 150 }
 151
 152 void wxCursorRefData::Free()
 153 {
 154     if ( m_hCursor )
 155     {
 156 #ifndef __WXWINCE__
 157         if ( m_destroyCursor )
 158             ::DestroyCursor((HCURSOR)m_hCursor);
 159 #endif
 160
 161         m_hCursor = 0;
 162     }
 163 }
 164
 165 // ----------------------------------------------------------------------------
 166 // Cursors
 167 // ----------------------------------------------------------------------------
 168
 169 wxCursor::wxCursor()
 170 {
 171 }
 172
 173 #if wxUSE_IMAGE
 174 wxCursor::wxCursor(const wxImage& image)
 175 {
 176     // image has to be of the standard cursor size, otherwise we won't be able
 177     // to create it
 178     const int w = wxCursorRefData::GetStandardWidth();
 179     const int h = wxCursorRefData::GetStandardHeight();
 180
 181     int hotSpotX = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
 182     int hotSpotY = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
 183     int image_w = image.GetWidth();
 184     int image_h = image.GetHeight();
 185
 186     wxASSERT_MSG( hotSpotX >= 0 && hotSpotX < image_w &&
 187                   hotSpotY >= 0 && hotSpotY < image_h,
 188                   wxT("invalid cursor hot spot coordinates") );
 189
 190     wxImage imageSized(image); // final image of correct size
 191
 192     // if image is too small then place it in the center, resize it if too big
 193     if ((w > image_w) && (h > image_h))
 194     {
 195         wxPoint offset((w - image_w)/2, (h - image_h)/2);
 196         hotSpotX = hotSpotX + offset.x;
 197         hotSpotY = hotSpotY + offset.y;
 198
 199         imageSized = image.Size(wxSize(w, h), offset);
 200     }
 201     else if ((w != image_w) || (h != image_h))
 202     {
 203         hotSpotX = int(hotSpotX * double(w) / double(image_w));
 204         hotSpotY = int(hotSpotY * double(h) / double(image_h));
 205
 206         imageSized = image.Scale(w, h);
 207     }
 208
 209     HCURSOR hcursor = wxBitmapToHCURSOR( wxBitmap(imageSized),
 210                                          hotSpotX, hotSpotY );
 211
 212     if ( !hcursor )
 213     {
 214         wxLogWarning(_("Failed to create cursor."));
 215         return;
 216     }
 217
 218     m_refData = new wxCursorRefData(hcursor, true /* delete it later */);
 219 }
 220 #endif // wxUSE_IMAGE
 221
 222 // MicroWin doesn't have support needed for the other ctors
 223 #ifdef __WXMICROWIN__
 224
 225 wxCursor::InitFromStock(wxStockCursor WXUNUSED(cursor_type))
 226 {
 227 }
 228
 229 #else // !__WXMICROWIN__
 230
 231 wxCursor::wxCursor(const wxString& filename,
 232                    wxBitmapType kind,
 233                    int hotSpotX,
 234                    int hotSpotY)
 235 {
 236     HCURSOR hcursor;
 237     switch ( kind )
 238     {
 239         case wxBITMAP_TYPE_CUR_RESOURCE:
 240             hcursor = ::LoadCursor(wxGetInstance(), filename.fn_str());
 241             break;
 242
 243 #ifndef __WXWINCE__
 244         case wxBITMAP_TYPE_CUR:
 245             hcursor = ::LoadCursorFromFile(filename.fn_str());
 246             break;
 247 #endif
 248
 249         case wxBITMAP_TYPE_ICO:
 250             hcursor = wxBitmapToHCURSOR
 251                       (
 252                        wxIcon(filename, wxBITMAP_TYPE_ICO),
 253                        hotSpotX,
 254                        hotSpotY
 255                       );
 256             break;
 257
 258         case wxBITMAP_TYPE_BMP:
 259             hcursor = wxBitmapToHCURSOR
 260                       (
 261                        wxBitmap(filename, wxBITMAP_TYPE_BMP),
 262                        hotSpotX,
 263                        hotSpotY
 264                       );
 265             break;
 266
 267         default:
 268             wxLogError( wxT("unknown cursor resource type '%d'"), kind );
 269
 270             hcursor = NULL;
 271     }
 272
 273     if ( hcursor )
 274     {
 275         m_refData = new wxCursorRefData(hcursor, true /* delete it later */);
 276     }
 277 }
 278
 279 // Cursors by stock number
 280 void wxCursor::InitFromStock(wxStockCursor idCursor)
 281 {
 282     // all wxWidgets standard cursors
 283     static const struct StdCursor
 284     {
 285         // is this a standard Windows cursor?
 286         bool isStd;
 287
 288         // the cursor name or id
 289         LPCTSTR name;
 290     } stdCursors[] =
 291     {
 292         {  true, NULL                        }, // wxCURSOR_NONE
 293         {  true, IDC_ARROW                   }, // wxCURSOR_ARROW
 294         { false, wxT("WXCURSOR_RIGHT_ARROW")  }, // wxCURSOR_RIGHT_ARROW
 295         { false, wxT("WXCURSOR_BULLSEYE")     }, // wxCURSOR_BULLSEYE
 296         {  true, IDC_ARROW                   }, // WXCURSOR_CHAR
 297
 298         // Displays as an I-beam on XP, so use a cursor file
 299 //        {  true, IDC_CROSS                   }, // WXCURSOR_CROSS
 300         {  false, wxT("WXCURSOR_CROSS")       }, // WXCURSOR_CROSS
 301
 302         // See special handling below for wxCURSOR_HAND
 303 //        { false, wxT("WXCURSOR_HAND")         }, // wxCURSOR_HAND
 304         {  true, IDC_HAND                    }, // wxCURSOR_HAND
 305
 306         {  true, IDC_IBEAM                   }, // WXCURSOR_IBEAM
 307         {  true, IDC_ARROW                   }, // WXCURSOR_LEFT_BUTTON
 308         { false, wxT("WXCURSOR_MAGNIFIER")    }, // wxCURSOR_MAGNIFIER
 309         {  true, IDC_ARROW                   }, // WXCURSOR_MIDDLE_BUTTON
 310         {  true, IDC_NO                      }, // WXCURSOR_NO_ENTRY
 311         { false, wxT("WXCURSOR_PBRUSH")       }, // wxCURSOR_PAINT_BRUSH
 312         { false, wxT("WXCURSOR_PENCIL")       }, // wxCURSOR_PENCIL
 313         { false, wxT("WXCURSOR_PLEFT")        }, // wxCURSOR_POINT_LEFT
 314         { false, wxT("WXCURSOR_PRIGHT")       }, // wxCURSOR_POINT_RIGHT
 315         {  true, IDC_HELP                    }, // WXCURSOR_QUESTION_ARROW
 316         {  true, IDC_ARROW                   }, // WXCURSOR_RIGHT_BUTTON
 317         {  true, IDC_SIZENESW                }, // WXCURSOR_SIZENESW
 318         {  true, IDC_SIZENS                  }, // WXCURSOR_SIZENS
 319         {  true, IDC_SIZENWSE                }, // WXCURSOR_SIZENWSE
 320         {  true, IDC_SIZEWE                  }, // WXCURSOR_SIZEWE
 321         {  true, IDC_SIZEALL                 }, // WXCURSOR_SIZING
 322         { false, wxT("WXCURSOR_PBRUSH")       }, // wxCURSOR_SPRAYCAN
 323         {  true, IDC_WAIT                    }, // WXCURSOR_WAIT
 324         {  true, IDC_WAIT                    }, // WXCURSOR_WATCH
 325         { false, wxT("WXCURSOR_BLANK")        }, // wxCURSOR_BLANK
 326         {  true, IDC_APPSTARTING             }, // wxCURSOR_ARROWWAIT
 327
 328         // no entry for wxCURSOR_MAX
 329     };
 330
 331     wxCOMPILE_TIME_ASSERT( WXSIZEOF(stdCursors) == wxCURSOR_MAX,
 332                            CursorsIdArrayMismatch );
 333
 334     wxCHECK_RET( idCursor > 0 && (size_t)idCursor < WXSIZEOF(stdCursors),
 335                  wxT("invalid cursor id in wxCursor() ctor") );
 336
 337     const StdCursor& stdCursor = stdCursors[idCursor];
 338     bool deleteLater = !stdCursor.isStd;
 339
 340     HCURSOR hcursor = ::LoadCursor(stdCursor.isStd ? NULL : wxGetInstance(),
 341                                    stdCursor.name);
 342
 343     // IDC_HAND may not be available on some versions of Windows.
 344     if ( !hcursor && idCursor == wxCURSOR_HAND)
 345     {
 346         hcursor = ::LoadCursor(wxGetInstance(), wxT("WXCURSOR_HAND"));
 347         deleteLater = true;
 348     }
 349
 350     if ( !hcursor )
 351     {
 352         if ( !stdCursor.isStd )
 353         {
 354             // it may be not obvious to the programmer why did loading fail,
 355             // try to help by pointing to the by far the most probable reason
 356             wxFAIL_MSG(wxT("Loading a cursor defined by wxWidgets failed, ")
 357                        wxT("did you include include/wx/msw/wx.rc file from ")
 358                        wxT("your resource file?"));
 359         }
 360
 361         wxLogLastError(wxT("LoadCursor"));
 362     }
 363     else
 364     {
 365         m_refData = new wxCursorRefData(hcursor, deleteLater);
 366     }
 367 }
 368
 369 #endif // __WXMICROWIN__/!__WXMICROWIN__
 370
 371 wxCursor::~wxCursor()
 372 {
 373 }
 374
 375 // ----------------------------------------------------------------------------
 376 // other wxCursor functions
 377 // ----------------------------------------------------------------------------
 378
 379 wxGDIImageRefData *wxCursor::CreateData() const
 380 {
 381     return new wxCursorRefData;
 382 }
 383
 384 // ----------------------------------------------------------------------------
 385 // Global cursor setting
 386 // ----------------------------------------------------------------------------
 387
 388 const wxCursor *wxGetGlobalCursor()
 389 {
 390     return gs_globalCursor;
 391 }
 392
 393 void wxSetCursor(const wxCursor& cursor)
 394 {
 395     if ( cursor.Ok() )
 396     {
 397         ::SetCursor(GetHcursorOf(cursor));
 398
 399         if ( gs_globalCursor )
 400             *gs_globalCursor = cursor;
 401     }
 402 }