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