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 // ---------------------------------------------------------------------------
36 // 260 was taken from windef.h
41 // ---------------------------------------------------------------------------
42 // standard icons from the resources
43 // ---------------------------------------------------------------------------
47 extern WXDLLEXPORT_DATA(HICON
) wxSTD_FRAME_ICON
;
48 extern WXDLLEXPORT_DATA(HICON
) wxSTD_MDIPARENTFRAME_ICON
;
49 extern WXDLLEXPORT_DATA(HICON
) wxSTD_MDICHILDFRAME_ICON
;
50 extern WXDLLEXPORT_DATA(HICON
) wxDEFAULT_FRAME_ICON
;
51 extern WXDLLEXPORT_DATA(HICON
) wxDEFAULT_MDIPARENTFRAME_ICON
;
52 extern WXDLLEXPORT_DATA(HICON
) wxDEFAULT_MDICHILDFRAME_ICON
;
53 extern WXDLLEXPORT_DATA(HFONT
) wxSTATUS_LINE_FONT
;
57 // ---------------------------------------------------------------------------
59 // ---------------------------------------------------------------------------
61 extern WXDLLIMPEXP_DATA_BASE(HINSTANCE
) wxhInstance
;
63 // ---------------------------------------------------------------------------
64 // define things missing from some compilers' headers
65 // ---------------------------------------------------------------------------
67 #if defined(__WXWINCE__) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
69 inline void ZeroMemory(void *buf
, size_t len
) { memset(buf
, 0, len
); }
73 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
75 #if defined(STRICT) || defined(__GNUC__)
76 typedef WNDPROC WndProcCast
;
78 typedef FARPROC WndProcCast
;
82 #define CASTWNDPROC (WndProcCast)
86 // ---------------------------------------------------------------------------
87 // some stuff for old Windows versions (FIXME: what does it do here??)
88 // ---------------------------------------------------------------------------
90 #if !defined(APIENTRY) // NT defines APIENTRY, 3.x not
91 #define APIENTRY FAR PASCAL
97 #define _EXPORT _export
101 typedef signed short int SHORT
;
104 #if !defined(__WIN32__) // 3.x uses FARPROC for dialogs
106 #define DLGPROC FARPROC
111 WXDLLEXPORT
void wxRegisterPenWin();
112 WXDLLEXPORT
void wxCleanUpPenWin();
113 WXDLLEXPORT
void wxEnablePenAppHooks (bool hook
);
114 #endif // wxUSE_PENWIN
117 #define IBS_HORZCAPTION 0x4000L
118 #define IBS_VERTCAPTION 0x8000L
120 UINT WINAPI
ibGetCaptionSize( HWND hWnd
) ;
121 UINT WINAPI
ibSetCaptionSize( HWND hWnd
, UINT nSize
) ;
122 LRESULT WINAPI
ibDefWindowProc( HWND hWnd
, UINT uiMsg
, WPARAM wParam
, LPARAM lParam
) ;
123 VOID WINAPI
ibAdjustWindowRect( HWND hWnd
, LPRECT lprc
) ;
124 #endif // wxUSE_ITSY_BITSY
127 * Decide what window classes we're going to use
128 * for this combination of CTl3D/FAFA settings
131 #define STATIC_CLASS wxT("STATIC")
132 #define STATIC_FLAGS (SS_LEFT|WS_CHILD|WS_VISIBLE)
133 #define CHECK_CLASS wxT("BUTTON")
134 #define CHECK_FLAGS (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
135 #define CHECK_IS_FAFA FALSE
136 #define RADIO_CLASS wxT("BUTTON")
137 #define RADIO_FLAGS (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
138 #define RADIO_SIZE 20
139 #define RADIO_IS_FAFA FALSE
141 #define GROUP_CLASS wxT("BUTTON")
142 #define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
145 #define BITCHECK_FLAGS (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
146 #define BITRADIO_FLAGS (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
149 // ---------------------------------------------------------------------------
151 // ---------------------------------------------------------------------------
153 #define MEANING_CHARACTER '0'
154 #define DEFAULT_ITEM_WIDTH 100
155 #define DEFAULT_ITEM_HEIGHT 80
157 // Scale font to get edit control height
158 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (3*(cy)/2)
159 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (cy+8)
161 // Generic subclass proc, for panel item moving/sizing and intercept
162 // EDIT control VK_RETURN messages
163 extern LONG APIENTRY _EXPORT
164 wxSubclassedGenericControlProc(WXHWND hWnd
, WXUINT message
, WXWPARAM wParam
, WXLPARAM lParam
);
166 // ---------------------------------------------------------------------------
167 // useful macros and functions
168 // ---------------------------------------------------------------------------
170 // a wrapper macro for ZeroMemory()
171 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
172 #define wxZeroMemory(obj) ::ZeroMemory(&obj, sizeof(obj))
174 #define wxZeroMemory(obj) memset((void*) & obj, 0, sizeof(obj))
177 // This one is a macro so that it can be tested with #ifdef, it will be
178 // undefined if it cannot be implemented for a given compiler.
179 // Vc++, bcc, dmc, ow, mingw, codewarrior (and rsxnt) have _get_osfhandle.
180 // Cygwin has get_osfhandle. Others are currently unknown, e.g. Salford,
181 // Intel, Visual Age.
182 #if defined(__WXWINCE__)
183 #define wxGetOSFHandle(fd) ((HANDLE)fd)
184 #elif defined(__CYGWIN__)
185 #define wxGetOSFHandle(fd) ((HANDLE)get_osfhandle(fd))
186 #elif defined(__VISUALC__) \
187 || defined(__BORLANDC__) \
188 || defined(__DMC__) \
189 || defined(__WATCOMC__) \
190 || (defined(__GNUWIN32__) || defined(__MINGW32__)) \
191 || (defined(__MWERKS__) && defined(__MSL__))
192 #define wxGetOSFHandle(fd) ((HANDLE)_get_osfhandle(fd))
197 #include <wx/gdicmn.h>
198 #include <wx/colour.h>
200 // make conversion from wxColour and COLORREF a bit less painful
201 inline COLORREF
wxColourToRGB(const wxColour
& c
)
203 return RGB(c
.Red(), c
.Green(), c
.Blue());
206 inline COLORREF
wxColourToPalRGB(const wxColour
& c
)
208 return PALETTERGB(c
.Red(), c
.Green(), c
.Blue());
211 inline wxColour
wxRGBToColour(COLORREF rgb
)
213 return wxColour(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
216 inline void wxRGBToColour(wxColour
& c
, COLORREF rgb
)
218 c
.Set(GetRValue(rgb
), GetGValue(rgb
), GetBValue(rgb
));
221 // get the standard colour map for some standard colours - see comment in this
222 // function to understand why is it needed and when should it be used
224 // it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
225 // might be not included/available) array of size wxSTD_COLOUR_MAX
227 // NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
228 // resources as well: it must have the same number of pixels!
234 wxSTD_COL_BTNHIGHLIGHT
,
238 struct WXDLLEXPORT wxCOLORMAP
243 // this function is implemented in src/msw/window.cpp
244 extern wxCOLORMAP
*wxGetStdColourMap();
246 // create a wxRect from Windows RECT
247 inline wxRect
wxRectFromRECT(const RECT
& r
)
249 return wxRect(r
.left
, r
.top
, r
.right
- r
.left
, r
.bottom
- r
.top
);
252 // copy Windows RECT to our wxRect
253 inline void wxCopyRECTToRect(const RECT
& r
, wxRect
& rect
)
255 rect
= wxRectFromRECT(r
);
258 // translations between HIMETRIC units (which OLE likes) and pixels (which are
259 // liked by all the others) - implemented in msw/utilsexc.cpp
260 extern void HIMETRICToPixel(LONG
*x
, LONG
*y
);
261 extern void PixelToHIMETRIC(LONG
*x
, LONG
*y
);
263 // Windows convention of the mask is opposed to the wxWidgets one, so we need
264 // to invert the mask each time we pass one/get one to/from Windows
265 extern HBITMAP
wxInvertMask(HBITMAP hbmpMask
, int w
= 0, int h
= 0);
267 // Creates an icon or cursor depending from a bitmap
269 // The bitmap must be valid and it should have a mask. If it doesn't, a default
270 // mask is created using light grey as the transparent colour.
271 extern HICON
wxBitmapToHICON(const wxBitmap
& bmp
);
273 // Same requirments as above apply and the bitmap must also have the correct
276 HCURSOR
wxBitmapToHCURSOR(const wxBitmap
& bmp
, int hotSpotX
, int hotSpotY
);
278 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
279 // will fail on system with multiple monitors where the coords may be negative
281 // these macros are standard now (Win98) but some older headers don't have them
283 #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
284 #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
285 #endif // GET_X_LPARAM
287 // get the current state of SHIFT/CTRL keys
288 inline bool wxIsShiftDown()
290 // return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
291 // Returns different negative values on WinME and WinNT,
292 // so simply test for negative value.
293 return ::GetKeyState(VK_SHIFT
) < 0;
296 inline bool wxIsCtrlDown()
298 // return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
299 // Returns different negative values on WinME and WinNT,
300 // so simply test for negative value.
301 return ::GetKeyState(VK_CONTROL
) < 0;
304 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
306 inline RECT
wxGetWindowRect(HWND hwnd
)
310 if ( !::GetWindowRect(hwnd
, &rect
) )
312 wxLogLastError(_T("GetWindowRect"));
318 inline RECT
wxGetClientRect(HWND hwnd
)
322 if ( !::GetClientRect(hwnd
, &rect
) )
324 wxLogLastError(_T("GetClientRect"));
330 // ---------------------------------------------------------------------------
331 // small helper classes
332 // ---------------------------------------------------------------------------
334 // a template to make initializing Windows styructs less painful: it zeroes all
335 // the struct fields and also sets cbSize member to the correct value (and so
336 // can be only used with structures which have this member...)
338 struct WinStruct
: public T
342 ::ZeroMemory(this, sizeof(T
));
344 // explicit qualification is required here for this to be valid C++
345 this->cbSize
= sizeof(T
);
350 // create an instance of this class and use it as the HDC for screen, will
351 // automatically release the DC going out of scope
355 ScreenHDC() { m_hdc
= ::GetDC(NULL
); }
356 ~ScreenHDC() { ::ReleaseDC(NULL
, m_hdc
); }
358 operator HDC() const { return m_hdc
; }
363 DECLARE_NO_COPY_CLASS(ScreenHDC
)
366 // the same as ScreenHDC but for window DCs
370 WindowHDC(HWND hwnd
) { m_hdc
= ::GetDC(m_hwnd
= hwnd
); }
371 ~WindowHDC() { ::ReleaseDC(m_hwnd
, m_hdc
); }
373 operator HDC() const { return m_hdc
; }
379 DECLARE_NO_COPY_CLASS(WindowHDC
)
382 // the same as ScreenHDC but for memory DCs: creates the HDC compatible with
383 // the given one (screen by default) in ctor and destroys it in dtor
387 MemoryHDC(HDC hdc
= 0) { m_hdc
= ::CreateCompatibleDC(hdc
); }
388 ~MemoryHDC() { ::DeleteDC(m_hdc
); }
390 operator HDC() const { return m_hdc
; }
395 DECLARE_NO_COPY_CLASS(MemoryHDC
)
398 // a class which selects a GDI object into a DC in its ctor and deselects in
403 SelectInHDC(HDC hdc
, HGDIOBJ hgdiobj
) : m_hdc(hdc
)
404 { m_hgdiobj
= ::SelectObject(hdc
, hgdiobj
); }
406 ~SelectInHDC() { ::SelectObject(m_hdc
, m_hgdiobj
); }
408 // return true if the object was successfully selected
409 operator bool() const { return m_hgdiobj
!= 0; }
415 DECLARE_NO_COPY_CLASS(SelectInHDC
)
418 // a class for temporary bitmaps
419 class CompatibleBitmap
422 CompatibleBitmap(HDC hdc
, int w
, int h
)
424 m_hbmp
= ::CreateCompatibleBitmap(hdc
, w
, h
);
430 ::DeleteObject(m_hbmp
);
433 operator HBITMAP() const { return m_hbmp
; }
439 // when working with global pointers (which is unfortunately still necessary
440 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
441 // many times as we lock them which just asks for using a "smart lock" class
445 GlobalPtr(HGLOBAL hGlobal
) : m_hGlobal(hGlobal
)
447 m_ptr
= GlobalLock(hGlobal
);
450 wxLogLastError(_T("GlobalLock"));
456 if ( !GlobalUnlock(m_hGlobal
) )
459 // this might happen simply because the block became unlocked
460 DWORD dwLastError
= ::GetLastError();
461 if ( dwLastError
!= NO_ERROR
)
463 wxLogApiError(_T("GlobalUnlock"), dwLastError
);
465 #endif // __WXDEBUG__
469 operator void *() const { return m_ptr
; }
475 DECLARE_NO_COPY_CLASS(GlobalPtr
)
478 // register the class when it is first needed and unregister it in dtor
482 // ctor doesn't register the class, call Initialize() for this
483 ClassRegistrar() { m_registered
= -1; }
485 // return true if the class is already registered
486 bool IsInitialized() const { return m_registered
!= -1; }
488 // return true if the class had been already registered
489 bool IsRegistered() const { return m_registered
== 1; }
491 // try to register the class if not done yet, return true on success
492 bool Register(const WNDCLASS
& wc
)
494 // we should only be called if we hadn't been initialized yet
495 wxASSERT_MSG( m_registered
== -1,
496 _T("calling ClassRegistrar::Register() twice?") );
498 m_registered
= ::RegisterClass(&wc
) ? 1 : 0;
499 if ( !IsRegistered() )
501 wxLogLastError(_T("RegisterClassEx()"));
505 m_clsname
= wc
.lpszClassName
;
508 return m_registered
== 1;
511 // get the name of the registered class (returns empty string if not
513 const wxString
& GetName() const { return m_clsname
; }
515 // unregister the class if it had been registered
518 if ( IsRegistered() )
520 if ( !::UnregisterClass(m_clsname
, wxhInstance
) )
522 wxLogLastError(_T("UnregisterClass"));
528 // initial value is -1 which means that we hadn't tried registering the
529 // class yet, it becomes true or false (1 or 0) when Initialize() is called
532 // the name of the class, only non empty if it had been registered
536 // ---------------------------------------------------------------------------
537 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
538 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
539 // an argument which should be a pointer or reference to the object of the
540 // corresponding class (this depends on the macro)
541 // ---------------------------------------------------------------------------
543 #define GetHwnd() ((HWND)GetHWND())
544 #define GetHwndOf(win) ((HWND)((win)->GetHWND()))
546 #define GetWinHwnd GetHwndOf
548 #define GetHdc() ((HDC)GetHDC())
549 #define GetHdcOf(dc) ((HDC)(dc).GetHDC())
551 #define GetHbitmap() ((HBITMAP)GetHBITMAP())
552 #define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
554 #define GetHicon() ((HICON)GetHICON())
555 #define GetHiconOf(icon) ((HICON)(icon).GetHICON())
557 #define GetHaccel() ((HACCEL)GetHACCEL())
558 #define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
560 #define GetHbrush() ((HPEN)GetResourceHandle())
561 #define GetHbrushOf(brush) ((HPEN)(brush).GetResourceHandle())
563 #define GetHmenu() ((HMENU)GetHMenu())
564 #define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
566 #define GetHcursor() ((HCURSOR)GetHCURSOR())
567 #define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
569 #define GetHfont() ((HFONT)GetHFONT())
570 #define GetHfontOf(font) ((HFONT)(font).GetHFONT())
572 #define GetHimagelist() ((HIMAGELIST)GetHIMAGELIST())
573 #define GetHimagelistOf(imgl) ((HIMAGELIST)imgl->GetHIMAGELIST())
575 #define GetHpalette() ((HPALETTE)GetHPALETTE())
576 #define GetHpaletteOf(pal) ((HPALETTE)(pal).GetHPALETTE())
578 #define GetHpen() ((HPEN)GetResourceHandle())
579 #define GetHpenOf(pen) ((HPEN)(pen).GetResourceHandle())
581 #define GetHrgn() ((HRGN)GetHRGN())
582 #define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
586 // ---------------------------------------------------------------------------
588 // ---------------------------------------------------------------------------
592 WXDLLIMPEXP_BASE HINSTANCE
wxGetInstance();
595 WXDLLIMPEXP_BASE
void wxSetInstance(HINSTANCE hInst
);
597 // return the full path of the given module
598 inline wxString
wxGetFullModuleName(HMODULE hmod
)
601 if ( !::GetModuleFileName
604 wxStringBuffer(fullname
, MAX_PATH
),
608 wxLogLastError(_T("GetModuleFileName"));
614 // return the full path of the program file
615 inline wxString
wxGetFullModuleName()
617 return wxGetFullModuleName((HMODULE
)wxGetInstance());
623 extern HCURSOR
wxGetCurrentBusyCursor(); // from msw/utils.cpp
624 extern const wxCursor
*wxGetGlobalCursor(); // from msw/cursor.cpp
626 WXDLLEXPORT
void wxGetCharSize(WXHWND wnd
, int *x
, int *y
, const wxFont
& the_font
);
627 WXDLLEXPORT
void wxFillLogFont(LOGFONT
*logFont
, const wxFont
*font
);
628 WXDLLEXPORT wxFont
wxCreateFontFromLogFont(const LOGFONT
*logFont
);
629 WXDLLEXPORT wxFontEncoding
wxGetFontEncFromCharSet(int charset
);
631 WXDLLEXPORT
void wxSliderEvent(WXHWND control
, WXWORD wParam
, WXWORD pos
);
632 WXDLLEXPORT
void wxScrollBarEvent(WXHWND hbar
, WXWORD wParam
, WXWORD pos
);
634 // Find maximum size of window/rectangle
635 extern WXDLLEXPORT
void wxFindMaxSize(WXHWND hwnd
, RECT
*rect
);
637 // Safely get the window text (i.e. without using fixed size buffer)
638 extern WXDLLEXPORT wxString
wxGetWindowText(WXHWND hWnd
);
640 // get the window class name
641 extern WXDLLEXPORT wxString
wxGetWindowClass(WXHWND hWnd
);
643 // get the window id (should be unsigned, hence this is not wxWindowID which
644 // is, for mainly historical reasons, signed)
645 extern WXDLLEXPORT WXWORD
wxGetWindowId(WXHWND hWnd
);
647 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
649 extern WXDLLEXPORT
bool wxCheckWindowWndProc(WXHWND hWnd
, WXFARPROC wndProc
);
651 // Does this window style specify any border?
652 inline bool wxStyleHasBorder(long style
)
654 return (style
& (wxSIMPLE_BORDER
| wxRAISED_BORDER
|
655 wxSUNKEN_BORDER
| wxDOUBLE_BORDER
)) != 0;
658 // ----------------------------------------------------------------------------
659 // functions mapping HWND to wxWindow
660 // ----------------------------------------------------------------------------
662 // this function simply checks whether the given hWnd corresponds to a wxWindow
663 // and returns either that window if it does or NULL otherwise
664 extern WXDLLEXPORT wxWindow
* wxFindWinFromHandle(WXHWND hWnd
);
666 // find the window for HWND which is part of some wxWindow, i.e. unlike
667 // wxFindWinFromHandle() above it will also work for "sub controls" of a
670 // returns the wxWindow corresponding to the given HWND or NULL.
671 extern WXDLLEXPORT wxWindow
*wxGetWindowFromHWND(WXHWND hwnd
);
673 // Get the size of an icon
674 extern WXDLLEXPORT wxSize
wxGetHiconSize(HICON hicon
);
676 // Lines are drawn differently for WinCE and regular WIN32
677 WXDLLEXPORT
void wxDrawLine(HDC hdc
, int x1
, int y1
, int x2
, int y2
);
679 // ----------------------------------------------------------------------------
681 // ----------------------------------------------------------------------------
685 inline void *wxGetWindowProc(HWND hwnd
)
687 return (void *)::GetWindowLongPtr(hwnd
, GWLP_WNDPROC
);
690 inline void *wxGetWindowUserData(HWND hwnd
)
692 return (void *)::GetWindowLongPtr(hwnd
, GWLP_USERDATA
);
695 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
697 return (WNDPROC
)::SetWindowLongPtr(hwnd
, GWLP_WNDPROC
, (LONG_PTR
)func
);
700 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
702 return (void *)::SetWindowLongPtr(hwnd
, GWLP_USERDATA
, (LONG_PTR
)data
);
708 // strangely enough, VC++ 7.1 gives warnings about 32 -> 64 bit conversions
709 // in the functions below, even in spite of the explicit casts
710 #pragma warning(disable:4311)
711 #pragma warning(disable:4312)
714 inline void *wxGetWindowProc(HWND hwnd
)
716 return (void *)::GetWindowLong(hwnd
, GWL_WNDPROC
);
719 inline void *wxGetWindowUserData(HWND hwnd
)
721 return (void *)::GetWindowLong(hwnd
, GWL_USERDATA
);
724 inline WNDPROC
wxSetWindowProc(HWND hwnd
, WNDPROC func
)
726 return (WNDPROC
)::SetWindowLong(hwnd
, GWL_WNDPROC
, (LONG
)func
);
729 inline void *wxSetWindowUserData(HWND hwnd
, void *data
)
731 return (void *)::SetWindowLong(hwnd
, GWL_USERDATA
, (LONG
)data
);
735 #pragma warning(default:4311)
736 #pragma warning(default:4312)
739 #endif // __WIN64__/__WIN32__