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 // ---------------------------------------------------------------------------
50 // standard icons from the resources
51 // ---------------------------------------------------------------------------
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
;
65 // ---------------------------------------------------------------------------
66 // define things missing from some compilers' headers
67 // ---------------------------------------------------------------------------
69 #if defined(__WXWINCE__) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
71 inline void ZeroMemory(void *buf
, size_t len
) { memset(buf
, 0, len
); }
75 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
77 #if defined(STRICT) || defined(__GNUC__)
78 typedef WNDPROC WndProcCast
;
80 typedef FARPROC WndProcCast
;
84 #define CASTWNDPROC (WndProcCast)
88 // ---------------------------------------------------------------------------
89 // some stuff for old Windows versions (FIXME: what does it do here??)
90 // ---------------------------------------------------------------------------
92 #if !defined(APIENTRY) // NT defines APIENTRY, 3.x not
93 #define APIENTRY FAR PASCAL
99 #define _EXPORT _export
103 typedef signed short int SHORT
;
106 #if !defined(__WIN32__) // 3.x uses FARPROC for dialogs
108 #define DLGPROC FARPROC
113 WXDLLEXPORT
void wxRegisterPenWin();
114 WXDLLEXPORT
void wxCleanUpPenWin();
115 WXDLLEXPORT
void wxEnablePenAppHooks (bool hook
);
116 #endif // wxUSE_PENWIN
119 #define IBS_HORZCAPTION 0x4000L
120 #define IBS_VERTCAPTION 0x8000L
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
129 #include "wx/msw/ctl3d/ctl3d.h"
130 #endif // wxUSE_CTL3D
133 * Decide what window classes we're going to use
134 * for this combination of CTl3D/FAFA settings
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
147 #define GROUP_CLASS wxT("BUTTON")
148 #define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
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)
155 // ---------------------------------------------------------------------------
157 // ---------------------------------------------------------------------------
159 #define MEANING_CHARACTER '0'
160 #define DEFAULT_ITEM_WIDTH 100
161 #define DEFAULT_ITEM_HEIGHT 80
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)
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
);
172 // ---------------------------------------------------------------------------
173 // useful macros and functions
174 // ---------------------------------------------------------------------------
176 // a wrapper macro for ZeroMemory()
177 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
178 #define wxZeroMemory(obj) ::ZeroMemory(&obj, sizeof(obj))
180 #define wxZeroMemory(obj) memset((void*) & obj, 0, sizeof(obj))
185 #include <wx/gdicmn.h>
186 #include <wx/colour.h>
188 // make conversion from wxColour and COLORREF a bit less painful
189 inline COLORREF
wxColourToRGB(const wxColour
& c
)
191 return RGB(c
.Red(), c
.Green(), c
.Blue());
194 inline COLORREF
wxColourToPalRGB(const wxColour
& c
)
196 return PALETTERGB(c
.Red(), c
.Green(), c
.Blue());
199 inline wxColour
wxRGBToColour(COLORREF rgb
)
201 return wxColour(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
204 inline void wxRGBToColour(wxColour
& c
, COLORREF rgb
)
206 c
.Set(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
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
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
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!
222 wxSTD_COL_BTNHIGHLIGHT
,
226 struct WXDLLEXPORT wxCOLORMAP
231 // this function is implemented in src/msw/window.cpp
232 extern wxCOLORMAP
*wxGetStdColourMap();
234 // copy Windows RECT to our wxRect
235 inline void wxCopyRECTToRect(const RECT
& r
, wxRect
& rect
)
239 rect
.width
= r
.right
- r
.left
;
240 rect
.height
= r
.bottom
- r
.top
;
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
);
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);
252 // Creates an icon or cursor depending from a bitmap
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
);
258 // Same requirments as above apply and the bitmap must also have the correct
261 HCURSOR
wxBitmapToHCURSOR(const wxBitmap
& bmp
, int hotSpotX
, int hotSpotY
);
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
266 // these macros are standard now (Win98) but some older headers don't have them
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
272 // get the current state of SHIFT/CTRL keys
273 inline bool wxIsShiftDown()
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;
281 inline bool wxIsCtrlDown()
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;
289 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
291 inline RECT
wxGetWindowRect(HWND hwnd
)
295 if ( !::GetWindowRect(hwnd
, &rect
) )
297 wxLogLastError(_T("GetWindowRect"));
303 inline RECT
wxGetClientRect(HWND hwnd
)
307 if ( !::GetClientRect(hwnd
, &rect
) )
309 wxLogLastError(_T("GetClientRect"));
315 // ---------------------------------------------------------------------------
316 // small helper classes
317 // ---------------------------------------------------------------------------
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...)
323 struct WinStruct
: public T
327 ::ZeroMemory(this, sizeof(T
));
329 // explicit qualification is required here for this to be valid C++
330 this->cbSize
= sizeof(T
);
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
340 ScreenHDC() { m_hdc
= ::GetDC(NULL
); }
341 ~ScreenHDC() { ::ReleaseDC(NULL
, m_hdc
); }
343 operator HDC() const { return m_hdc
; }
348 DECLARE_NO_COPY_CLASS(ScreenHDC
)
351 // the same as ScreenHDC but for window DCs
355 WindowHDC(HWND hwnd
) { m_hdc
= ::GetDC(m_hwnd
= hwnd
); }
356 ~WindowHDC() { ::ReleaseDC(m_hwnd
, m_hdc
); }
358 operator HDC() const { return m_hdc
; }
364 DECLARE_NO_COPY_CLASS(WindowHDC
)
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
372 MemoryHDC(HDC hdc
= 0) { m_hdc
= ::CreateCompatibleDC(hdc
); }
373 ~MemoryHDC() { ::DeleteDC(m_hdc
); }
375 operator HDC() const { return m_hdc
; }
380 DECLARE_NO_COPY_CLASS(MemoryHDC
)
383 // a class which selects a GDI object into a DC in its ctor and deselects in
388 SelectInHDC(HDC hdc
, HGDIOBJ hgdiobj
) : m_hdc(hdc
)
389 { m_hgdiobj
= ::SelectObject(hdc
, hgdiobj
); }
391 ~SelectInHDC() { ::SelectObject(m_hdc
, m_hgdiobj
); }
393 // return true if the object was successfully selected
394 operator bool() const { return m_hgdiobj
!= 0; }
400 DECLARE_NO_COPY_CLASS(SelectInHDC
)
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
409 GlobalPtr(HGLOBAL hGlobal
) : m_hGlobal(hGlobal
)
411 m_ptr
= GlobalLock(hGlobal
);
414 wxLogLastError(_T("GlobalLock"));
420 if ( !GlobalUnlock(m_hGlobal
) )
423 // this might happen simply because the block became unlocked
424 DWORD dwLastError
= ::GetLastError();
425 if ( dwLastError
!= NO_ERROR
)
427 wxLogApiError(_T("GlobalUnlock"), dwLastError
);
429 #endif // __WXDEBUG__
433 operator void *() const { return m_ptr
; }
439 DECLARE_NO_COPY_CLASS(GlobalPtr
)
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 // ---------------------------------------------------------------------------
449 #define GetHwnd() ((HWND)GetHWND())
450 #define GetHwndOf(win) ((HWND)((win)->GetHWND()))
452 #define GetWinHwnd GetHwndOf
454 #define GetHdc() ((HDC)GetHDC())
455 #define GetHdcOf(dc) ((HDC)(dc).GetHDC())
457 #define GetHbitmap() ((HBITMAP)GetHBITMAP())
458 #define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
460 #define GetHicon() ((HICON)GetHICON())
461 #define GetHiconOf(icon) ((HICON)(icon).GetHICON())
463 #define GetHaccel() ((HACCEL)GetHACCEL())
464 #define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
466 #define GetHbrush() ((HPEN)GetResourceHandle())
467 #define GetHbrushOf(brush) ((HPEN)(brush).GetResourceHandle())
469 #define GetHmenu() ((HMENU)GetHMenu())
470 #define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
472 #define GetHcursor() ((HCURSOR)GetHCURSOR())
473 #define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
475 #define GetHfont() ((HFONT)GetHFONT())
476 #define GetHfontOf(font) ((HFONT)(font).GetHFONT())
478 #define GetHpalette() ((HPALETTE)GetHPALETTE())
479 #define GetHpaletteOf(pal) ((HPALETTE)(pal).GetHPALETTE())
481 #define GetHpen() ((HPEN)GetResourceHandle())
482 #define GetHpenOf(pen) ((HPEN)(pen).GetResourceHandle())
484 #define GetHrgn() ((HRGN)GetHRGN())
485 #define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
489 // ---------------------------------------------------------------------------
491 // ---------------------------------------------------------------------------
493 WXDLLIMPEXP_DATA_BASE(extern HINSTANCE
) wxhInstance
;
495 // ---------------------------------------------------------------------------
497 // ---------------------------------------------------------------------------
501 WXDLLIMPEXP_BASE HINSTANCE
wxGetInstance();
504 WXDLLIMPEXP_BASE
void wxSetInstance(HINSTANCE hInst
);
509 extern HCURSOR
wxGetCurrentBusyCursor(); // from msw/utils.cpp
510 extern const wxCursor
*wxGetGlobalCursor(); // from msw/cursor.cpp
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
);
517 WXDLLEXPORT
void wxSliderEvent(WXHWND control
, WXWORD wParam
, WXWORD pos
);
518 WXDLLEXPORT
void wxScrollBarEvent(WXHWND hbar
, WXWORD wParam
, WXWORD pos
);
520 // Find maximum size of window/rectangle
521 WXDLLEXPORT
extern void wxFindMaxSize(WXHWND hwnd
, RECT
*rect
);
523 // Safely get the window text (i.e. without using fixed size buffer)
524 WXDLLEXPORT
extern wxString
wxGetWindowText(WXHWND hWnd
);
526 // get the window class name
527 WXDLLEXPORT
extern wxString
wxGetWindowClass(WXHWND hWnd
);
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
);
533 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
535 WXDLLEXPORT
extern bool wxCheckWindowWndProc(WXHWND hWnd
, WXFARPROC wndProc
);
537 // Does this window style specify any border?
538 inline bool wxStyleHasBorder(long style
)
540 return (style
& (wxSIMPLE_BORDER
| wxRAISED_BORDER
|
541 wxSUNKEN_BORDER
| wxDOUBLE_BORDER
)) != 0;
544 // ----------------------------------------------------------------------------
545 // functions mapping HWND to wxWindow
546 // ----------------------------------------------------------------------------
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
);
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
556 // returns the wxWindow corresponding to the given HWND or NULL.
557 WXDLLEXPORT
extern wxWindow
*wxGetWindowFromHWND(WXHWND hwnd
);
559 // Get the size of an icon
560 WXDLLEXPORT
extern wxSize
wxGetHiconSize(HICON hicon
);
562 // Lines are drawn differently for WinCE and regular WIN32
563 WXDLLEXPORT
void wxDrawLine(HDC hdc
, int x1
, int y1
, int x2
, int y2
);
565 // ----------------------------------------------------------------------------
567 // ----------------------------------------------------------------------------
571 inline void *wxGetWindowProc(HWND hwnd
)
573 return (void *)::GetWindowLongPtr(hwnd
, GWLP_WNDPROC
);
576 inline void *wxGetWindowUserData(HWND hwnd
)
578 return (void *)::GetWindowLongPtr(hwnd
, GWLP_USERDATA
);
581 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
583 return (WNDPROC
)::SetWindowLongPtr(hwnd
, GWLP_WNDPROC
, (LONG_PTR
)func
);
586 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
588 return (void *)::SetWindowLongPtr(hwnd
, GWLP_USERDATA
, (LONG_PTR
)data
);
593 inline void *wxGetWindowProc(HWND hwnd
)
595 return (void *)::GetWindowLong(hwnd
, GWL_WNDPROC
);
598 inline void *wxGetWindowUserData(HWND hwnd
)
600 return (void *)::GetWindowLong(hwnd
, GWL_USERDATA
);
603 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
605 return (WNDPROC
)::SetWindowLong(hwnd
, GWL_WNDPROC
, (LONG
)func
);
608 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
610 return (void *)::SetWindowLong(hwnd
, GWL_USERDATA
, (LONG
)data
);
613 #endif // __WIN64__/__WIN32__