1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Private declarations: as this header is only included by
4 // wxWidgets 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"
20 // Extra prototypes and symbols not defined by MicroWindows
21 #include "wx/msw/microwin.h"
24 // Include fixes for MSLU:
25 #include "wx/msw/mslu.h"
29 class WXDLLEXPORT wxFont
;
30 class WXDLLEXPORT wxWindow
;
32 // ---------------------------------------------------------------------------
34 // ---------------------------------------------------------------------------
37 static const double METRIC_CONVERSION_CONSTANT
= 0.0393700787;
39 // Scaling factors for various unit conversions
40 static const double mm2inches
= (METRIC_CONVERSION_CONSTANT
);
41 static const double inches2mm
= (1/METRIC_CONVERSION_CONSTANT
);
43 static const double mm2twips
= (METRIC_CONVERSION_CONSTANT
*1440);
44 static const double twips2mm
= (1/(METRIC_CONVERSION_CONSTANT
*1440));
46 static const double mm2pt
= (METRIC_CONVERSION_CONSTANT
*72);
47 static const double pt2mm
= (1/(METRIC_CONVERSION_CONSTANT
*72));
49 // 260 was taken from windef.h
54 // ---------------------------------------------------------------------------
55 // standard icons from the resources
56 // ---------------------------------------------------------------------------
60 WXDLLEXPORT_DATA(extern HICON
) wxSTD_FRAME_ICON
;
61 WXDLLEXPORT_DATA(extern HICON
) wxSTD_MDIPARENTFRAME_ICON
;
62 WXDLLEXPORT_DATA(extern HICON
) wxSTD_MDICHILDFRAME_ICON
;
63 WXDLLEXPORT_DATA(extern HICON
) wxDEFAULT_FRAME_ICON
;
64 WXDLLEXPORT_DATA(extern HICON
) wxDEFAULT_MDIPARENTFRAME_ICON
;
65 WXDLLEXPORT_DATA(extern HICON
) wxDEFAULT_MDICHILDFRAME_ICON
;
66 WXDLLEXPORT_DATA(extern HFONT
) wxSTATUS_LINE_FONT
;
70 // ---------------------------------------------------------------------------
71 // define things missing from some compilers' headers
72 // ---------------------------------------------------------------------------
74 #if defined(__WXWINCE__) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
76 inline void ZeroMemory(void *buf
, size_t len
) { memset(buf
, 0, len
); }
80 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
82 #if defined(STRICT) || defined(__GNUC__)
83 typedef WNDPROC WndProcCast
;
85 typedef FARPROC WndProcCast
;
89 #define CASTWNDPROC (WndProcCast)
93 // ---------------------------------------------------------------------------
94 // some stuff for old Windows versions (FIXME: what does it do here??)
95 // ---------------------------------------------------------------------------
97 #if !defined(APIENTRY) // NT defines APIENTRY, 3.x not
98 #define APIENTRY FAR PASCAL
104 #define _EXPORT _export
108 typedef signed short int SHORT
;
111 #if !defined(__WIN32__) // 3.x uses FARPROC for dialogs
113 #define DLGPROC FARPROC
118 WXDLLEXPORT
void wxRegisterPenWin();
119 WXDLLEXPORT
void wxCleanUpPenWin();
120 WXDLLEXPORT
void wxEnablePenAppHooks (bool hook
);
121 #endif // wxUSE_PENWIN
124 #define IBS_HORZCAPTION 0x4000L
125 #define IBS_VERTCAPTION 0x8000L
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
134 #include "wx/msw/ctl3d/ctl3d.h"
135 #endif // wxUSE_CTL3D
138 * Decide what window classes we're going to use
139 * for this combination of CTl3D/FAFA settings
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
152 #define GROUP_CLASS wxT("BUTTON")
153 #define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
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)
160 // ---------------------------------------------------------------------------
162 // ---------------------------------------------------------------------------
164 #define MEANING_CHARACTER '0'
165 #define DEFAULT_ITEM_WIDTH 100
166 #define DEFAULT_ITEM_HEIGHT 80
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)
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
);
177 // ---------------------------------------------------------------------------
178 // useful macros and functions
179 // ---------------------------------------------------------------------------
181 // a wrapper macro for ZeroMemory()
182 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
183 #define wxZeroMemory(obj) ::ZeroMemory(&obj, sizeof(obj))
185 #define wxZeroMemory(obj) memset((void*) & obj, 0, sizeof(obj))
190 #include <wx/gdicmn.h>
191 #include <wx/colour.h>
193 // make conversion from wxColour and COLORREF a bit less painful
194 inline COLORREF
wxColourToRGB(const wxColour
& c
)
196 return RGB(c
.Red(), c
.Green(), c
.Blue());
199 inline COLORREF
wxColourToPalRGB(const wxColour
& c
)
201 return PALETTERGB(c
.Red(), c
.Green(), c
.Blue());
204 inline wxColour
wxRGBToColour(COLORREF rgb
)
206 return wxColour(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
209 inline void wxRGBToColour(wxColour
& c
, COLORREF rgb
)
211 c
.Set(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
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
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
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!
227 wxSTD_COL_BTNHIGHLIGHT
,
231 struct WXDLLEXPORT wxCOLORMAP
236 // this function is implemented in src/msw/window.cpp
237 extern wxCOLORMAP
*wxGetStdColourMap();
239 // create a wxRect from Windows RECT
240 inline wxRect
wxRectFromRECT(const RECT
& r
)
242 return wxRect(r
.left
, r
.top
, r
.right
- r
.left
, r
.bottom
- r
.top
);
245 // copy Windows RECT to our wxRect
246 inline void wxCopyRECTToRect(const RECT
& r
, wxRect
& rect
)
248 rect
= wxRectFromRECT(r
);
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 wxWidgets 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
));
337 // explicit qualification is required here for this to be valid C++
338 this->cbSize
= sizeof(T
);
343 // create an instance of this class and use it as the HDC for screen, will
344 // automatically release the DC going out of scope
348 ScreenHDC() { m_hdc
= ::GetDC(NULL
); }
349 ~ScreenHDC() { ::ReleaseDC(NULL
, m_hdc
); }
351 operator HDC() const { return m_hdc
; }
356 DECLARE_NO_COPY_CLASS(ScreenHDC
)
359 // the same as ScreenHDC but for window DCs
363 WindowHDC(HWND hwnd
) { m_hdc
= ::GetDC(m_hwnd
= hwnd
); }
364 ~WindowHDC() { ::ReleaseDC(m_hwnd
, m_hdc
); }
366 operator HDC() const { return m_hdc
; }
372 DECLARE_NO_COPY_CLASS(WindowHDC
)
375 // the same as ScreenHDC but for memory DCs: creates the HDC compatible with
376 // the given one (screen by default) in ctor and destroys it in dtor
380 MemoryHDC(HDC hdc
= 0) { m_hdc
= ::CreateCompatibleDC(hdc
); }
381 ~MemoryHDC() { ::DeleteDC(m_hdc
); }
383 operator HDC() const { return m_hdc
; }
388 DECLARE_NO_COPY_CLASS(MemoryHDC
)
391 // a class which selects a GDI object into a DC in its ctor and deselects in
396 SelectInHDC(HDC hdc
, HGDIOBJ hgdiobj
) : m_hdc(hdc
)
397 { m_hgdiobj
= ::SelectObject(hdc
, hgdiobj
); }
399 ~SelectInHDC() { ::SelectObject(m_hdc
, m_hgdiobj
); }
401 // return true if the object was successfully selected
402 operator bool() const { return m_hgdiobj
!= 0; }
408 DECLARE_NO_COPY_CLASS(SelectInHDC
)
411 // a class for temporary bitmaps
412 class CompatibleBitmap
415 CompatibleBitmap(HDC hdc
, int w
, int h
)
417 m_hbmp
= ::CreateCompatibleBitmap(hdc
, w
, h
);
423 ::DeleteObject(m_hbmp
);
426 operator HBITMAP() const { return m_hbmp
; }
432 // when working with global pointers (which is unfortunately still necessary
433 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
434 // many times as we lock them which just asks for using a "smart lock" class
438 GlobalPtr(HGLOBAL hGlobal
) : m_hGlobal(hGlobal
)
440 m_ptr
= GlobalLock(hGlobal
);
443 wxLogLastError(_T("GlobalLock"));
449 if ( !GlobalUnlock(m_hGlobal
) )
452 // this might happen simply because the block became unlocked
453 DWORD dwLastError
= ::GetLastError();
454 if ( dwLastError
!= NO_ERROR
)
456 wxLogApiError(_T("GlobalUnlock"), dwLastError
);
458 #endif // __WXDEBUG__
462 operator void *() const { return m_ptr
; }
468 DECLARE_NO_COPY_CLASS(GlobalPtr
)
471 // ---------------------------------------------------------------------------
472 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
473 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
474 // an argument which should be a pointer or reference to the object of the
475 // corresponding class (this depends on the macro)
476 // ---------------------------------------------------------------------------
478 #define GetHwnd() ((HWND)GetHWND())
479 #define GetHwndOf(win) ((HWND)((win)->GetHWND()))
481 #define GetWinHwnd GetHwndOf
483 #define GetHdc() ((HDC)GetHDC())
484 #define GetHdcOf(dc) ((HDC)(dc).GetHDC())
486 #define GetHbitmap() ((HBITMAP)GetHBITMAP())
487 #define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
489 #define GetHicon() ((HICON)GetHICON())
490 #define GetHiconOf(icon) ((HICON)(icon).GetHICON())
492 #define GetHaccel() ((HACCEL)GetHACCEL())
493 #define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
495 #define GetHbrush() ((HPEN)GetResourceHandle())
496 #define GetHbrushOf(brush) ((HPEN)(brush).GetResourceHandle())
498 #define GetHmenu() ((HMENU)GetHMenu())
499 #define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
501 #define GetHcursor() ((HCURSOR)GetHCURSOR())
502 #define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
504 #define GetHfont() ((HFONT)GetHFONT())
505 #define GetHfontOf(font) ((HFONT)(font).GetHFONT())
507 #define GetHpalette() ((HPALETTE)GetHPALETTE())
508 #define GetHpaletteOf(pal) ((HPALETTE)(pal).GetHPALETTE())
510 #define GetHpen() ((HPEN)GetResourceHandle())
511 #define GetHpenOf(pen) ((HPEN)(pen).GetResourceHandle())
513 #define GetHrgn() ((HRGN)GetHRGN())
514 #define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
518 // ---------------------------------------------------------------------------
520 // ---------------------------------------------------------------------------
522 WXDLLIMPEXP_DATA_BASE(extern HINSTANCE
) wxhInstance
;
524 // ---------------------------------------------------------------------------
526 // ---------------------------------------------------------------------------
530 WXDLLIMPEXP_BASE HINSTANCE
wxGetInstance();
533 WXDLLIMPEXP_BASE
void wxSetInstance(HINSTANCE hInst
);
535 // return the full name of the program file
536 inline wxString
wxGetFullModuleName()
539 if ( !::GetModuleFileName
541 (HMODULE
)wxGetInstance(),
542 wxStringBuffer(fullname
, MAX_PATH
),
546 wxLogLastError(_T("GetModuleFileName"));
555 extern HCURSOR
wxGetCurrentBusyCursor(); // from msw/utils.cpp
556 extern const wxCursor
*wxGetGlobalCursor(); // from msw/cursor.cpp
558 WXDLLEXPORT
void wxGetCharSize(WXHWND wnd
, int *x
, int *y
, const wxFont
& the_font
);
559 WXDLLEXPORT
void wxFillLogFont(LOGFONT
*logFont
, const wxFont
*font
);
560 WXDLLEXPORT wxFont
wxCreateFontFromLogFont(const LOGFONT
*logFont
);
561 WXDLLEXPORT wxFontEncoding
wxGetFontEncFromCharSet(int charset
);
563 WXDLLEXPORT
void wxSliderEvent(WXHWND control
, WXWORD wParam
, WXWORD pos
);
564 WXDLLEXPORT
void wxScrollBarEvent(WXHWND hbar
, WXWORD wParam
, WXWORD pos
);
566 // Find maximum size of window/rectangle
567 WXDLLEXPORT
extern void wxFindMaxSize(WXHWND hwnd
, RECT
*rect
);
569 // Safely get the window text (i.e. without using fixed size buffer)
570 WXDLLEXPORT
extern wxString
wxGetWindowText(WXHWND hWnd
);
572 // get the window class name
573 WXDLLEXPORT
extern wxString
wxGetWindowClass(WXHWND hWnd
);
575 // get the window id (should be unsigned, hence this is not wxWindowID which
576 // is, for mainly historical reasons, signed)
577 WXDLLEXPORT
extern WXWORD
wxGetWindowId(WXHWND hWnd
);
579 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
581 WXDLLEXPORT
extern bool wxCheckWindowWndProc(WXHWND hWnd
, WXFARPROC wndProc
);
583 // Does this window style specify any border?
584 inline bool wxStyleHasBorder(long style
)
586 return (style
& (wxSIMPLE_BORDER
| wxRAISED_BORDER
|
587 wxSUNKEN_BORDER
| wxDOUBLE_BORDER
)) != 0;
590 // ----------------------------------------------------------------------------
591 // functions mapping HWND to wxWindow
592 // ----------------------------------------------------------------------------
594 // this function simply checks whether the given hWnd corresponds to a wxWindow
595 // and returns either that window if it does or NULL otherwise
596 WXDLLEXPORT
extern wxWindow
* wxFindWinFromHandle(WXHWND hWnd
);
598 // find the window for HWND which is part of some wxWindow, i.e. unlike
599 // wxFindWinFromHandle() above it will also work for "sub controls" of a
602 // returns the wxWindow corresponding to the given HWND or NULL.
603 WXDLLEXPORT
extern wxWindow
*wxGetWindowFromHWND(WXHWND hwnd
);
605 // Get the size of an icon
606 WXDLLEXPORT
extern wxSize
wxGetHiconSize(HICON hicon
);
608 // Lines are drawn differently for WinCE and regular WIN32
609 WXDLLEXPORT
void wxDrawLine(HDC hdc
, int x1
, int y1
, int x2
, int y2
);
611 // ----------------------------------------------------------------------------
613 // ----------------------------------------------------------------------------
617 inline void *wxGetWindowProc(HWND hwnd
)
619 return (void *)::GetWindowLongPtr(hwnd
, GWLP_WNDPROC
);
622 inline void *wxGetWindowUserData(HWND hwnd
)
624 return (void *)::GetWindowLongPtr(hwnd
, GWLP_USERDATA
);
627 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
629 return (WNDPROC
)::SetWindowLongPtr(hwnd
, GWLP_WNDPROC
, (LONG_PTR
)func
);
632 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
634 return (void *)::SetWindowLongPtr(hwnd
, GWLP_USERDATA
, (LONG_PTR
)data
);
640 // strangely enough, VC++ 7.1 gives warnings about 32 -> 64 bit conversions
641 // in the functions below, even in spite of the explicit casts
642 #pragma warning(disable:4311)
643 #pragma warning(disable:4312)
646 inline void *wxGetWindowProc(HWND hwnd
)
648 return (void *)::GetWindowLong(hwnd
, GWL_WNDPROC
);
651 inline void *wxGetWindowUserData(HWND hwnd
)
653 return (void *)::GetWindowLong(hwnd
, GWL_USERDATA
);
656 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
658 return (WNDPROC
)::SetWindowLong(hwnd
, GWL_WNDPROC
, (LONG
)func
);
661 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
663 return (void *)::SetWindowLong(hwnd
, GWL_USERDATA
, (LONG
)data
);
667 #pragma warning(default:4311)
668 #pragma warning(default:4312)
671 #endif // __WIN64__/__WIN32__