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