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