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