1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Private declarations: as this header is only included by
4 // wxWindows itself, it may contain identifiers which don't start
6 // Author: Julian Smart
10 // Copyright: (c) Julian Smart
11 // Licence: wxWindows licence
12 /////////////////////////////////////////////////////////////////////////////
14 #ifndef _WX_PRIVATE_H_
15 #define _WX_PRIVATE_H_
17 #include "wx/msw/wrapwin.h"
19 #if defined (__WXWINCE__)
20 #include <wingdi.h> // RGB, COLORREF
22 #include <winuser.h> // Global Namespaces ::GetKeyState, ::GetWindowRect
23 #include "wx/msw/winundef.h"
28 // Extra prototypes and symbols not defined by MicroWindows
29 #include "wx/msw/microwin.h"
32 // Include fixes for MSLU:
33 #include "wx/msw/mslu.h"
37 class WXDLLEXPORT wxFont
;
38 class WXDLLEXPORT wxWindow
;
40 // ---------------------------------------------------------------------------
42 // ---------------------------------------------------------------------------
45 static const double METRIC_CONVERSION_CONSTANT
= 0.0393700787;
47 // Scaling factors for various unit conversions
48 static const double mm2inches
= (METRIC_CONVERSION_CONSTANT
);
49 static const double inches2mm
= (1/METRIC_CONVERSION_CONSTANT
);
51 static const double mm2twips
= (METRIC_CONVERSION_CONSTANT
*1440);
52 static const double twips2mm
= (1/(METRIC_CONVERSION_CONSTANT
*1440));
54 static const double mm2pt
= (METRIC_CONVERSION_CONSTANT
*72);
55 static const double pt2mm
= (1/(METRIC_CONVERSION_CONSTANT
*72));
57 // ---------------------------------------------------------------------------
58 // standard icons from the resources
59 // ---------------------------------------------------------------------------
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
;
73 // ---------------------------------------------------------------------------
74 // define things missing from some compilers' headers
75 // ---------------------------------------------------------------------------
77 #if defined(__WXWINCE__) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
79 inline void ZeroMemory(void *buf
, size_t len
) { memset(buf
, 0, len
); }
83 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
85 #if defined(STRICT) || defined(__GNUC__)
86 typedef WNDPROC WndProcCast
;
88 typedef FARPROC WndProcCast
;
92 #define CASTWNDPROC (WndProcCast)
96 // ---------------------------------------------------------------------------
97 // some stuff for old Windows versions (FIXME: what does it do here??)
98 // ---------------------------------------------------------------------------
100 #if !defined(APIENTRY) // NT defines APIENTRY, 3.x not
101 #define APIENTRY FAR PASCAL
107 #define _EXPORT _export
111 typedef signed short int SHORT
;
114 #if !defined(__WIN32__) // 3.x uses FARPROC for dialogs
116 #define DLGPROC FARPROC
121 WXDLLEXPORT
void wxRegisterPenWin();
122 WXDLLEXPORT
void wxCleanUpPenWin();
123 WXDLLEXPORT
void wxEnablePenAppHooks (bool hook
);
124 #endif // wxUSE_PENWIN
127 #define IBS_HORZCAPTION 0x4000L
128 #define IBS_VERTCAPTION 0x8000L
130 UINT WINAPI
ibGetCaptionSize( HWND hWnd
) ;
131 UINT WINAPI
ibSetCaptionSize( HWND hWnd
, UINT nSize
) ;
132 LRESULT WINAPI
ibDefWindowProc( HWND hWnd
, UINT uiMsg
, WPARAM wParam
, LPARAM lParam
) ;
133 VOID WINAPI
ibAdjustWindowRect( HWND hWnd
, LPRECT lprc
) ;
134 #endif // wxUSE_ITSY_BITSY
137 #include "wx/msw/ctl3d/ctl3d.h"
138 #endif // wxUSE_CTL3D
141 * Decide what window classes we're going to use
142 * for this combination of CTl3D/FAFA settings
145 #define STATIC_CLASS wxT("STATIC")
146 #define STATIC_FLAGS (SS_LEFT|WS_CHILD|WS_VISIBLE)
147 #define CHECK_CLASS wxT("BUTTON")
148 #define CHECK_FLAGS (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
149 #define CHECK_IS_FAFA FALSE
150 #define RADIO_CLASS wxT("BUTTON")
151 #define RADIO_FLAGS (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
152 #define RADIO_SIZE 20
153 #define RADIO_IS_FAFA FALSE
155 #define GROUP_CLASS wxT("BUTTON")
156 #define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
159 #define BITCHECK_FLAGS (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
160 #define BITRADIO_FLAGS (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
163 // ---------------------------------------------------------------------------
165 // ---------------------------------------------------------------------------
167 #define MEANING_CHARACTER '0'
168 #define DEFAULT_ITEM_WIDTH 100
169 #define DEFAULT_ITEM_HEIGHT 80
171 // Scale font to get edit control height
172 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (3*(cy)/2)
173 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (cy+8)
175 // Generic subclass proc, for panel item moving/sizing and intercept
176 // EDIT control VK_RETURN messages
177 extern LONG APIENTRY _EXPORT
178 wxSubclassedGenericControlProc(WXHWND hWnd
, WXUINT message
, WXWPARAM wParam
, WXLPARAM lParam
);
180 // ---------------------------------------------------------------------------
181 // useful macros and functions
182 // ---------------------------------------------------------------------------
184 // a wrapper macro for ZeroMemory()
185 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
186 #define wxZeroMemory(obj) ::ZeroMemory(&obj, sizeof(obj))
188 #define wxZeroMemory(obj) memset((void*) & obj, 0, sizeof(obj))
193 #include <wx/gdicmn.h>
194 #include <wx/colour.h>
196 // make conversion from wxColour and COLORREF a bit less painful
197 inline COLORREF
wxColourToRGB(const wxColour
& c
)
199 return RGB(c
.Red(), c
.Green(), c
.Blue());
202 inline COLORREF
wxColourToPalRGB(const wxColour
& c
)
204 return PALETTERGB(c
.Red(), c
.Green(), c
.Blue());
207 inline wxColour
wxRGBToColour(COLORREF rgb
)
209 return wxColour(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
212 inline void wxRGBToColour(wxColour
& c
, COLORREF rgb
)
214 c
.Set(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
217 // get the standard colour map for some standard colours - see comment in this
218 // function to understand why is it needed and when should it be used
220 // it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
221 // might be not included/available) array of size wxSTD_COLOUR_MAX
223 // NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
224 // resources as well: it must have the same number of pixels!
230 wxSTD_COL_BTNHIGHLIGHT
,
234 struct WXDLLEXPORT wxCOLORMAP
239 // this function is implemented in src/msw/window.cpp
240 extern wxCOLORMAP
*wxGetStdColourMap();
242 // copy Windows RECT to our wxRect
243 inline void wxCopyRECTToRect(const RECT
& r
, wxRect
& rect
)
247 rect
.width
= r
.right
- r
.left
;
248 rect
.height
= r
.bottom
- r
.top
;
251 // translations between HIMETRIC units (which OLE likes) and pixels (which are
252 // liked by all the others) - implemented in msw/utilsexc.cpp
253 extern void HIMETRICToPixel(LONG
*x
, LONG
*y
);
254 extern void PixelToHIMETRIC(LONG
*x
, LONG
*y
);
256 // Windows convention of the mask is opposed to the wxWindows one, so we need
257 // to invert the mask each time we pass one/get one to/from Windows
258 extern HBITMAP
wxInvertMask(HBITMAP hbmpMask
, int w
= 0, int h
= 0);
260 // Creates an icon or cursor depending from a bitmap
262 // The bitmap must be valid and it should have a mask. If it doesn't, a default
263 // mask is created using light grey as the transparent colour.
264 extern HICON
wxBitmapToHICON(const wxBitmap
& bmp
);
266 // Same requirments as above apply and the bitmap must also have the correct
269 HCURSOR
wxBitmapToHCURSOR(const wxBitmap
& bmp
, int hotSpotX
, int hotSpotY
);
271 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
272 // will fail on system with multiple monitors where the coords may be negative
274 // these macros are standard now (Win98) but some older headers don't have them
276 #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
277 #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
278 #endif // GET_X_LPARAM
280 // get the current state of SHIFT/CTRL keys
281 inline bool wxIsShiftDown()
283 // return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
284 // Returns different negative values on WinME and WinNT,
285 // so simply test for negative value.
286 return ::GetKeyState(VK_SHIFT
) < 0;
289 inline bool wxIsCtrlDown()
291 // return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
292 // Returns different negative values on WinME and WinNT,
293 // so simply test for negative value.
294 return ::GetKeyState(VK_CONTROL
) < 0;
297 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
299 inline RECT
wxGetWindowRect(HWND hwnd
)
303 if ( !::GetWindowRect(hwnd
, &rect
) )
305 wxLogLastError(_T("GetWindowRect"));
311 inline RECT
wxGetClientRect(HWND hwnd
)
315 if ( !::GetClientRect(hwnd
, &rect
) )
317 wxLogLastError(_T("GetClientRect"));
323 // ---------------------------------------------------------------------------
324 // small helper classes
325 // ---------------------------------------------------------------------------
327 // a template to make initializing Windows styructs less painful: it zeroes all
328 // the struct fields and also sets cbSize member to the correct value (and so
329 // can be only used with structures which have this member...)
331 struct WinStruct
: public T
335 ::ZeroMemory(this, sizeof(T
));
341 // create an instance of this class and use it as the HDC for screen, will
342 // automatically release the DC going out of scope
346 ScreenHDC() { m_hdc
= ::GetDC(NULL
); }
347 ~ScreenHDC() { ::ReleaseDC(NULL
, m_hdc
); }
349 operator HDC() const { return m_hdc
; }
354 DECLARE_NO_COPY_CLASS(ScreenHDC
)
357 // the same as ScreenHDC but for memory DCs: creates the HDC compatible with
358 // the given one (screen by default) in ctor and destroys it in dtor
362 MemoryHDC(HDC hdc
= 0) { m_hdc
= ::CreateCompatibleDC(hdc
); }
363 ~MemoryHDC() { ::DeleteDC(m_hdc
); }
365 operator HDC() const { return m_hdc
; }
370 DECLARE_NO_COPY_CLASS(MemoryHDC
)
373 // a class which selects a GDI object into a DC in its ctor and deselects in
378 SelectInHDC(HDC hdc
, HGDIOBJ hgdiobj
) : m_hdc(hdc
)
379 { m_hgdiobj
= ::SelectObject(hdc
, hgdiobj
); }
381 ~SelectInHDC() { ::SelectObject(m_hdc
, m_hgdiobj
); }
383 // return true if the object was successfully selected
384 operator bool() const { return m_hgdiobj
!= 0; }
390 DECLARE_NO_COPY_CLASS(SelectInHDC
)
394 // when working with global pointers (which is unfortunately still necessary
395 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
396 // many times as we lock them which just asks for using a "smart lock" class
400 GlobalPtr(HGLOBAL hGlobal
) : m_hGlobal(hGlobal
)
402 m_ptr
= ::GlobalLock(hGlobal
);
405 wxLogLastError(_T("GlobalLock"));
411 if ( !::GlobalUnlock(m_hGlobal
) )
414 // this might happen simply because the block became unlocked
415 DWORD dwLastError
= ::GetLastError();
416 if ( dwLastError
!= NO_ERROR
)
418 wxLogApiError(_T("GlobalUnlock"), dwLastError
);
420 #endif // __WXDEBUG__
424 operator void *() const { return m_ptr
; }
430 DECLARE_NO_COPY_CLASS(GlobalPtr
)
434 // ---------------------------------------------------------------------------
435 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
436 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
437 // an argument which should be a pointer or reference to the object of the
438 // corresponding class (this depends on the macro)
439 // ---------------------------------------------------------------------------
441 #define GetHwnd() ((HWND)GetHWND())
442 #define GetHwndOf(win) ((HWND)((win)->GetHWND()))
444 #define GetWinHwnd GetHwndOf
446 #define GetHdc() ((HDC)GetHDC())
447 #define GetHdcOf(dc) ((HDC)(dc).GetHDC())
449 #define GetHbitmap() ((HBITMAP)GetHBITMAP())
450 #define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
452 #define GetHicon() ((HICON)GetHICON())
453 #define GetHiconOf(icon) ((HICON)(icon).GetHICON())
455 #define GetHaccel() ((HACCEL)GetHACCEL())
456 #define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
458 #define GetHbrush() ((HPEN)GetResourceHandle())
459 #define GetHbrushOf(brush) ((HPEN)(brush).GetResourceHandle())
461 #define GetHmenu() ((HMENU)GetHMenu())
462 #define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
464 #define GetHcursor() ((HCURSOR)GetHCURSOR())
465 #define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
467 #define GetHfont() ((HFONT)GetHFONT())
468 #define GetHfontOf(font) ((HFONT)(font).GetHFONT())
470 #define GetHpalette() ((HPALETTE)GetHPALETTE())
471 #define GetHpaletteOf(pal) ((HPALETTE)(pal).GetHPALETTE())
473 #define GetHpen() ((HPEN)GetResourceHandle())
474 #define GetHpenOf(pen) ((HPEN)(pen).GetResourceHandle())
476 #define GetHrgn() ((HRGN)GetHRGN())
477 #define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
481 // ---------------------------------------------------------------------------
483 // ---------------------------------------------------------------------------
485 WXDLLIMPEXP_DATA_BASE(extern HINSTANCE
) wxhInstance
;
487 // ---------------------------------------------------------------------------
489 // ---------------------------------------------------------------------------
493 WXDLLIMPEXP_BASE HINSTANCE
wxGetInstance();
496 WXDLLIMPEXP_BASE
void wxSetInstance(HINSTANCE hInst
);
501 extern HCURSOR
wxGetCurrentBusyCursor(); // from msw/utils.cpp
502 extern const wxCursor
*wxGetGlobalCursor(); // from msw/cursor.cpp
504 WXDLLEXPORT
void wxGetCharSize(WXHWND wnd
, int *x
, int *y
, const wxFont
*the_font
);
505 WXDLLEXPORT
void wxFillLogFont(LOGFONT
*logFont
, const wxFont
*font
);
506 WXDLLEXPORT wxFont
wxCreateFontFromLogFont(const LOGFONT
*logFont
);
507 WXDLLEXPORT wxFontEncoding
wxGetFontEncFromCharSet(int charset
);
509 WXDLLEXPORT
void wxSliderEvent(WXHWND control
, WXWORD wParam
, WXWORD pos
);
510 WXDLLEXPORT
void wxScrollBarEvent(WXHWND hbar
, WXWORD wParam
, WXWORD pos
);
512 // Find maximum size of window/rectangle
513 WXDLLEXPORT
extern void wxFindMaxSize(WXHWND hwnd
, RECT
*rect
);
515 // Safely get the window text (i.e. without using fixed size buffer)
516 WXDLLEXPORT
extern wxString
wxGetWindowText(WXHWND hWnd
);
518 // get the window class name
519 WXDLLEXPORT
extern wxString
wxGetWindowClass(WXHWND hWnd
);
521 // get the window id (should be unsigned, hence this is not wxWindowID which
522 // is, for mainly historical reasons, signed)
523 WXDLLEXPORT
extern WXWORD
wxGetWindowId(WXHWND hWnd
);
525 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
527 WXDLLEXPORT
extern bool wxCheckWindowWndProc(WXHWND hWnd
, WXFARPROC wndProc
);
529 // Does this window style specify any border?
530 inline bool wxStyleHasBorder(long style
)
532 return (style
& (wxSIMPLE_BORDER
| wxRAISED_BORDER
|
533 wxSUNKEN_BORDER
| wxDOUBLE_BORDER
)) != 0;
536 // ----------------------------------------------------------------------------
537 // functions mapping HWND to wxWindow
538 // ----------------------------------------------------------------------------
540 // this function simply checks whether the given hWnd corresponds to a wxWindow
541 // and returns either that window if it does or NULL otherwise
542 WXDLLEXPORT
extern wxWindow
* wxFindWinFromHandle(WXHWND hWnd
);
544 // find the window for HWND which is part of some wxWindow, i.e. unlike
545 // wxFindWinFromHandle() above it will also work for "sub controls" of a
548 // returns the wxWindow corresponding to the given HWND or NULL.
549 WXDLLEXPORT
extern wxWindow
*wxGetWindowFromHWND(WXHWND hwnd
);
551 // Get the size of an icon
552 WXDLLEXPORT
extern wxSize
wxGetHiconSize(HICON hicon
);
554 // Lines are drawn differently for WinCE and regular WIN32
555 WXDLLEXPORT
void wxDrawLine(HDC hdc
, int x1
, int y1
, int x2
, int y2
);
557 // LocalAlloc should be used on WinCE
561 #if _WIN32_WCE <= 211
562 #define GlobalAlloc LocalAlloc
563 #define GlobalFree LocalFree
564 #define GlobalLock(mem) mem
565 #define GlobalUnlock(mem)
566 #define GlobalSize LocalSize
569 #define GMEM_MOVEABLE 0
589 #define LMEM_FIXED 0x0000
590 #define LMEM_MOVEABLE 0x0002
591 #define LMEM_NOCOMPACT 0x0010 /**** Used for Moveable Memory ***/
592 #define LMEM_NODISCARD 0x0020 /**** Ignored *****/
593 #define LMEM_ZEROINIT 0x0040
594 #define LMEM_MODIFY 0x0080 /*** Used only in LocalReAlloc() **/
595 #define LMEM_DISCARDABLE 0x0F00 /**** Ignored ****/
596 #define LMEM_VALID_FLAGS 0x0F72
597 #define LMEM_INVALID_HANDLE 0x8000
599 #define LHND (LMEM_MOVEABLE | LMEM_ZEROINIT)
600 #define LPTR (LMEM_FIXED | LMEM_ZEROINIT)
609 // ----------------------------------------------------------------------------
611 // ----------------------------------------------------------------------------
615 inline void *wxGetWindowProc(HWND hwnd
)
617 return (void *)::GetWindowLongPtr(hwnd
, GWLP_WNDPROC
);
620 inline void *wxGetWindowUserData(HWND hwnd
)
622 return (void *)::GetWindowLongPtr(hwnd
, GWLP_USERDATA
);
625 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
627 return (WNDPROC
)::SetWindowLongPtr(hwnd
, GWLP_WNDPROC
, (LONG_PTR
)func
);
630 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
632 return (void *)::SetWindowLongPtr(hwnd
, GWLP_USERDATA
, (LONG_PTR
)data
);
637 inline void *wxGetWindowProc(HWND hwnd
)
639 return (void *)::GetWindowLong(hwnd
, GWL_WNDPROC
);
642 inline void *wxGetWindowUserData(HWND hwnd
)
644 return (void *)::GetWindowLong(hwnd
, GWL_USERDATA
);
647 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
649 return (WNDPROC
)::SetWindowLong(hwnd
, GWL_WNDPROC
, (LONG
)func
);
652 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
654 return (void *)::SetWindowLong(hwnd
, GWL_USERDATA
, (LONG
)data
);
657 #endif // __WIN64__/__WIN32__