]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/private.h
Use *wxTopLevelWindowGTK*RequestUserAttention*; because *int* isn't the case always...
[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
0cdd4e19
VZ
196// close the handle in the class dtor
197class AutoHANDLE
198{
199public:
200 wxEXPLICIT AutoHANDLE(HANDLE handle) : m_handle(handle) { }
201
202 bool IsOk() const { return m_handle != INVALID_HANDLE_VALUE; }
203 operator HANDLE() const { return m_handle; }
204
205 ~AutoHANDLE() { if ( IsOk() ) ::CloseHandle(m_handle); }
206
207protected:
208 HANDLE m_handle;
209};
210
f6bcfd97
BP
211#if wxUSE_GUI
212
01dba85a 213#include <wx/gdicmn.h>
ed39ff57 214#include <wx/colour.h>
01dba85a 215
11c7d5b6
VZ
216// make conversion from wxColour and COLORREF a bit less painful
217inline COLORREF wxColourToRGB(const wxColour& c)
4ab861e5
VZ
218{
219 return RGB(c.Red(), c.Green(), c.Blue());
220}
221
222inline COLORREF wxColourToPalRGB(const wxColour& c)
11c7d5b6 223{
19193a2c 224 return PALETTERGB(c.Red(), c.Green(), c.Blue());
11c7d5b6
VZ
225}
226
d23c8ba2
VZ
227inline wxColour wxRGBToColour(COLORREF rgb)
228{
229 return wxColour(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
230}
231
11c7d5b6
VZ
232inline void wxRGBToColour(wxColour& c, COLORREF rgb)
233{
234 c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
235}
236
90c1530a
VZ
237// get the standard colour map for some standard colours - see comment in this
238// function to understand why is it needed and when should it be used
239//
240// it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
241// might be not included/available) array of size wxSTD_COLOUR_MAX
242//
243// NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
244// resources as well: it must have the same number of pixels!
245enum wxSTD_COLOUR
246{
247 wxSTD_COL_BTNTEXT,
248 wxSTD_COL_BTNSHADOW,
249 wxSTD_COL_BTNFACE,
250 wxSTD_COL_BTNHIGHLIGHT,
57e075e9 251 wxSTD_COL_MAX
90c1530a
VZ
252};
253
254struct WXDLLEXPORT wxCOLORMAP
255{
256 COLORREF from, to;
257};
258
259// this function is implemented in src/msw/window.cpp
260extern wxCOLORMAP *wxGetStdColourMap();
261
9688700c 262// create a wxRect from Windows RECT
8704b366 263inline wxRect wxRectFromRECT(const RECT& rc)
9688700c 264{
8704b366 265 return wxRect(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
9688700c
VZ
266}
267
ed791986 268// copy Windows RECT to our wxRect
8704b366 269inline void wxCopyRECTToRect(const RECT& rc, wxRect& rect)
ed791986 270{
8704b366
VZ
271 rect = wxRectFromRECT(rc);
272}
273
274// and vice versa
275inline void wxCopyRectToRECT(const wxRect& rect, RECT& rc)
276{
277 // note that we don't use wxRect::GetRight() as it is one of compared to
278 // wxRectFromRECT() above
279 rc.top = rect.y;
280 rc.left = rect.x;
281 rc.right = rect.x + rect.width;
282 rc.bottom = rect.y + rect.height;
ed791986
VZ
283}
284
d9317fd4
VZ
285// translations between HIMETRIC units (which OLE likes) and pixels (which are
286// liked by all the others) - implemented in msw/utilsexc.cpp
287extern void HIMETRICToPixel(LONG *x, LONG *y);
288extern void PixelToHIMETRIC(LONG *x, LONG *y);
289
77ffb593 290// Windows convention of the mask is opposed to the wxWidgets one, so we need
4b7f2165
VZ
291// to invert the mask each time we pass one/get one to/from Windows
292extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
293
211b54b1
VZ
294// Creates an icon or cursor depending from a bitmap
295//
296// The bitmap must be valid and it should have a mask. If it doesn't, a default
297// mask is created using light grey as the transparent colour.
298extern HICON wxBitmapToHICON(const wxBitmap& bmp);
299
300// Same requirments as above apply and the bitmap must also have the correct
301// size.
302extern
303HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY);
304
8614c467
VZ
305// get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
306// will fail on system with multiple monitors where the coords may be negative
307//
308// these macros are standard now (Win98) but some older headers don't have them
309#ifndef GET_X_LPARAM
310 #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
311 #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
312#endif // GET_X_LPARAM
313
a95e38c0 314// get the current state of SHIFT/CTRL keys
1f80a703 315inline bool wxIsShiftDown()
a95e38c0 316{
1fdf858b
JS
317// return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
318 // Returns different negative values on WinME and WinNT,
319 // so simply test for negative value.
320 return ::GetKeyState(VK_SHIFT) < 0;
a95e38c0
VZ
321}
322
1f80a703 323inline bool wxIsCtrlDown()
a95e38c0 324{
1fdf858b
JS
325// return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
326 // Returns different negative values on WinME and WinNT,
327 // so simply test for negative value.
328 return ::GetKeyState(VK_CONTROL) < 0;
a95e38c0
VZ
329}
330
82c9f85c
VZ
331// wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
332// for Win32
333inline RECT wxGetWindowRect(HWND hwnd)
334{
335 RECT rect;
3a5bcc4d 336
82c9f85c
VZ
337 if ( !::GetWindowRect(hwnd, &rect) )
338 {
339 wxLogLastError(_T("GetWindowRect"));
340 }
82c9f85c
VZ
341
342 return rect;
343}
344
345inline RECT wxGetClientRect(HWND hwnd)
346{
347 RECT rect;
3a5bcc4d 348
82c9f85c
VZ
349 if ( !::GetClientRect(hwnd, &rect) )
350 {
351 wxLogLastError(_T("GetClientRect"));
352 }
82c9f85c
VZ
353
354 return rect;
355}
356
6d167489
VZ
357// ---------------------------------------------------------------------------
358// small helper classes
359// ---------------------------------------------------------------------------
360
bffa02ff
VZ
361// a template to make initializing Windows styructs less painful: it zeroes all
362// the struct fields and also sets cbSize member to the correct value (and so
363// can be only used with structures which have this member...)
364template <class T>
365struct WinStruct : public T
366{
367 WinStruct()
368 {
5eae641d 369 ::ZeroMemory(this, sizeof(T));
329ac7da
VZ
370
371 // explicit qualification is required here for this to be valid C++
a7d174bf 372 this->cbSize = sizeof(T);
bffa02ff
VZ
373 }
374};
375
376
6d167489
VZ
377// create an instance of this class and use it as the HDC for screen, will
378// automatically release the DC going out of scope
379class ScreenHDC
380{
381public:
091225b4
VZ
382 ScreenHDC() { m_hdc = ::GetDC(NULL); }
383 ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
384
385 operator HDC() const { return m_hdc; }
386
387private:
388 HDC m_hdc;
22f3361e
VZ
389
390 DECLARE_NO_COPY_CLASS(ScreenHDC)
091225b4
VZ
391};
392
2ff56383
VZ
393// the same as ScreenHDC but for window DCs
394class WindowHDC
395{
396public:
397 WindowHDC(HWND hwnd) { m_hdc = ::GetDC(m_hwnd = hwnd); }
398 ~WindowHDC() { ::ReleaseDC(m_hwnd, m_hdc); }
399
400 operator HDC() const { return m_hdc; }
401
402private:
403 HWND m_hwnd;
404 HDC m_hdc;
405
406 DECLARE_NO_COPY_CLASS(WindowHDC)
407};
408
697b08a8
VZ
409// the same as ScreenHDC but for memory DCs: creates the HDC compatible with
410// the given one (screen by default) in ctor and destroys it in dtor
091225b4
VZ
411class MemoryHDC
412{
413public:
9cf743aa 414 MemoryHDC(HDC hdc = 0) { m_hdc = ::CreateCompatibleDC(hdc); }
697b08a8 415 ~MemoryHDC() { ::DeleteDC(m_hdc); }
091225b4
VZ
416
417 operator HDC() const { return m_hdc; }
6d167489
VZ
418
419private:
420 HDC m_hdc;
22f3361e
VZ
421
422 DECLARE_NO_COPY_CLASS(MemoryHDC)
6d167489
VZ
423};
424
091225b4
VZ
425// a class which selects a GDI object into a DC in its ctor and deselects in
426// dtor
427class SelectInHDC
428{
429public:
430 SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc)
431 { m_hgdiobj = ::SelectObject(hdc, hgdiobj); }
432
433 ~SelectInHDC() { ::SelectObject(m_hdc, m_hgdiobj); }
434
435 // return true if the object was successfully selected
436 operator bool() const { return m_hgdiobj != 0; }
437
438private:
439 HDC m_hdc;
440 HGDIOBJ m_hgdiobj;
22f3361e 441
51a2a728
VZ
442 DECLARE_NO_COPY_CLASS(SelectInHDC)
443};
444
a27cbf44
VZ
445// a class which cleans up any GDI object
446class AutoGDIObject
447{
448protected:
449 AutoGDIObject(HGDIOBJ gdiobj) : m_gdiobj(gdiobj) { }
450 ~AutoGDIObject() { if ( m_gdiobj ) ::DeleteObject(m_gdiobj); }
451
452 HGDIOBJ GetObject() const { return m_gdiobj; }
453
454private:
455 HGDIOBJ m_gdiobj;
456};
457
cf831d8e
VZ
458// TODO: all this asks for using a AutoHandler<T, CreateFunc> template...
459
460// a class for temporary pens
461class AutoHBRUSH : private AutoGDIObject
462{
463public:
464 AutoHBRUSH(COLORREF col)
465 : AutoGDIObject(::CreateSolidBrush(col)) { }
466
467 operator HBRUSH() const { return (HBRUSH)GetObject(); }
468};
469
470// a class for temporary pens
471class AutoHPEN : private AutoGDIObject
472{
473public:
474 AutoHPEN(COLORREF col)
475 : AutoGDIObject(::CreatePen(PS_SOLID, 0, col)) { }
476
477 operator HPEN() const { return (HPEN)GetObject(); }
478};
479
480// classes for temporary bitmaps
481class AutoHBITMAP : private AutoGDIObject
482{
483public:
484 AutoHBITMAP(HBITMAP hbmp) : AutoGDIObject(hbmp) { }
485
486 operator HBITMAP() const { return (HBITMAP)GetObject(); }
487};
488
489class CompatibleBitmap : public AutoHBITMAP
978bb48f
VZ
490{
491public:
492 CompatibleBitmap(HDC hdc, int w, int h)
cf831d8e 493 : AutoHBITMAP(::CreateCompatibleBitmap(hdc, w, h))
978bb48f 494 {
978bb48f 495 }
cf831d8e 496};
978bb48f 497
cf831d8e
VZ
498class MonoBitmap : public AutoHBITMAP
499{
500public:
501 MonoBitmap(int w, int h)
502 : AutoHBITMAP(::CreateBitmap(w, h, 1, 1, 0))
503 {
504 }
a27cbf44 505};
978bb48f 506
a27cbf44
VZ
507// class automatically destroys the region object
508class AutoHRGN : private AutoGDIObject
509{
510public:
511 AutoHRGN(HRGN hrgn) : AutoGDIObject(hrgn) { }
978bb48f 512
a27cbf44 513 operator HRGN() const { return (HRGN)GetObject(); }
978bb48f
VZ
514};
515
a1372ae2
VZ
516// class sets the specified clipping region during its life time
517class HDCClipper
518{
519public:
520 HDCClipper(HDC hdc, HRGN hrgn)
521 : m_hdc(hdc)
522 {
523 if ( !::SelectClipRgn(hdc, hrgn) )
524 wxLogLastError(_T("SelectClipRgn"));
525 }
526
527 ~HDCClipper()
528 {
529 ::SelectClipRgn(m_hdc, NULL);
530 }
531
532private:
533 HDC m_hdc;
534
535 DECLARE_NO_COPY_CLASS(HDCClipper)
536};
537
51a2a728
VZ
538// when working with global pointers (which is unfortunately still necessary
539// sometimes, e.g. for clipboard) it is important to unlock them exactly as
540// many times as we lock them which just asks for using a "smart lock" class
06d09389 541class GlobalPtr
51a2a728
VZ
542{
543public:
06d09389 544 GlobalPtr(HGLOBAL hGlobal) : m_hGlobal(hGlobal)
51a2a728 545 {
2aaf17c2 546 m_ptr = GlobalLock(hGlobal);
51a2a728
VZ
547 if ( !m_ptr )
548 {
549 wxLogLastError(_T("GlobalLock"));
550 }
551 }
552
06d09389 553 ~GlobalPtr()
51a2a728 554 {
2aaf17c2 555 if ( !GlobalUnlock(m_hGlobal) )
51a2a728
VZ
556 {
557#ifdef __WXDEBUG__
558 // this might happen simply because the block became unlocked
559 DWORD dwLastError = ::GetLastError();
560 if ( dwLastError != NO_ERROR )
561 {
562 wxLogApiError(_T("GlobalUnlock"), dwLastError);
563 }
564#endif // __WXDEBUG__
565 }
566 }
567
568 operator void *() const { return m_ptr; }
569
570private:
571 HGLOBAL m_hGlobal;
572 void *m_ptr;
573
06d09389 574 DECLARE_NO_COPY_CLASS(GlobalPtr)
091225b4
VZ
575};
576
77ec05d4
VZ
577// register the class when it is first needed and unregister it in dtor
578class ClassRegistrar
579{
580public:
581 // ctor doesn't register the class, call Initialize() for this
582 ClassRegistrar() { m_registered = -1; }
583
584 // return true if the class is already registered
585 bool IsInitialized() const { return m_registered != -1; }
586
587 // return true if the class had been already registered
588 bool IsRegistered() const { return m_registered == 1; }
589
590 // try to register the class if not done yet, return true on success
591 bool Register(const WNDCLASS& wc)
592 {
593 // we should only be called if we hadn't been initialized yet
594 wxASSERT_MSG( m_registered == -1,
595 _T("calling ClassRegistrar::Register() twice?") );
596
597 m_registered = ::RegisterClass(&wc) ? 1 : 0;
598 if ( !IsRegistered() )
599 {
600 wxLogLastError(_T("RegisterClassEx()"));
601 }
602 else
603 {
604 m_clsname = wc.lpszClassName;
605 }
606
607 return m_registered == 1;
608 }
609
610 // get the name of the registered class (returns empty string if not
611 // registered)
612 const wxString& GetName() const { return m_clsname; }
613
614 // unregister the class if it had been registered
615 ~ClassRegistrar()
616 {
617 if ( IsRegistered() )
618 {
619 if ( !::UnregisterClass(m_clsname, wxhInstance) )
620 {
621 wxLogLastError(_T("UnregisterClass"));
622 }
623 }
624 }
625
626private:
627 // initial value is -1 which means that we hadn't tried registering the
628 // class yet, it becomes true or false (1 or 0) when Initialize() is called
629 int m_registered;
630
631 // the name of the class, only non empty if it had been registered
632 wxString m_clsname;
633};
634
a23fd0e1 635// ---------------------------------------------------------------------------
42e69d6b 636// macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
c50f1fb9
VZ
637// returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
638// an argument which should be a pointer or reference to the object of the
639// corresponding class (this depends on the macro)
a23fd0e1
VZ
640// ---------------------------------------------------------------------------
641
642#define GetHwnd() ((HWND)GetHWND())
c50f1fb9
VZ
643#define GetHwndOf(win) ((HWND)((win)->GetHWND()))
644// old name
645#define GetWinHwnd GetHwndOf
a23fd0e1
VZ
646
647#define GetHdc() ((HDC)GetHDC())
c50f1fb9 648#define GetHdcOf(dc) ((HDC)(dc).GetHDC())
a23fd0e1 649
11c7d5b6
VZ
650#define GetHbitmap() ((HBITMAP)GetHBITMAP())
651#define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
652
42e69d6b 653#define GetHicon() ((HICON)GetHICON())
c50f1fb9 654#define GetHiconOf(icon) ((HICON)(icon).GetHICON())
42e69d6b 655
a23fd0e1 656#define GetHaccel() ((HACCEL)GetHACCEL())
c50f1fb9
VZ
657#define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
658
a27cbf44
VZ
659#define GetHbrush() ((HBRUSH)GetResourceHandle())
660#define GetHbrushOf(brush) ((HBRUSH)(brush).GetResourceHandle())
ee50eab8 661
c50f1fb9
VZ
662#define GetHmenu() ((HMENU)GetHMenu())
663#define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
a23fd0e1 664
bfbd6dc1
VZ
665#define GetHcursor() ((HCURSOR)GetHCURSOR())
666#define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
667
f6bcfd97
BP
668#define GetHfont() ((HFONT)GetHFONT())
669#define GetHfontOf(font) ((HFONT)(font).GetHFONT())
670
f6840be6
VZ
671#define GetHimagelist() ((HIMAGELIST)GetHIMAGELIST())
672#define GetHimagelistOf(imgl) ((HIMAGELIST)imgl->GetHIMAGELIST())
673
1816a070 674#define GetHpalette() ((HPALETTE)GetHPALETTE())
b95edd47 675#define GetHpaletteOf(pal) ((HPALETTE)(pal).GetHPALETTE())
1816a070 676
75776373
VZ
677#define GetHpen() ((HPEN)GetResourceHandle())
678#define GetHpenOf(pen) ((HPEN)(pen).GetResourceHandle())
679
1e6feb95
VZ
680#define GetHrgn() ((HRGN)GetHRGN())
681#define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
682
f6bcfd97
BP
683#endif // wxUSE_GUI
684
a23fd0e1
VZ
685// ---------------------------------------------------------------------------
686// global functions
687// ---------------------------------------------------------------------------
688
18600546
GRG
689extern "C"
690{
bb24c68f 691 WXDLLIMPEXP_BASE HINSTANCE wxGetInstance();
18600546
GRG
692}
693
bb24c68f 694WXDLLIMPEXP_BASE void wxSetInstance(HINSTANCE hInst);
a23fd0e1 695
25b0e7c8
VZ
696// return the full path of the given module
697inline wxString wxGetFullModuleName(HMODULE hmod)
77d8d6cd
VZ
698{
699 wxString fullname;
700 if ( !::GetModuleFileName
701 (
25b0e7c8 702 hmod,
77d8d6cd
VZ
703 wxStringBuffer(fullname, MAX_PATH),
704 MAX_PATH
705 ) )
706 {
707 wxLogLastError(_T("GetModuleFileName"));
708 }
709
710 return fullname;
711}
712
25b0e7c8
VZ
713// return the full path of the program file
714inline wxString wxGetFullModuleName()
715{
716 return wxGetFullModuleName((HMODULE)wxGetInstance());
717}
718
4c5da5e4
VZ
719// return the run-time version of the OS in a format similar to
720// WINVER/_WIN32_WINNT compile-time macros:
721//
722// 0x0300 Windows NT 3.51
723// 0x0400 Windows 95, NT4
724// 0x0410 Windows 98
725// 0x0500 Windows ME, 2000
726// 0x0501 Windows XP
727// 0x0502 Windows 2003
728// 0x0600 Longhorn
729//
730// for the other Windows versions 0 is currently returned
731enum wxWinVersion
732{
733 wxWinVersion_Unknown = 0,
734
735 wxWinVersion_3 = 0x0300,
736 wxWinVersion_NT3 = wxWinVersion_3,
737
738 wxWinVersion_4 = 0x0400,
739 wxWinVersion_95 = wxWinVersion_4,
740 wxWinVersion_NT4 = wxWinVersion_4,
741 wxWinVersion_98 = 0x0410,
742
743 wxWinVersion_5 = 0x0500,
744 wxWinVersion_ME = wxWinVersion_5,
745 wxWinVersion_NT5 = wxWinVersion_5,
746 wxWinVersion_2000 = wxWinVersion_5,
747 wxWinVersion_XP = 0x0501,
748 wxWinVersion_2003 = 0x0502,
749
750 wxWinVersion_6 = 0x0600,
751 wxWinVersion_NT6 = 0x0600
752};
753
be2572a3 754WXDLLIMPEXP_BASE wxWinVersion wxGetWinVersion();
4c5da5e4 755
b568d04f
VZ
756#if wxUSE_GUI
757
bfbd6dc1
VZ
758// cursor stuff
759extern HCURSOR wxGetCurrentBusyCursor(); // from msw/utils.cpp
760extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
761
7a5e53ab 762WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont& the_font);
11c7d5b6
VZ
763WXDLLEXPORT void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
764WXDLLEXPORT wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
f6bcfd97 765WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int charset);
a23fd0e1
VZ
766
767WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
768WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
769
770// Find maximum size of window/rectangle
ef359b43 771extern WXDLLEXPORT void wxFindMaxSize(WXHWND hwnd, RECT *rect);
a23fd0e1 772
1c4a764c 773// Safely get the window text (i.e. without using fixed size buffer)
ef359b43 774extern WXDLLEXPORT wxString wxGetWindowText(WXHWND hWnd);
1c4a764c 775
cc2b7472 776// get the window class name
ef359b43 777extern WXDLLEXPORT wxString wxGetWindowClass(WXHWND hWnd);
cc2b7472 778
42e69d6b
VZ
779// get the window id (should be unsigned, hence this is not wxWindowID which
780// is, for mainly historical reasons, signed)
ef359b43 781extern WXDLLEXPORT WXWORD wxGetWindowId(WXHWND hWnd);
cc2b7472 782
ae304744
VZ
783// check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
784// different
ef359b43 785extern WXDLLEXPORT bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
eb5e4d9a 786
c085e333 787// Does this window style specify any border?
184b5d99 788inline bool wxStyleHasBorder(long style)
c085e333 789{
82c9f85c
VZ
790 return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
791 wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
c085e333
VZ
792}
793
8e44f3ca 794// Deferred window moving
c282a7a1 795bool wxMoveWindowDeferred(HDWP& hdwp, wxWindowBase* win, HWND hWnd, int x, int y, int width, int height);
8e44f3ca 796
ae304744
VZ
797// ----------------------------------------------------------------------------
798// functions mapping HWND to wxWindow
799// ----------------------------------------------------------------------------
800
801// this function simply checks whether the given hWnd corresponds to a wxWindow
802// and returns either that window if it does or NULL otherwise
ef359b43 803extern WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
ae304744
VZ
804
805// find the window for HWND which is part of some wxWindow, i.e. unlike
806// wxFindWinFromHandle() above it will also work for "sub controls" of a
807// wxWindow.
8614c467 808//
ae304744 809// returns the wxWindow corresponding to the given HWND or NULL.
ef359b43 810extern WXDLLEXPORT wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
8614c467 811
6bad4c32 812// Get the size of an icon
ef359b43 813extern WXDLLEXPORT wxSize wxGetHiconSize(HICON hicon);
6bad4c32 814
086b3a5b
JS
815// Lines are drawn differently for WinCE and regular WIN32
816WXDLLEXPORT void wxDrawLine(HDC hdc, int x1, int y1, int x2, int y2);
817
c3732409
VZ
818// fill the client rect of the given window on the provided dc using this brush
819inline void wxFillRect(HWND hwnd, HDC hdc, HBRUSH hbr)
820{
821 RECT rc;
822 ::GetClientRect(hwnd, &rc);
823 ::FillRect(hdc, &rc, hbr);
824}
825
5171ea0e
VZ
826// ----------------------------------------------------------------------------
827// 32/64 bit helpers
828// ----------------------------------------------------------------------------
829
830#ifdef __WIN64__
831
832inline void *wxGetWindowProc(HWND hwnd)
833{
834 return (void *)::GetWindowLongPtr(hwnd, GWLP_WNDPROC);
835}
836
837inline void *wxGetWindowUserData(HWND hwnd)
838{
839 return (void *)::GetWindowLongPtr(hwnd, GWLP_USERDATA);
840}
841
842inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
843{
844 return (WNDPROC)::SetWindowLongPtr(hwnd, GWLP_WNDPROC, (LONG_PTR)func);
845}
846
847inline void *wxSetWindowUserData(HWND hwnd, void *data)
848{
849 return (void *)::SetWindowLongPtr(hwnd, GWLP_USERDATA, (LONG_PTR)data);
850}
851
852#else // __WIN32__
853
b41f29c3
VZ
854#ifdef __VISUALC__
855 // strangely enough, VC++ 7.1 gives warnings about 32 -> 64 bit conversions
856 // in the functions below, even in spite of the explicit casts
857 #pragma warning(disable:4311)
858 #pragma warning(disable:4312)
859#endif
860
5171ea0e
VZ
861inline void *wxGetWindowProc(HWND hwnd)
862{
863 return (void *)::GetWindowLong(hwnd, GWL_WNDPROC);
864}
865
866inline void *wxGetWindowUserData(HWND hwnd)
867{
868 return (void *)::GetWindowLong(hwnd, GWL_USERDATA);
869}
870
871inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
872{
873 return (WNDPROC)::SetWindowLong(hwnd, GWL_WNDPROC, (LONG)func);
874}
875
876inline void *wxSetWindowUserData(HWND hwnd, void *data)
877{
878 return (void *)::SetWindowLong(hwnd, GWL_USERDATA, (LONG)data);
879}
880
b41f29c3
VZ
881#ifdef __VISUALC__
882 #pragma warning(default:4311)
883 #pragma warning(default:4312)
884#endif
885
5171ea0e
VZ
886#endif // __WIN64__/__WIN32__
887
b568d04f
VZ
888#endif // wxUSE_GUI
889
a27cbf44 890#endif // _WX_PRIVATE_H_