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