]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/private.h
doc-typo
[wxWidgets.git] / include / wx / msw / private.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: private.h
3 // Purpose: Private declarations: as this header is only included by
4 // wxWidgets itself, it may contain identifiers which don't start
5 // with "wx".
6 // Author: Julian Smart
7 // Modified by:
8 // Created: 01/02/97
9 // RCS-ID: $Id$
10 // Copyright: (c) Julian Smart
11 // Licence: wxWindows licence
12 /////////////////////////////////////////////////////////////////////////////
13
14 #ifndef _WX_PRIVATE_H_
15 #define _WX_PRIVATE_H_
16
17 #include "wx/msw/wrapwin.h"
18
19 #ifdef __WXMICROWIN__
20 // Extra prototypes and symbols not defined by MicroWindows
21 #include "wx/msw/microwin.h"
22 #endif
23
24 // Include fixes for MSLU:
25 #include "wx/msw/mslu.h"
26
27 #include "wx/log.h"
28
29 class WXDLLEXPORT wxFont;
30 class WXDLLEXPORT wxWindow;
31
32 // ---------------------------------------------------------------------------
33 // private constants
34 // ---------------------------------------------------------------------------
35
36 // Conversion
37 static const double METRIC_CONVERSION_CONSTANT = 0.0393700787;
38
39 // Scaling factors for various unit conversions
40 static const double mm2inches = (METRIC_CONVERSION_CONSTANT);
41 static const double inches2mm = (1/METRIC_CONVERSION_CONSTANT);
42
43 static const double mm2twips = (METRIC_CONVERSION_CONSTANT*1440);
44 static const double twips2mm = (1/(METRIC_CONVERSION_CONSTANT*1440));
45
46 static const double mm2pt = (METRIC_CONVERSION_CONSTANT*72);
47 static const double pt2mm = (1/(METRIC_CONVERSION_CONSTANT*72));
48
49 // ---------------------------------------------------------------------------
50 // standard icons from the resources
51 // ---------------------------------------------------------------------------
52
53 #if wxUSE_GUI
54
55 WXDLLEXPORT_DATA(extern HICON) wxSTD_FRAME_ICON;
56 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDIPARENTFRAME_ICON;
57 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDICHILDFRAME_ICON;
58 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_FRAME_ICON;
59 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDIPARENTFRAME_ICON;
60 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDICHILDFRAME_ICON;
61 WXDLLEXPORT_DATA(extern HFONT) wxSTATUS_LINE_FONT;
62
63 #endif // wxUSE_GUI
64
65 // ---------------------------------------------------------------------------
66 // define things missing from some compilers' headers
67 // ---------------------------------------------------------------------------
68
69 #if defined(__WXWINCE__) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
70 #ifndef ZeroMemory
71 inline void ZeroMemory(void *buf, size_t len) { memset(buf, 0, len); }
72 #endif
73 #endif // old mingw32
74
75 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
76 // window proc
77 #if defined(STRICT) || defined(__GNUC__)
78 typedef WNDPROC WndProcCast;
79 #else
80 typedef FARPROC WndProcCast;
81 #endif
82
83
84 #define CASTWNDPROC (WndProcCast)
85
86
87
88 // ---------------------------------------------------------------------------
89 // some stuff for old Windows versions (FIXME: what does it do here??)
90 // ---------------------------------------------------------------------------
91
92 #if !defined(APIENTRY) // NT defines APIENTRY, 3.x not
93 #define APIENTRY FAR PASCAL
94 #endif
95
96 #ifdef __WIN32__
97 #define _EXPORT
98 #else
99 #define _EXPORT _export
100 #endif
101
102 #ifndef __WIN32__
103 typedef signed short int SHORT;
104 #endif
105
106 #if !defined(__WIN32__) // 3.x uses FARPROC for dialogs
107 #ifndef STRICT
108 #define DLGPROC FARPROC
109 #endif
110 #endif
111
112 #if wxUSE_PENWIN
113 WXDLLEXPORT void wxRegisterPenWin();
114 WXDLLEXPORT void wxCleanUpPenWin();
115 WXDLLEXPORT void wxEnablePenAppHooks (bool hook);
116 #endif // wxUSE_PENWIN
117
118 #if wxUSE_ITSY_BITSY
119 #define IBS_HORZCAPTION 0x4000L
120 #define IBS_VERTCAPTION 0x8000L
121
122 UINT WINAPI ibGetCaptionSize( HWND hWnd ) ;
123 UINT WINAPI ibSetCaptionSize( HWND hWnd, UINT nSize ) ;
124 LRESULT WINAPI ibDefWindowProc( HWND hWnd, UINT uiMsg, WPARAM wParam, LPARAM lParam ) ;
125 VOID WINAPI ibAdjustWindowRect( HWND hWnd, LPRECT lprc ) ;
126 #endif // wxUSE_ITSY_BITSY
127
128 #if wxUSE_CTL3D
129 #include "wx/msw/ctl3d/ctl3d.h"
130 #endif // wxUSE_CTL3D
131
132 /*
133 * Decide what window classes we're going to use
134 * for this combination of CTl3D/FAFA settings
135 */
136
137 #define STATIC_CLASS wxT("STATIC")
138 #define STATIC_FLAGS (SS_LEFT|WS_CHILD|WS_VISIBLE)
139 #define CHECK_CLASS wxT("BUTTON")
140 #define CHECK_FLAGS (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
141 #define CHECK_IS_FAFA FALSE
142 #define RADIO_CLASS wxT("BUTTON")
143 #define RADIO_FLAGS (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
144 #define RADIO_SIZE 20
145 #define RADIO_IS_FAFA FALSE
146 #define PURE_WINDOWS
147 #define GROUP_CLASS wxT("BUTTON")
148 #define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
149
150 /*
151 #define BITCHECK_FLAGS (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
152 #define BITRADIO_FLAGS (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
153 */
154
155 // ---------------------------------------------------------------------------
156 // misc macros
157 // ---------------------------------------------------------------------------
158
159 #define MEANING_CHARACTER '0'
160 #define DEFAULT_ITEM_WIDTH 100
161 #define DEFAULT_ITEM_HEIGHT 80
162
163 // Scale font to get edit control height
164 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (3*(cy)/2)
165 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (cy+8)
166
167 // Generic subclass proc, for panel item moving/sizing and intercept
168 // EDIT control VK_RETURN messages
169 extern LONG APIENTRY _EXPORT
170 wxSubclassedGenericControlProc(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
171
172 // ---------------------------------------------------------------------------
173 // useful macros and functions
174 // ---------------------------------------------------------------------------
175
176 // a wrapper macro for ZeroMemory()
177 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
178 #define wxZeroMemory(obj) ::ZeroMemory(&obj, sizeof(obj))
179 #else
180 #define wxZeroMemory(obj) memset((void*) & obj, 0, sizeof(obj))
181 #endif
182
183 #if wxUSE_GUI
184
185 #include <wx/gdicmn.h>
186 #include <wx/colour.h>
187
188 // make conversion from wxColour and COLORREF a bit less painful
189 inline COLORREF wxColourToRGB(const wxColour& c)
190 {
191 return RGB(c.Red(), c.Green(), c.Blue());
192 }
193
194 inline COLORREF wxColourToPalRGB(const wxColour& c)
195 {
196 return PALETTERGB(c.Red(), c.Green(), c.Blue());
197 }
198
199 inline wxColour wxRGBToColour(COLORREF rgb)
200 {
201 return wxColour(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
202 }
203
204 inline void wxRGBToColour(wxColour& c, COLORREF rgb)
205 {
206 c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
207 }
208
209 // get the standard colour map for some standard colours - see comment in this
210 // function to understand why is it needed and when should it be used
211 //
212 // it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
213 // might be not included/available) array of size wxSTD_COLOUR_MAX
214 //
215 // NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
216 // resources as well: it must have the same number of pixels!
217 enum wxSTD_COLOUR
218 {
219 wxSTD_COL_BTNTEXT,
220 wxSTD_COL_BTNSHADOW,
221 wxSTD_COL_BTNFACE,
222 wxSTD_COL_BTNHIGHLIGHT,
223 wxSTD_COL_MAX,
224 };
225
226 struct WXDLLEXPORT wxCOLORMAP
227 {
228 COLORREF from, to;
229 };
230
231 // this function is implemented in src/msw/window.cpp
232 extern wxCOLORMAP *wxGetStdColourMap();
233
234 // copy Windows RECT to our wxRect
235 inline void wxCopyRECTToRect(const RECT& r, wxRect& rect)
236 {
237 rect.y = r.top;
238 rect.x = r.left;
239 rect.width = r.right - r.left;
240 rect.height = r.bottom - r.top;
241 }
242
243 // translations between HIMETRIC units (which OLE likes) and pixels (which are
244 // liked by all the others) - implemented in msw/utilsexc.cpp
245 extern void HIMETRICToPixel(LONG *x, LONG *y);
246 extern void PixelToHIMETRIC(LONG *x, LONG *y);
247
248 // Windows convention of the mask is opposed to the wxWidgets one, so we need
249 // to invert the mask each time we pass one/get one to/from Windows
250 extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
251
252 // Creates an icon or cursor depending from a bitmap
253 //
254 // The bitmap must be valid and it should have a mask. If it doesn't, a default
255 // mask is created using light grey as the transparent colour.
256 extern HICON wxBitmapToHICON(const wxBitmap& bmp);
257
258 // Same requirments as above apply and the bitmap must also have the correct
259 // size.
260 extern
261 HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY);
262
263 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
264 // will fail on system with multiple monitors where the coords may be negative
265 //
266 // these macros are standard now (Win98) but some older headers don't have them
267 #ifndef GET_X_LPARAM
268 #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
269 #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
270 #endif // GET_X_LPARAM
271
272 // get the current state of SHIFT/CTRL keys
273 inline bool wxIsShiftDown()
274 {
275 // return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
276 // Returns different negative values on WinME and WinNT,
277 // so simply test for negative value.
278 return ::GetKeyState(VK_SHIFT) < 0;
279 }
280
281 inline bool wxIsCtrlDown()
282 {
283 // return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
284 // Returns different negative values on WinME and WinNT,
285 // so simply test for negative value.
286 return ::GetKeyState(VK_CONTROL) < 0;
287 }
288
289 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
290 // for Win32
291 inline RECT wxGetWindowRect(HWND hwnd)
292 {
293 RECT rect;
294
295 if ( !::GetWindowRect(hwnd, &rect) )
296 {
297 wxLogLastError(_T("GetWindowRect"));
298 }
299
300 return rect;
301 }
302
303 inline RECT wxGetClientRect(HWND hwnd)
304 {
305 RECT rect;
306
307 if ( !::GetClientRect(hwnd, &rect) )
308 {
309 wxLogLastError(_T("GetClientRect"));
310 }
311
312 return rect;
313 }
314
315 // ---------------------------------------------------------------------------
316 // small helper classes
317 // ---------------------------------------------------------------------------
318
319 // a template to make initializing Windows styructs less painful: it zeroes all
320 // the struct fields and also sets cbSize member to the correct value (and so
321 // can be only used with structures which have this member...)
322 template <class T>
323 struct WinStruct : public T
324 {
325 WinStruct()
326 {
327 ::ZeroMemory(this, sizeof(T));
328
329 // explicit qualification is required here for this to be valid C++
330 this->cbSize = sizeof(T);
331 }
332 };
333
334
335 // create an instance of this class and use it as the HDC for screen, will
336 // automatically release the DC going out of scope
337 class ScreenHDC
338 {
339 public:
340 ScreenHDC() { m_hdc = ::GetDC(NULL); }
341 ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
342
343 operator HDC() const { return m_hdc; }
344
345 private:
346 HDC m_hdc;
347
348 DECLARE_NO_COPY_CLASS(ScreenHDC)
349 };
350
351 // the same as ScreenHDC but for window DCs
352 class WindowHDC
353 {
354 public:
355 WindowHDC(HWND hwnd) { m_hdc = ::GetDC(m_hwnd = hwnd); }
356 ~WindowHDC() { ::ReleaseDC(m_hwnd, m_hdc); }
357
358 operator HDC() const { return m_hdc; }
359
360 private:
361 HWND m_hwnd;
362 HDC m_hdc;
363
364 DECLARE_NO_COPY_CLASS(WindowHDC)
365 };
366
367 // the same as ScreenHDC but for memory DCs: creates the HDC compatible with
368 // the given one (screen by default) in ctor and destroys it in dtor
369 class MemoryHDC
370 {
371 public:
372 MemoryHDC(HDC hdc = 0) { m_hdc = ::CreateCompatibleDC(hdc); }
373 ~MemoryHDC() { ::DeleteDC(m_hdc); }
374
375 operator HDC() const { return m_hdc; }
376
377 private:
378 HDC m_hdc;
379
380 DECLARE_NO_COPY_CLASS(MemoryHDC)
381 };
382
383 // a class which selects a GDI object into a DC in its ctor and deselects in
384 // dtor
385 class SelectInHDC
386 {
387 public:
388 SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc)
389 { m_hgdiobj = ::SelectObject(hdc, hgdiobj); }
390
391 ~SelectInHDC() { ::SelectObject(m_hdc, m_hgdiobj); }
392
393 // return true if the object was successfully selected
394 operator bool() const { return m_hgdiobj != 0; }
395
396 private:
397 HDC m_hdc;
398 HGDIOBJ m_hgdiobj;
399
400 DECLARE_NO_COPY_CLASS(SelectInHDC)
401 };
402
403 // when working with global pointers (which is unfortunately still necessary
404 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
405 // many times as we lock them which just asks for using a "smart lock" class
406 class GlobalPtr
407 {
408 public:
409 GlobalPtr(HGLOBAL hGlobal) : m_hGlobal(hGlobal)
410 {
411 m_ptr = GlobalLock(hGlobal);
412 if ( !m_ptr )
413 {
414 wxLogLastError(_T("GlobalLock"));
415 }
416 }
417
418 ~GlobalPtr()
419 {
420 if ( !GlobalUnlock(m_hGlobal) )
421 {
422 #ifdef __WXDEBUG__
423 // this might happen simply because the block became unlocked
424 DWORD dwLastError = ::GetLastError();
425 if ( dwLastError != NO_ERROR )
426 {
427 wxLogApiError(_T("GlobalUnlock"), dwLastError);
428 }
429 #endif // __WXDEBUG__
430 }
431 }
432
433 operator void *() const { return m_ptr; }
434
435 private:
436 HGLOBAL m_hGlobal;
437 void *m_ptr;
438
439 DECLARE_NO_COPY_CLASS(GlobalPtr)
440 };
441
442 // ---------------------------------------------------------------------------
443 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
444 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
445 // an argument which should be a pointer or reference to the object of the
446 // corresponding class (this depends on the macro)
447 // ---------------------------------------------------------------------------
448
449 #define GetHwnd() ((HWND)GetHWND())
450 #define GetHwndOf(win) ((HWND)((win)->GetHWND()))
451 // old name
452 #define GetWinHwnd GetHwndOf
453
454 #define GetHdc() ((HDC)GetHDC())
455 #define GetHdcOf(dc) ((HDC)(dc).GetHDC())
456
457 #define GetHbitmap() ((HBITMAP)GetHBITMAP())
458 #define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
459
460 #define GetHicon() ((HICON)GetHICON())
461 #define GetHiconOf(icon) ((HICON)(icon).GetHICON())
462
463 #define GetHaccel() ((HACCEL)GetHACCEL())
464 #define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
465
466 #define GetHbrush() ((HPEN)GetResourceHandle())
467 #define GetHbrushOf(brush) ((HPEN)(brush).GetResourceHandle())
468
469 #define GetHmenu() ((HMENU)GetHMenu())
470 #define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
471
472 #define GetHcursor() ((HCURSOR)GetHCURSOR())
473 #define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
474
475 #define GetHfont() ((HFONT)GetHFONT())
476 #define GetHfontOf(font) ((HFONT)(font).GetHFONT())
477
478 #define GetHpalette() ((HPALETTE)GetHPALETTE())
479 #define GetHpaletteOf(pal) ((HPALETTE)(pal).GetHPALETTE())
480
481 #define GetHpen() ((HPEN)GetResourceHandle())
482 #define GetHpenOf(pen) ((HPEN)(pen).GetResourceHandle())
483
484 #define GetHrgn() ((HRGN)GetHRGN())
485 #define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
486
487 #endif // wxUSE_GUI
488
489 // ---------------------------------------------------------------------------
490 // global data
491 // ---------------------------------------------------------------------------
492
493 WXDLLIMPEXP_DATA_BASE(extern HINSTANCE) wxhInstance;
494
495 // ---------------------------------------------------------------------------
496 // global functions
497 // ---------------------------------------------------------------------------
498
499 extern "C"
500 {
501 WXDLLIMPEXP_BASE HINSTANCE wxGetInstance();
502 }
503
504 WXDLLIMPEXP_BASE void wxSetInstance(HINSTANCE hInst);
505
506 #if wxUSE_GUI
507
508 // cursor stuff
509 extern HCURSOR wxGetCurrentBusyCursor(); // from msw/utils.cpp
510 extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
511
512 WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont& the_font);
513 WXDLLEXPORT void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
514 WXDLLEXPORT wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
515 WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int charset);
516
517 WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
518 WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
519
520 // Find maximum size of window/rectangle
521 WXDLLEXPORT extern void wxFindMaxSize(WXHWND hwnd, RECT *rect);
522
523 // Safely get the window text (i.e. without using fixed size buffer)
524 WXDLLEXPORT extern wxString wxGetWindowText(WXHWND hWnd);
525
526 // get the window class name
527 WXDLLEXPORT extern wxString wxGetWindowClass(WXHWND hWnd);
528
529 // get the window id (should be unsigned, hence this is not wxWindowID which
530 // is, for mainly historical reasons, signed)
531 WXDLLEXPORT extern WXWORD wxGetWindowId(WXHWND hWnd);
532
533 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
534 // different
535 WXDLLEXPORT extern bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
536
537 // Does this window style specify any border?
538 inline bool wxStyleHasBorder(long style)
539 {
540 return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
541 wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
542 }
543
544 // ----------------------------------------------------------------------------
545 // functions mapping HWND to wxWindow
546 // ----------------------------------------------------------------------------
547
548 // this function simply checks whether the given hWnd corresponds to a wxWindow
549 // and returns either that window if it does or NULL otherwise
550 WXDLLEXPORT extern wxWindow* wxFindWinFromHandle(WXHWND hWnd);
551
552 // find the window for HWND which is part of some wxWindow, i.e. unlike
553 // wxFindWinFromHandle() above it will also work for "sub controls" of a
554 // wxWindow.
555 //
556 // returns the wxWindow corresponding to the given HWND or NULL.
557 WXDLLEXPORT extern wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
558
559 // Get the size of an icon
560 WXDLLEXPORT extern wxSize wxGetHiconSize(HICON hicon);
561
562 // Lines are drawn differently for WinCE and regular WIN32
563 WXDLLEXPORT void wxDrawLine(HDC hdc, int x1, int y1, int x2, int y2);
564
565 // ----------------------------------------------------------------------------
566 // 32/64 bit helpers
567 // ----------------------------------------------------------------------------
568
569 #ifdef __WIN64__
570
571 inline void *wxGetWindowProc(HWND hwnd)
572 {
573 return (void *)::GetWindowLongPtr(hwnd, GWLP_WNDPROC);
574 }
575
576 inline void *wxGetWindowUserData(HWND hwnd)
577 {
578 return (void *)::GetWindowLongPtr(hwnd, GWLP_USERDATA);
579 }
580
581 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
582 {
583 return (WNDPROC)::SetWindowLongPtr(hwnd, GWLP_WNDPROC, (LONG_PTR)func);
584 }
585
586 inline void *wxSetWindowUserData(HWND hwnd, void *data)
587 {
588 return (void *)::SetWindowLongPtr(hwnd, GWLP_USERDATA, (LONG_PTR)data);
589 }
590
591 #else // __WIN32__
592
593 inline void *wxGetWindowProc(HWND hwnd)
594 {
595 return (void *)::GetWindowLong(hwnd, GWL_WNDPROC);
596 }
597
598 inline void *wxGetWindowUserData(HWND hwnd)
599 {
600 return (void *)::GetWindowLong(hwnd, GWL_USERDATA);
601 }
602
603 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
604 {
605 return (WNDPROC)::SetWindowLong(hwnd, GWL_WNDPROC, (LONG)func);
606 }
607
608 inline void *wxSetWindowUserData(HWND hwnd, void *data)
609 {
610 return (void *)::SetWindowLong(hwnd, GWL_USERDATA, (LONG)data);
611 }
612
613 #endif // __WIN64__/__WIN32__
614
615 #endif // wxUSE_GUI
616
617 #endif
618 // _WX_PRIVATE_H_