]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/private.h
another wxUSE_DRAG_AND_DROP==0 compilation fix
[wxWidgets.git] / include / wx / msw / private.h
CommitLineData
2bda0e17 1/////////////////////////////////////////////////////////////////////////////
c0089c96 2// Name: wx/msw/private.h
a23fd0e1 3// Purpose: Private declarations: as this header is only included by
77ffb593 4// wxWidgets itself, it may contain identifiers which don't start
a23fd0e1 5// with "wx".
2bda0e17
KB
6// Author: Julian Smart
7// Modified by:
8// Created: 01/02/97
9// RCS-ID: $Id$
bbcdf8bc 10// Copyright: (c) Julian Smart
65571936 11// Licence: wxWindows licence
2bda0e17
KB
12/////////////////////////////////////////////////////////////////////////////
13
bbcdf8bc
JS
14#ifndef _WX_PRIVATE_H_
15#define _WX_PRIVATE_H_
2bda0e17 16
9ed0d735 17#include "wx/msw/wrapwin.h"
2bda0e17 18
04ef50df 19#ifdef __WXMICROWIN__
b225f659
VZ
20 // Extra prototypes and symbols not defined by MicroWindows
21 #include "wx/msw/microwin.h"
04ef50df
JS
22#endif
23
3a922bb4
RL
24#include "wx/log.h"
25
d66d0500
VZ
26#if wxUSE_GUI
27 #include "wx/window.h"
28#endif // wxUSE_GUI
29
b5dbe15d
VS
30class WXDLLIMPEXP_FWD_CORE wxFont;
31class WXDLLIMPEXP_FWD_CORE wxWindow;
32class WXDLLIMPEXP_FWD_CORE wxWindowBase;
2bda0e17 33
42e69d6b
VZ
34// ---------------------------------------------------------------------------
35// private constants
36// ---------------------------------------------------------------------------
37
77d8d6cd
VZ
38// 260 was taken from windef.h
39#ifndef MAX_PATH
40 #define MAX_PATH 260
41#endif
42
a23fd0e1
VZ
43// ---------------------------------------------------------------------------
44// standard icons from the resources
45// ---------------------------------------------------------------------------
2bda0e17 46
b568d04f
VZ
47#if wxUSE_GUI
48
53a2db12
FM
49extern WXDLLIMPEXP_DATA_CORE(HICON) wxSTD_FRAME_ICON;
50extern WXDLLIMPEXP_DATA_CORE(HICON) wxSTD_MDIPARENTFRAME_ICON;
51extern WXDLLIMPEXP_DATA_CORE(HICON) wxSTD_MDICHILDFRAME_ICON;
52extern WXDLLIMPEXP_DATA_CORE(HICON) wxDEFAULT_FRAME_ICON;
53extern WXDLLIMPEXP_DATA_CORE(HICON) wxDEFAULT_MDIPARENTFRAME_ICON;
54extern WXDLLIMPEXP_DATA_CORE(HICON) wxDEFAULT_MDICHILDFRAME_ICON;
55extern WXDLLIMPEXP_DATA_CORE(HFONT) wxSTATUS_LINE_FONT;
2bda0e17 56
b568d04f
VZ
57#endif // wxUSE_GUI
58
77ec05d4
VZ
59// ---------------------------------------------------------------------------
60// global data
61// ---------------------------------------------------------------------------
62
63extern WXDLLIMPEXP_DATA_BASE(HINSTANCE) wxhInstance;
64
a23fd0e1 65// ---------------------------------------------------------------------------
11c7d5b6 66// define things missing from some compilers' headers
a23fd0e1 67// ---------------------------------------------------------------------------
c455ab93 68
7f0586ef 69#if defined(__WXWINCE__) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
01dba85a 70#ifndef ZeroMemory
11c7d5b6 71 inline void ZeroMemory(void *buf, size_t len) { memset(buf, 0, len); }
01dba85a 72#endif
11c7d5b6
VZ
73#endif // old mingw32
74
75// this defines a CASTWNDPROC macro which casts a pointer to the type of a
76// window proc
7f0586ef 77#if defined(STRICT) || defined(__GNUC__)
ebb0781f 78 typedef WNDPROC WndProcCast;
c3b177ae 79#else
ebb0781f
VZ
80 typedef FARPROC WndProcCast;
81#endif
82
552a0ebd 83
ebb0781f 84#define CASTWNDPROC (WndProcCast)
2bda0e17 85
dd54f5d3 86
50165591 87
a23fd0e1
VZ
88// ---------------------------------------------------------------------------
89// some stuff for old Windows versions (FIXME: what does it do here??)
90// ---------------------------------------------------------------------------
91
c085e333 92#if !defined(APIENTRY) // NT defines APIENTRY, 3.x not
a23fd0e1 93 #define APIENTRY FAR PASCAL
2bda0e17 94#endif
c085e333 95
2bda0e17 96#ifdef __WIN32__
a23fd0e1 97 #define _EXPORT
2bda0e17 98#else
a23fd0e1
VZ
99 #define _EXPORT _export
100#endif
101
102#ifndef __WIN32__
103 typedef signed short int SHORT;
2bda0e17 104#endif
c085e333
VZ
105
106#if !defined(__WIN32__) // 3.x uses FARPROC for dialogs
27a9bd48 107#ifndef STRICT
a23fd0e1 108 #define DLGPROC FARPROC
2bda0e17 109#endif
27a9bd48 110#endif
2bda0e17 111
2bda0e17
KB
112/*
113 * Decide what window classes we're going to use
114 * for this combination of CTl3D/FAFA settings
115 */
c085e333 116
223d09f6 117#define STATIC_CLASS wxT("STATIC")
2bda0e17 118#define STATIC_FLAGS (SS_LEFT|WS_CHILD|WS_VISIBLE)
223d09f6 119#define CHECK_CLASS wxT("BUTTON")
2bda0e17 120#define CHECK_FLAGS (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
078cf5cb 121#define CHECK_IS_FAFA FALSE
223d09f6 122#define RADIO_CLASS wxT("BUTTON")
2bda0e17
KB
123#define RADIO_FLAGS (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
124#define RADIO_SIZE 20
078cf5cb 125#define RADIO_IS_FAFA FALSE
2bda0e17 126#define PURE_WINDOWS
223d09f6 127#define GROUP_CLASS wxT("BUTTON")
2bda0e17
KB
128#define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
129
130/*
131#define BITCHECK_FLAGS (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
132#define BITRADIO_FLAGS (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
133*/
134
a23fd0e1
VZ
135// ---------------------------------------------------------------------------
136// misc macros
137// ---------------------------------------------------------------------------
138
2bda0e17 139#define MEANING_CHARACTER '0'
5d368213 140#define DEFAULT_ITEM_WIDTH 100
2bda0e17 141#define DEFAULT_ITEM_HEIGHT 80
1c4a764c
VZ
142
143// Scale font to get edit control height
f6bcfd97
BP
144//#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (3*(cy)/2)
145#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (cy+8)
2bda0e17
KB
146
147// Generic subclass proc, for panel item moving/sizing and intercept
148// EDIT control VK_RETURN messages
149extern LONG APIENTRY _EXPORT
150 wxSubclassedGenericControlProc(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
151
11c7d5b6
VZ
152// ---------------------------------------------------------------------------
153// useful macros and functions
154// ---------------------------------------------------------------------------
155
156// a wrapper macro for ZeroMemory()
04ef50df 157#if defined(__WIN32__) && !defined(__WXMICROWIN__)
11c7d5b6 158#define wxZeroMemory(obj) ::ZeroMemory(&obj, sizeof(obj))
0e528b99
JS
159#else
160#define wxZeroMemory(obj) memset((void*) & obj, 0, sizeof(obj))
161#endif
11c7d5b6 162
18a1516c
MW
163// This one is a macro so that it can be tested with #ifdef, it will be
164// undefined if it cannot be implemented for a given compiler.
165// Vc++, bcc, dmc, ow, mingw, codewarrior (and rsxnt) have _get_osfhandle.
166// Cygwin has get_osfhandle. Others are currently unknown, e.g. Salford,
167// Intel, Visual Age.
168#if defined(__WXWINCE__)
169 #define wxGetOSFHandle(fd) ((HANDLE)fd)
7d45ec4a 170 #define wxOpenOSFHandle(h, flags) ((int)wxPtrToUInt(h))
18a1516c
MW
171#elif defined(__CYGWIN__)
172 #define wxGetOSFHandle(fd) ((HANDLE)get_osfhandle(fd))
173#elif defined(__VISUALC__) \
174 || defined(__BORLANDC__) \
18a1516c 175 || defined(__DMC__) \
74fe6751 176 || defined(__WATCOMC__) \
8df9a8a0 177 || defined(__MINGW32__) \
18a1516c
MW
178 || (defined(__MWERKS__) && defined(__MSL__))
179 #define wxGetOSFHandle(fd) ((HANDLE)_get_osfhandle(fd))
7d45ec4a
MW
180 #define wxOpenOSFHandle(h, flags) (_open_osfhandle(wxPtrToUInt(h), flags))
181 #define wx_fdopen _fdopen
18a1516c
MW
182#endif
183
0cdd4e19
VZ
184// close the handle in the class dtor
185class AutoHANDLE
186{
187public:
188 wxEXPLICIT AutoHANDLE(HANDLE handle) : m_handle(handle) { }
189
190 bool IsOk() const { return m_handle != INVALID_HANDLE_VALUE; }
191 operator HANDLE() const { return m_handle; }
192
193 ~AutoHANDLE() { if ( IsOk() ) ::CloseHandle(m_handle); }
194
195protected:
196 HANDLE m_handle;
197};
198
d1e4a818
VZ
199// a template to make initializing Windows styructs less painful: it zeroes all
200// the struct fields and also sets cbSize member to the correct value (and so
201// can be only used with structures which have this member...)
202template <class T>
203struct WinStruct : public T
204{
205 WinStruct()
206 {
207 ::ZeroMemory(this, sizeof(T));
208
209 // explicit qualification is required here for this to be valid C++
210 this->cbSize = sizeof(T);
211 }
212};
213
214
f6bcfd97
BP
215#if wxUSE_GUI
216
c0089c96
WS
217#include "wx/gdicmn.h"
218#include "wx/colour.h"
01dba85a 219
11c7d5b6
VZ
220// make conversion from wxColour and COLORREF a bit less painful
221inline COLORREF wxColourToRGB(const wxColour& c)
4ab861e5
VZ
222{
223 return RGB(c.Red(), c.Green(), c.Blue());
224}
225
226inline COLORREF wxColourToPalRGB(const wxColour& c)
11c7d5b6 227{
19193a2c 228 return PALETTERGB(c.Red(), c.Green(), c.Blue());
11c7d5b6
VZ
229}
230
d23c8ba2
VZ
231inline wxColour wxRGBToColour(COLORREF rgb)
232{
233 return wxColour(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
234}
235
11c7d5b6
VZ
236inline void wxRGBToColour(wxColour& c, COLORREF rgb)
237{
238 c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
239}
240
90c1530a
VZ
241// get the standard colour map for some standard colours - see comment in this
242// function to understand why is it needed and when should it be used
243//
244// it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
245// might be not included/available) array of size wxSTD_COLOUR_MAX
246//
247// NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
248// resources as well: it must have the same number of pixels!
249enum wxSTD_COLOUR
250{
251 wxSTD_COL_BTNTEXT,
252 wxSTD_COL_BTNSHADOW,
253 wxSTD_COL_BTNFACE,
254 wxSTD_COL_BTNHIGHLIGHT,
57e075e9 255 wxSTD_COL_MAX
90c1530a
VZ
256};
257
53a2db12 258struct WXDLLIMPEXP_CORE wxCOLORMAP
90c1530a
VZ
259{
260 COLORREF from, to;
261};
262
263// this function is implemented in src/msw/window.cpp
264extern wxCOLORMAP *wxGetStdColourMap();
265
9688700c 266// create a wxRect from Windows RECT
8704b366 267inline wxRect wxRectFromRECT(const RECT& rc)
9688700c 268{
8704b366 269 return wxRect(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
9688700c
VZ
270}
271
ed791986 272// copy Windows RECT to our wxRect
8704b366 273inline void wxCopyRECTToRect(const RECT& rc, wxRect& rect)
ed791986 274{
8704b366
VZ
275 rect = wxRectFromRECT(rc);
276}
277
278// and vice versa
279inline void wxCopyRectToRECT(const wxRect& rect, RECT& rc)
280{
281 // note that we don't use wxRect::GetRight() as it is one of compared to
282 // wxRectFromRECT() above
283 rc.top = rect.y;
284 rc.left = rect.x;
285 rc.right = rect.x + rect.width;
286 rc.bottom = rect.y + rect.height;
ed791986
VZ
287}
288
d9317fd4
VZ
289// translations between HIMETRIC units (which OLE likes) and pixels (which are
290// liked by all the others) - implemented in msw/utilsexc.cpp
291extern void HIMETRICToPixel(LONG *x, LONG *y);
292extern void PixelToHIMETRIC(LONG *x, LONG *y);
293
77ffb593 294// Windows convention of the mask is opposed to the wxWidgets one, so we need
4b7f2165
VZ
295// to invert the mask each time we pass one/get one to/from Windows
296extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
297
211b54b1
VZ
298// Creates an icon or cursor depending from a bitmap
299//
300// The bitmap must be valid and it should have a mask. If it doesn't, a default
301// mask is created using light grey as the transparent colour.
302extern HICON wxBitmapToHICON(const wxBitmap& bmp);
303
304// Same requirments as above apply and the bitmap must also have the correct
305// size.
306extern
307HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY);
308
0a1f7784
VZ
309
310#if wxUSE_OWNER_DRAWN
311
312// Draw the bitmap in specified state (this is used by owner drawn controls)
313enum wxDSBStates
314{
315 wxDSB_NORMAL = 0,
316 wxDSB_SELECTED,
317 wxDSB_DISABLED
318};
319
320extern
321BOOL wxDrawStateBitmap(HDC hDC, HBITMAP hBitmap, int x, int y, UINT uState);
322
323#endif // wxUSE_OWNER_DRAWN
324
8614c467
VZ
325// get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
326// will fail on system with multiple monitors where the coords may be negative
327//
328// these macros are standard now (Win98) but some older headers don't have them
329#ifndef GET_X_LPARAM
330 #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
331 #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
332#endif // GET_X_LPARAM
333
6719c06a
VZ
334// get the current state of SHIFT/CTRL/ALT keys
335inline bool wxIsModifierDown(int vk)
a95e38c0 336{
6719c06a 337 // GetKeyState() returns different negative values on WinME and WinNT,
1fdf858b 338 // so simply test for negative value.
6719c06a
VZ
339 return ::GetKeyState(vk) < 0;
340}
341
342inline bool wxIsShiftDown()
343{
344 return wxIsModifierDown(VK_SHIFT);
a95e38c0
VZ
345}
346
1f80a703 347inline bool wxIsCtrlDown()
a95e38c0 348{
6719c06a
VZ
349 return wxIsModifierDown(VK_CONTROL);
350}
351
352inline bool wxIsAltDown()
353{
354 return wxIsModifierDown(VK_MENU);
355}
356
357inline bool wxIsAnyModifierDown()
358{
359 return wxIsShiftDown() || wxIsCtrlDown() || wxIsAltDown();
a95e38c0
VZ
360}
361
82c9f85c
VZ
362// wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
363// for Win32
364inline RECT wxGetWindowRect(HWND hwnd)
365{
366 RECT rect;
3a5bcc4d 367
82c9f85c 368 if ( !::GetWindowRect(hwnd, &rect) )
82c9f85c 369 wxLogLastError(_T("GetWindowRect"));
82c9f85c
VZ
370
371 return rect;
372}
373
374inline RECT wxGetClientRect(HWND hwnd)
375{
376 RECT rect;
3a5bcc4d 377
82c9f85c 378 if ( !::GetClientRect(hwnd, &rect) )
82c9f85c 379 wxLogLastError(_T("GetClientRect"));
82c9f85c
VZ
380
381 return rect;
382}
383
6d167489
VZ
384// ---------------------------------------------------------------------------
385// small helper classes
386// ---------------------------------------------------------------------------
387
388// create an instance of this class and use it as the HDC for screen, will
389// automatically release the DC going out of scope
390class ScreenHDC
391{
392public:
091225b4
VZ
393 ScreenHDC() { m_hdc = ::GetDC(NULL); }
394 ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
395
396 operator HDC() const { return m_hdc; }
397
398private:
399 HDC m_hdc;
22f3361e
VZ
400
401 DECLARE_NO_COPY_CLASS(ScreenHDC)
091225b4
VZ
402};
403
2ff56383
VZ
404// the same as ScreenHDC but for window DCs
405class WindowHDC
406{
407public:
408 WindowHDC(HWND hwnd) { m_hdc = ::GetDC(m_hwnd = hwnd); }
409 ~WindowHDC() { ::ReleaseDC(m_hwnd, m_hdc); }
410
411 operator HDC() const { return m_hdc; }
412
413private:
414 HWND m_hwnd;
415 HDC m_hdc;
416
417 DECLARE_NO_COPY_CLASS(WindowHDC)
418};
419
697b08a8
VZ
420// the same as ScreenHDC but for memory DCs: creates the HDC compatible with
421// the given one (screen by default) in ctor and destroys it in dtor
091225b4
VZ
422class MemoryHDC
423{
424public:
9cf743aa 425 MemoryHDC(HDC hdc = 0) { m_hdc = ::CreateCompatibleDC(hdc); }
697b08a8 426 ~MemoryHDC() { ::DeleteDC(m_hdc); }
091225b4
VZ
427
428 operator HDC() const { return m_hdc; }
6d167489
VZ
429
430private:
431 HDC m_hdc;
22f3361e
VZ
432
433 DECLARE_NO_COPY_CLASS(MemoryHDC)
6d167489
VZ
434};
435
091225b4
VZ
436// a class which selects a GDI object into a DC in its ctor and deselects in
437// dtor
438class SelectInHDC
439{
6969c2c3
VZ
440private:
441 void DoInit(HGDIOBJ hgdiobj) { m_hgdiobj = ::SelectObject(m_hdc, hgdiobj); }
442
091225b4 443public:
6969c2c3
VZ
444 SelectInHDC() : m_hdc(NULL) { }
445 SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc) { DoInit(hgdiobj); }
446
447 void Init(HDC hdc, HGDIOBJ hgdiobj)
448 {
449 wxASSERT_MSG( !m_hdc, _T("initializing twice?") );
450
451 m_hdc = hdc;
091225b4 452
6969c2c3
VZ
453 DoInit(hgdiobj);
454 }
091225b4 455
6969c2c3
VZ
456 ~SelectInHDC() { if ( m_hdc ) ::SelectObject(m_hdc, m_hgdiobj); }
457
458 // return true if the object was successfully selected
459 operator bool() const { return m_hgdiobj != 0; }
091225b4
VZ
460
461private:
6969c2c3
VZ
462 HDC m_hdc;
463 HGDIOBJ m_hgdiobj;
22f3361e 464
6969c2c3 465 DECLARE_NO_COPY_CLASS(SelectInHDC)
51a2a728
VZ
466};
467
a27cbf44
VZ
468// a class which cleans up any GDI object
469class AutoGDIObject
470{
471protected:
6969c2c3 472 AutoGDIObject() { m_gdiobj = NULL; }
a27cbf44
VZ
473 AutoGDIObject(HGDIOBJ gdiobj) : m_gdiobj(gdiobj) { }
474 ~AutoGDIObject() { if ( m_gdiobj ) ::DeleteObject(m_gdiobj); }
475
6969c2c3
VZ
476 void InitGdiobj(HGDIOBJ gdiobj)
477 {
478 wxASSERT_MSG( !m_gdiobj, _T("initializing twice?") );
479
480 m_gdiobj = gdiobj;
481 }
482
a27cbf44
VZ
483 HGDIOBJ GetObject() const { return m_gdiobj; }
484
485private:
486 HGDIOBJ m_gdiobj;
487};
488
cf831d8e
VZ
489// TODO: all this asks for using a AutoHandler<T, CreateFunc> template...
490
6969c2c3 491// a class for temporary brushes
cf831d8e
VZ
492class AutoHBRUSH : private AutoGDIObject
493{
494public:
495 AutoHBRUSH(COLORREF col)
496 : AutoGDIObject(::CreateSolidBrush(col)) { }
497
498 operator HBRUSH() const { return (HBRUSH)GetObject(); }
499};
500
6969c2c3
VZ
501// a class for temporary fonts
502class AutoHFONT : private AutoGDIObject
503{
504private:
505public:
506 AutoHFONT()
507 : AutoGDIObject() { }
508
509 AutoHFONT(const LOGFONT& lf)
510 : AutoGDIObject(::CreateFontIndirect(&lf)) { }
511
512 void Init(const LOGFONT& lf) { InitGdiobj(::CreateFontIndirect(&lf)); }
513
514 operator HFONT() const { return (HFONT)GetObject(); }
515};
516
cf831d8e
VZ
517// a class for temporary pens
518class AutoHPEN : private AutoGDIObject
519{
520public:
521 AutoHPEN(COLORREF col)
522 : AutoGDIObject(::CreatePen(PS_SOLID, 0, col)) { }
523
524 operator HPEN() const { return (HPEN)GetObject(); }
525};
526
527// classes for temporary bitmaps
528class AutoHBITMAP : private AutoGDIObject
529{
530public:
531 AutoHBITMAP(HBITMAP hbmp) : AutoGDIObject(hbmp) { }
532
533 operator HBITMAP() const { return (HBITMAP)GetObject(); }
534};
535
536class CompatibleBitmap : public AutoHBITMAP
978bb48f
VZ
537{
538public:
539 CompatibleBitmap(HDC hdc, int w, int h)
cf831d8e 540 : AutoHBITMAP(::CreateCompatibleBitmap(hdc, w, h))
978bb48f 541 {
978bb48f 542 }
cf831d8e 543};
978bb48f 544
cf831d8e
VZ
545class MonoBitmap : public AutoHBITMAP
546{
547public:
548 MonoBitmap(int w, int h)
549 : AutoHBITMAP(::CreateBitmap(w, h, 1, 1, 0))
550 {
551 }
a27cbf44 552};
978bb48f 553
a27cbf44
VZ
554// class automatically destroys the region object
555class AutoHRGN : private AutoGDIObject
556{
557public:
558 AutoHRGN(HRGN hrgn) : AutoGDIObject(hrgn) { }
978bb48f 559
a27cbf44 560 operator HRGN() const { return (HRGN)GetObject(); }
978bb48f
VZ
561};
562
a1372ae2
VZ
563// class sets the specified clipping region during its life time
564class HDCClipper
565{
566public:
567 HDCClipper(HDC hdc, HRGN hrgn)
568 : m_hdc(hdc)
569 {
570 if ( !::SelectClipRgn(hdc, hrgn) )
571 wxLogLastError(_T("SelectClipRgn"));
572 }
573
574 ~HDCClipper()
575 {
576 ::SelectClipRgn(m_hdc, NULL);
577 }
578
579private:
580 HDC m_hdc;
581
582 DECLARE_NO_COPY_CLASS(HDCClipper)
583};
584
566b7f7b
VZ
585// set the given map mode for the life time of this object
586//
587// NB: SetMapMode() is not supported by CE so we also define a helper macro
588// to avoid using it there
589#ifdef __WXWINCE__
590 #define wxCHANGE_HDC_MAP_MODE(hdc, mm)
591#else // !__WXWINCE__
592 class HDCMapModeChanger
593 {
594 public:
595 HDCMapModeChanger(HDC hdc, int mm)
596 : m_hdc(hdc)
597 {
598 m_modeOld = ::SetMapMode(hdc, mm);
599 if ( !m_modeOld )
600 wxLogLastError(_T("SelectClipRgn"));
601 }
602
603 ~HDCMapModeChanger()
604 {
605 if ( m_modeOld )
606 ::SetMapMode(m_hdc, m_modeOld);
607 }
608
609 private:
610 HDC m_hdc;
611 int m_modeOld;
612
613 DECLARE_NO_COPY_CLASS(HDCMapModeChanger)
614 };
615
616 #define wxCHANGE_HDC_MAP_MODE(hdc, mm) \
617 HDCMapModeChanger wxMAKE_UNIQUE_NAME(wxHDCMapModeChanger)(hdc, mm)
618#endif // __WXWINCE__/!__WXWINCE__
619
82d1a195 620// smart pointer using GlobalAlloc/GlobalFree()
2be57a51
VZ
621class GlobalPtr
622{
623public:
6fa6d659
VZ
624 // default ctor, call Init() later
625 GlobalPtr()
626 {
627 m_hGlobal = NULL;
628 }
629
2be57a51 630 // allocates a block of given size
6fa6d659 631 void Init(size_t size, unsigned flags = GMEM_MOVEABLE)
2be57a51
VZ
632 {
633 m_hGlobal = ::GlobalAlloc(flags, size);
634 if ( !m_hGlobal )
635 wxLogLastError(_T("GlobalAlloc"));
636 }
637
6fa6d659
VZ
638 GlobalPtr(size_t size, unsigned flags = GMEM_MOVEABLE)
639 {
640 Init(size, flags);
641 }
642
2be57a51
VZ
643 ~GlobalPtr()
644 {
645 if ( m_hGlobal && ::GlobalFree(m_hGlobal) )
646 wxLogLastError(_T("GlobalFree"));
647 }
648
649 // implicit conversion
650 operator HGLOBAL() const { return m_hGlobal; }
651
652private:
653 HGLOBAL m_hGlobal;
654
655 DECLARE_NO_COPY_CLASS(GlobalPtr)
656};
657
51a2a728
VZ
658// when working with global pointers (which is unfortunately still necessary
659// sometimes, e.g. for clipboard) it is important to unlock them exactly as
660// many times as we lock them which just asks for using a "smart lock" class
0645e2b9 661class GlobalPtrLock
51a2a728
VZ
662{
663public:
2d2b68ba
VZ
664 // default ctor, use Init() later -- should only be used if the HGLOBAL can
665 // be NULL (in which case Init() shouldn't be called)
666 GlobalPtrLock()
51a2a728 667 {
2d2b68ba
VZ
668 m_hGlobal = NULL;
669 m_ptr = NULL;
670 }
671
672 // initialize the object, may be only called if we were created using the
673 // default ctor; HGLOBAL must not be NULL
674 void Init(HGLOBAL hGlobal)
675 {
676 m_hGlobal = hGlobal;
82d1a195
VZ
677
678 // NB: GlobalLock() is a macro, not a function, hence don't use the
679 // global scope operator with it (and neither with GlobalUnlock())
680 m_ptr = GlobalLock(hGlobal);
51a2a728 681 if ( !m_ptr )
51a2a728 682 wxLogLastError(_T("GlobalLock"));
51a2a728
VZ
683 }
684
2d2b68ba
VZ
685 // initialize the object, HGLOBAL must not be NULL
686 GlobalPtrLock(HGLOBAL hGlobal)
687 {
688 Init(hGlobal);
689 }
690
0645e2b9 691 ~GlobalPtrLock()
51a2a728 692 {
82d1a195 693 if ( m_hGlobal && !GlobalUnlock(m_hGlobal) )
51a2a728
VZ
694 {
695#ifdef __WXDEBUG__
696 // this might happen simply because the block became unlocked
697 DWORD dwLastError = ::GetLastError();
698 if ( dwLastError != NO_ERROR )
699 {
700 wxLogApiError(_T("GlobalUnlock"), dwLastError);
701 }
702#endif // __WXDEBUG__
703 }
704 }
705
2d2b68ba 706 void *Get() const { return m_ptr; }
51a2a728
VZ
707 operator void *() const { return m_ptr; }
708
709private:
710 HGLOBAL m_hGlobal;
711 void *m_ptr;
712
0645e2b9 713 DECLARE_NO_COPY_CLASS(GlobalPtrLock)
091225b4
VZ
714};
715
77ec05d4
VZ
716// register the class when it is first needed and unregister it in dtor
717class ClassRegistrar
718{
719public:
720 // ctor doesn't register the class, call Initialize() for this
721 ClassRegistrar() { m_registered = -1; }
722
723 // return true if the class is already registered
724 bool IsInitialized() const { return m_registered != -1; }
725
726 // return true if the class had been already registered
727 bool IsRegistered() const { return m_registered == 1; }
728
729 // try to register the class if not done yet, return true on success
730 bool Register(const WNDCLASS& wc)
731 {
732 // we should only be called if we hadn't been initialized yet
733 wxASSERT_MSG( m_registered == -1,
734 _T("calling ClassRegistrar::Register() twice?") );
735
736 m_registered = ::RegisterClass(&wc) ? 1 : 0;
737 if ( !IsRegistered() )
738 {
739 wxLogLastError(_T("RegisterClassEx()"));
740 }
741 else
742 {
743 m_clsname = wc.lpszClassName;
744 }
745
746 return m_registered == 1;
747 }
748
749 // get the name of the registered class (returns empty string if not
750 // registered)
751 const wxString& GetName() const { return m_clsname; }
752
753 // unregister the class if it had been registered
754 ~ClassRegistrar()
755 {
756 if ( IsRegistered() )
757 {
e0a050e3 758 if ( !::UnregisterClass(m_clsname.wx_str(), wxhInstance) )
77ec05d4
VZ
759 {
760 wxLogLastError(_T("UnregisterClass"));
761 }
762 }
763 }
764
765private:
766 // initial value is -1 which means that we hadn't tried registering the
767 // class yet, it becomes true or false (1 or 0) when Initialize() is called
768 int m_registered;
769
770 // the name of the class, only non empty if it had been registered
771 wxString m_clsname;
772};
773
a23fd0e1 774// ---------------------------------------------------------------------------
42e69d6b 775// macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
c50f1fb9
VZ
776// returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
777// an argument which should be a pointer or reference to the object of the
778// corresponding class (this depends on the macro)
a23fd0e1
VZ
779// ---------------------------------------------------------------------------
780
781#define GetHwnd() ((HWND)GetHWND())
c50f1fb9
VZ
782#define GetHwndOf(win) ((HWND)((win)->GetHWND()))
783// old name
784#define GetWinHwnd GetHwndOf
a23fd0e1
VZ
785
786#define GetHdc() ((HDC)GetHDC())
c50f1fb9 787#define GetHdcOf(dc) ((HDC)(dc).GetHDC())
a23fd0e1 788
11c7d5b6
VZ
789#define GetHbitmap() ((HBITMAP)GetHBITMAP())
790#define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
791
42e69d6b 792#define GetHicon() ((HICON)GetHICON())
c50f1fb9 793#define GetHiconOf(icon) ((HICON)(icon).GetHICON())
42e69d6b 794
a23fd0e1 795#define GetHaccel() ((HACCEL)GetHACCEL())
c50f1fb9
VZ
796#define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
797
a27cbf44
VZ
798#define GetHbrush() ((HBRUSH)GetResourceHandle())
799#define GetHbrushOf(brush) ((HBRUSH)(brush).GetResourceHandle())
ee50eab8 800
c50f1fb9
VZ
801#define GetHmenu() ((HMENU)GetHMenu())
802#define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
a23fd0e1 803
bfbd6dc1
VZ
804#define GetHcursor() ((HCURSOR)GetHCURSOR())
805#define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
806
f6bcfd97
BP
807#define GetHfont() ((HFONT)GetHFONT())
808#define GetHfontOf(font) ((HFONT)(font).GetHFONT())
809
f6840be6
VZ
810#define GetHimagelist() ((HIMAGELIST)GetHIMAGELIST())
811#define GetHimagelistOf(imgl) ((HIMAGELIST)imgl->GetHIMAGELIST())
812
1816a070 813#define GetHpalette() ((HPALETTE)GetHPALETTE())
b95edd47 814#define GetHpaletteOf(pal) ((HPALETTE)(pal).GetHPALETTE())
1816a070 815
75776373
VZ
816#define GetHpen() ((HPEN)GetResourceHandle())
817#define GetHpenOf(pen) ((HPEN)(pen).GetResourceHandle())
818
1e6feb95
VZ
819#define GetHrgn() ((HRGN)GetHRGN())
820#define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
821
f6bcfd97
BP
822#endif // wxUSE_GUI
823
a23fd0e1
VZ
824// ---------------------------------------------------------------------------
825// global functions
826// ---------------------------------------------------------------------------
827
18600546
GRG
828extern "C"
829{
bb24c68f 830 WXDLLIMPEXP_BASE HINSTANCE wxGetInstance();
18600546
GRG
831}
832
bb24c68f 833WXDLLIMPEXP_BASE void wxSetInstance(HINSTANCE hInst);
a23fd0e1 834
25b0e7c8
VZ
835// return the full path of the given module
836inline wxString wxGetFullModuleName(HMODULE hmod)
77d8d6cd
VZ
837{
838 wxString fullname;
839 if ( !::GetModuleFileName
840 (
25b0e7c8 841 hmod,
77d8d6cd
VZ
842 wxStringBuffer(fullname, MAX_PATH),
843 MAX_PATH
844 ) )
845 {
846 wxLogLastError(_T("GetModuleFileName"));
847 }
848
849 return fullname;
850}
851
25b0e7c8
VZ
852// return the full path of the program file
853inline wxString wxGetFullModuleName()
854{
855 return wxGetFullModuleName((HMODULE)wxGetInstance());
856}
857
4c5da5e4
VZ
858// return the run-time version of the OS in a format similar to
859// WINVER/_WIN32_WINNT compile-time macros:
860//
861// 0x0300 Windows NT 3.51
862// 0x0400 Windows 95, NT4
863// 0x0410 Windows 98
864// 0x0500 Windows ME, 2000
865// 0x0501 Windows XP
866// 0x0502 Windows 2003
867// 0x0600 Longhorn
868//
869// for the other Windows versions 0 is currently returned
870enum wxWinVersion
871{
872 wxWinVersion_Unknown = 0,
873
874 wxWinVersion_3 = 0x0300,
875 wxWinVersion_NT3 = wxWinVersion_3,
876
877 wxWinVersion_4 = 0x0400,
878 wxWinVersion_95 = wxWinVersion_4,
879 wxWinVersion_NT4 = wxWinVersion_4,
880 wxWinVersion_98 = 0x0410,
881
882 wxWinVersion_5 = 0x0500,
883 wxWinVersion_ME = wxWinVersion_5,
884 wxWinVersion_NT5 = wxWinVersion_5,
885 wxWinVersion_2000 = wxWinVersion_5,
886 wxWinVersion_XP = 0x0501,
887 wxWinVersion_2003 = 0x0502,
888
889 wxWinVersion_6 = 0x0600,
0df7cb7e 890 wxWinVersion_Vista = wxWinVersion_6,
c8b431ad 891 wxWinVersion_NT6 = wxWinVersion_6
4c5da5e4
VZ
892};
893
be2572a3 894WXDLLIMPEXP_BASE wxWinVersion wxGetWinVersion();
4c5da5e4 895
b568d04f
VZ
896#if wxUSE_GUI
897
bfbd6dc1
VZ
898// cursor stuff
899extern HCURSOR wxGetCurrentBusyCursor(); // from msw/utils.cpp
900extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
901
53a2db12
FM
902WXDLLIMPEXP_CORE void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont& the_font);
903WXDLLIMPEXP_CORE void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
904WXDLLIMPEXP_CORE wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
905WXDLLIMPEXP_CORE wxFontEncoding wxGetFontEncFromCharSet(int charset);
a23fd0e1 906
53a2db12
FM
907WXDLLIMPEXP_CORE void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
908WXDLLIMPEXP_CORE void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
a23fd0e1
VZ
909
910// Find maximum size of window/rectangle
53a2db12 911extern WXDLLIMPEXP_CORE void wxFindMaxSize(WXHWND hwnd, RECT *rect);
a23fd0e1 912
1c4a764c 913// Safely get the window text (i.e. without using fixed size buffer)
53a2db12 914extern WXDLLIMPEXP_CORE wxString wxGetWindowText(WXHWND hWnd);
1c4a764c 915
cc2b7472 916// get the window class name
53a2db12 917extern WXDLLIMPEXP_CORE wxString wxGetWindowClass(WXHWND hWnd);
cc2b7472 918
42e69d6b
VZ
919// get the window id (should be unsigned, hence this is not wxWindowID which
920// is, for mainly historical reasons, signed)
53a2db12 921extern WXDLLIMPEXP_CORE int wxGetWindowId(WXHWND hWnd);
cc2b7472 922
ae304744
VZ
923// check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
924// different
53a2db12 925extern WXDLLIMPEXP_CORE bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
eb5e4d9a 926
c085e333 927// Does this window style specify any border?
184b5d99 928inline bool wxStyleHasBorder(long style)
c085e333 929{
82c9f85c
VZ
930 return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
931 wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
c085e333
VZ
932}
933
d026fee4 934inline long wxGetWindowExStyle(const wxWindowMSW *win)
d66d0500
VZ
935{
936 return ::GetWindowLong(GetHwndOf(win), GWL_EXSTYLE);
937}
938
d026fee4 939inline bool wxHasWindowExStyle(const wxWindowMSW *win, long style)
d66d0500
VZ
940{
941 return (wxGetWindowExStyle(win) & style) != 0;
942}
943
d026fee4 944inline long wxSetWindowExStyle(const wxWindowMSW *win, long style)
d66d0500
VZ
945{
946 return ::SetWindowLong(GetHwndOf(win), GWL_EXSTYLE, style);
947}
948
ae304744
VZ
949// ----------------------------------------------------------------------------
950// functions mapping HWND to wxWindow
951// ----------------------------------------------------------------------------
952
dca0f651 953// this function simply checks whether the given hwnd corresponds to a wxWindow
ae304744 954// and returns either that window if it does or NULL otherwise
53a2db12 955extern WXDLLIMPEXP_CORE wxWindow* wxFindWinFromHandle(HWND hwnd);
dca0f651
VZ
956
957// without STRICT WXHWND is the same as HWND anyhow
958inline wxWindow* wxFindWinFromHandle(WXHWND hWnd)
959{
5c33522f 960 return wxFindWinFromHandle(static_cast<HWND>(hWnd));
dca0f651 961}
ae304744
VZ
962
963// find the window for HWND which is part of some wxWindow, i.e. unlike
964// wxFindWinFromHandle() above it will also work for "sub controls" of a
965// wxWindow.
8614c467 966//
ae304744 967// returns the wxWindow corresponding to the given HWND or NULL.
53a2db12 968extern WXDLLIMPEXP_CORE wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
8614c467 969
6bad4c32 970// Get the size of an icon
53a2db12 971extern WXDLLIMPEXP_CORE wxSize wxGetHiconSize(HICON hicon);
6bad4c32 972
086b3a5b 973// Lines are drawn differently for WinCE and regular WIN32
53a2db12 974WXDLLIMPEXP_CORE void wxDrawLine(HDC hdc, int x1, int y1, int x2, int y2);
086b3a5b 975
c3732409
VZ
976// fill the client rect of the given window on the provided dc using this brush
977inline void wxFillRect(HWND hwnd, HDC hdc, HBRUSH hbr)
978{
979 RECT rc;
980 ::GetClientRect(hwnd, &rc);
981 ::FillRect(hdc, &rc, hbr);
982}
983
5171ea0e
VZ
984// ----------------------------------------------------------------------------
985// 32/64 bit helpers
986// ----------------------------------------------------------------------------
987
988#ifdef __WIN64__
989
990inline void *wxGetWindowProc(HWND hwnd)
991{
992 return (void *)::GetWindowLongPtr(hwnd, GWLP_WNDPROC);
993}
994
995inline void *wxGetWindowUserData(HWND hwnd)
996{
997 return (void *)::GetWindowLongPtr(hwnd, GWLP_USERDATA);
998}
999
1000inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
1001{
1002 return (WNDPROC)::SetWindowLongPtr(hwnd, GWLP_WNDPROC, (LONG_PTR)func);
1003}
1004
1005inline void *wxSetWindowUserData(HWND hwnd, void *data)
1006{
1007 return (void *)::SetWindowLongPtr(hwnd, GWLP_USERDATA, (LONG_PTR)data);
1008}
1009
1010#else // __WIN32__
1011
54892273
VZ
1012// note that the casts to LONG_PTR here are required even on 32-bit machines
1013// for the 64-bit warning mode of later versions of MSVC (C4311/4312)
315a49a1 1014inline WNDPROC wxGetWindowProc(HWND hwnd)
5171ea0e 1015{
315a49a1 1016 return (WNDPROC)(LONG_PTR)::GetWindowLong(hwnd, GWL_WNDPROC);
5171ea0e
VZ
1017}
1018
1019inline void *wxGetWindowUserData(HWND hwnd)
1020{
54892273 1021 return (void *)(LONG_PTR)::GetWindowLong(hwnd, GWL_USERDATA);
5171ea0e
VZ
1022}
1023
1024inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
1025{
54892273 1026 return (WNDPROC)(LONG_PTR)::SetWindowLong(hwnd, GWL_WNDPROC, (LONG_PTR)func);
5171ea0e
VZ
1027}
1028
1029inline void *wxSetWindowUserData(HWND hwnd, void *data)
1030{
54892273 1031 return (void *)(LONG_PTR)::SetWindowLong(hwnd, GWL_USERDATA, (LONG_PTR)data);
5171ea0e
VZ
1032}
1033
1034#endif // __WIN64__/__WIN32__
1035
b568d04f
VZ
1036#endif // wxUSE_GUI
1037
a27cbf44 1038#endif // _WX_PRIVATE_H_