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