]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/private.h
applied ANI images patch and added wxUSE_ICO_CUR
[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 #ifndef STRICT
18 #define STRICT 1
19 #endif
20
21 #include <windows.h>
22
23 #ifdef __WXMICROWIN__
24 // Extra prototypes and symbols not defined by MicroWindows
25 #include "wx/msw/microwin.h"
26 #endif
27
28 // undefine conflicting symbols which were defined in windows.h
29 #include "wx/msw/winundef.h"
30
31 #include "wx/log.h"
32
33 class WXDLLEXPORT wxFont;
34 class WXDLLEXPORT wxWindow;
35
36 // ---------------------------------------------------------------------------
37 // private constants
38 // ---------------------------------------------------------------------------
39
40 // Conversion
41 static const double METRIC_CONVERSION_CONSTANT = 0.0393700787;
42
43 // Scaling factors for various unit conversions
44 static const double mm2inches = (METRIC_CONVERSION_CONSTANT);
45 static const double inches2mm = (1/METRIC_CONVERSION_CONSTANT);
46
47 static const double mm2twips = (METRIC_CONVERSION_CONSTANT*1440);
48 static const double twips2mm = (1/(METRIC_CONVERSION_CONSTANT*1440));
49
50 static const double mm2pt = (METRIC_CONVERSION_CONSTANT*72);
51 static const double pt2mm = (1/(METRIC_CONVERSION_CONSTANT*72));
52
53 // ---------------------------------------------------------------------------
54 // standard icons from the resources
55 // ---------------------------------------------------------------------------
56
57 #if wxUSE_GUI
58
59 WXDLLEXPORT_DATA(extern HICON) wxSTD_FRAME_ICON;
60 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDIPARENTFRAME_ICON;
61 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDICHILDFRAME_ICON;
62 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_FRAME_ICON;
63 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDIPARENTFRAME_ICON;
64 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDICHILDFRAME_ICON;
65 WXDLLEXPORT_DATA(extern HFONT) wxSTATUS_LINE_FONT;
66
67 #endif // wxUSE_GUI
68
69 // ---------------------------------------------------------------------------
70 // define things missing from some compilers' headers
71 // ---------------------------------------------------------------------------
72
73 #if defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS
74 #ifndef ZeroMemory
75 inline void ZeroMemory(void *buf, size_t len) { memset(buf, 0, len); }
76 #endif
77 #endif // old mingw32
78
79 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
80 // window proc
81 #if defined(STRICT) || defined(__GNUC__)
82 typedef WNDPROC WndProcCast;
83 #else
84 typedef FARPROC WndProcCast;
85 #endif
86
87 #define CASTWNDPROC (WndProcCast)
88
89 // ---------------------------------------------------------------------------
90 // some stuff for old Windows versions (FIXME: what does it do here??)
91 // ---------------------------------------------------------------------------
92
93 #if !defined(APIENTRY) // NT defines APIENTRY, 3.x not
94 #define APIENTRY FAR PASCAL
95 #endif
96
97 #ifdef __WIN32__
98 #define _EXPORT
99 #else
100 #define _EXPORT _export
101 #endif
102
103 #ifndef __WIN32__
104 typedef signed short int SHORT;
105 #endif
106
107 #if !defined(__WIN32__) // 3.x uses FARPROC for dialogs
108 #ifndef STRICT
109 #define DLGPROC FARPROC
110 #endif
111 #endif
112
113 #if wxUSE_PENWIN
114 WXDLLEXPORT void wxRegisterPenWin();
115 WXDLLEXPORT void wxCleanUpPenWin();
116 WXDLLEXPORT void wxEnablePenAppHooks (bool hook);
117 #endif // wxUSE_PENWIN
118
119 #if wxUSE_ITSY_BITSY
120 #define IBS_HORZCAPTION 0x4000L
121 #define IBS_VERTCAPTION 0x8000L
122
123 UINT WINAPI ibGetCaptionSize( HWND hWnd ) ;
124 UINT WINAPI ibSetCaptionSize( HWND hWnd, UINT nSize ) ;
125 LRESULT WINAPI ibDefWindowProc( HWND hWnd, UINT uiMsg, WPARAM wParam, LPARAM lParam ) ;
126 VOID WINAPI ibAdjustWindowRect( HWND hWnd, LPRECT lprc ) ;
127 #endif // wxUSE_ITSY_BITSY
128
129 #if wxUSE_CTL3D
130 #include "wx/msw/ctl3d/ctl3d.h"
131 #endif // wxUSE_CTL3D
132
133 /*
134 * Decide what window classes we're going to use
135 * for this combination of CTl3D/FAFA settings
136 */
137
138 #define STATIC_CLASS wxT("STATIC")
139 #define STATIC_FLAGS (SS_LEFT|WS_CHILD|WS_VISIBLE)
140 #define CHECK_CLASS wxT("BUTTON")
141 #define CHECK_FLAGS (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
142 #define CHECK_IS_FAFA FALSE
143 #define RADIO_CLASS wxT("BUTTON")
144 #define RADIO_FLAGS (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
145 #define RADIO_SIZE 20
146 #define RADIO_IS_FAFA FALSE
147 #define PURE_WINDOWS
148 #define GROUP_CLASS wxT("BUTTON")
149 #define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
150
151 /*
152 #define BITCHECK_FLAGS (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
153 #define BITRADIO_FLAGS (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
154 */
155
156 // ---------------------------------------------------------------------------
157 // misc macros
158 // ---------------------------------------------------------------------------
159
160 #define MEANING_CHARACTER '0'
161 #define DEFAULT_ITEM_WIDTH 100
162 #define DEFAULT_ITEM_HEIGHT 80
163
164 // Scale font to get edit control height
165 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (3*(cy)/2)
166 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (cy+8)
167
168 // Generic subclass proc, for panel item moving/sizing and intercept
169 // EDIT control VK_RETURN messages
170 extern LONG APIENTRY _EXPORT
171 wxSubclassedGenericControlProc(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
172
173 // ---------------------------------------------------------------------------
174 // constants which might miss from some compilers' headers
175 // ---------------------------------------------------------------------------
176
177 #if !defined(__WIN32__) && !defined(WS_EX_CLIENTEDGE)
178 #define WS_EX_CLIENTEDGE 0
179 #endif
180
181 #if defined(__WIN32__) && !defined(WS_EX_CLIENTEDGE)
182 #define WS_EX_CLIENTEDGE 0x00000200L
183 #endif
184
185 #ifndef ENDSESSION_LOGOFF
186 #define ENDSESSION_LOGOFF 0x80000000
187 #endif
188
189 // ---------------------------------------------------------------------------
190 // useful macros and functions
191 // ---------------------------------------------------------------------------
192
193 // a wrapper macro for ZeroMemory()
194 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
195 #define wxZeroMemory(obj) ::ZeroMemory(&obj, sizeof(obj))
196 #else
197 #define wxZeroMemory(obj) memset((void*) & obj, 0, sizeof(obj))
198 #endif
199
200 #if wxUSE_GUI
201
202 #include <wx/gdicmn.h>
203
204 // make conversion from wxColour and COLORREF a bit less painful
205 inline COLORREF wxColourToRGB(const wxColour& c)
206 {
207 return PALETTERGB(c.Red(), c.Green(), c.Blue());
208 }
209
210 inline void wxRGBToColour(wxColour& c, COLORREF rgb)
211 {
212 c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
213 }
214
215 // copy Windows RECT to our wxRect
216 inline void wxCopyRECTToRect(const RECT& r, wxRect& rect)
217 {
218 rect.y = r.top;
219 rect.x = r.left;
220 rect.width = r.right - r.left;
221 rect.height = r.bottom - r.top;
222 }
223
224 // translations between HIMETRIC units (which OLE likes) and pixels (which are
225 // liked by all the others) - implemented in msw/utilsexc.cpp
226 extern void HIMETRICToPixel(LONG *x, LONG *y);
227 extern void PixelToHIMETRIC(LONG *x, LONG *y);
228
229 // Windows convention of the mask is opposed to the wxWindows one, so we need
230 // to invert the mask each time we pass one/get one to/from Windows
231 extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
232
233 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
234 // will fail on system with multiple monitors where the coords may be negative
235 //
236 // these macros are standard now (Win98) but some older headers don't have them
237 #ifndef GET_X_LPARAM
238 #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
239 #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
240 #endif // GET_X_LPARAM
241
242 // get the current state of SHIFT/CTRL keys
243 inline bool wxIsShiftDown()
244 {
245 return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
246 }
247
248 inline bool wxIsCtrlDown()
249 {
250 return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
251 }
252
253 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
254 // for Win32
255 inline RECT wxGetWindowRect(HWND hwnd)
256 {
257 RECT rect;
258 #ifdef __WIN16__
259 ::GetWindowRect(hwnd, &rect);
260 #else // Win32
261 if ( !::GetWindowRect(hwnd, &rect) )
262 {
263 wxLogLastError(_T("GetWindowRect"));
264 }
265 #endif // Win16/32
266
267 return rect;
268 }
269
270 inline RECT wxGetClientRect(HWND hwnd)
271 {
272 RECT rect;
273 #ifdef __WIN16__
274 ::GetClientRect(hwnd, &rect);
275 #else // Win32
276 if ( !::GetClientRect(hwnd, &rect) )
277 {
278 wxLogLastError(_T("GetClientRect"));
279 }
280 #endif // Win16/32
281
282 return rect;
283 }
284
285 // ---------------------------------------------------------------------------
286 // small helper classes
287 // ---------------------------------------------------------------------------
288
289 // create an instance of this class and use it as the HDC for screen, will
290 // automatically release the DC going out of scope
291 class ScreenHDC
292 {
293 public:
294 ScreenHDC() { m_hdc = ::GetDC(NULL); }
295 ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
296
297 operator HDC() const { return m_hdc; }
298
299 private:
300 HDC m_hdc;
301 };
302
303 // the same as ScreenHDC but for memory DCs: creates the HDC in ctor and
304 // destroys it in dtor
305 class MemoryHDC
306 {
307 public:
308 MemoryHDC() { m_hdc = ::CreateCompatibleDC(NULL); }
309 ~MemoryHDC() { ::DeleteObject(m_hdc); }
310
311 operator HDC() const { return m_hdc; }
312
313 private:
314 HDC m_hdc;
315 };
316
317 // a class which selects a GDI object into a DC in its ctor and deselects in
318 // dtor
319 class SelectInHDC
320 {
321 public:
322 SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc)
323 { m_hgdiobj = ::SelectObject(hdc, hgdiobj); }
324
325 ~SelectInHDC() { ::SelectObject(m_hdc, m_hgdiobj); }
326
327 // return true if the object was successfully selected
328 operator bool() const { return m_hgdiobj != 0; }
329
330 private:
331 HDC m_hdc;
332 HGDIOBJ m_hgdiobj;
333 };
334
335 // ---------------------------------------------------------------------------
336 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
337 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
338 // an argument which should be a pointer or reference to the object of the
339 // corresponding class (this depends on the macro)
340 // ---------------------------------------------------------------------------
341
342 #define GetHwnd() ((HWND)GetHWND())
343 #define GetHwndOf(win) ((HWND)((win)->GetHWND()))
344 // old name
345 #define GetWinHwnd GetHwndOf
346
347 #define GetHdc() ((HDC)GetHDC())
348 #define GetHdcOf(dc) ((HDC)(dc).GetHDC())
349
350 #define GetHbitmap() ((HBITMAP)GetHBITMAP())
351 #define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
352
353 #define GetHicon() ((HICON)GetHICON())
354 #define GetHiconOf(icon) ((HICON)(icon).GetHICON())
355
356 #define GetHaccel() ((HACCEL)GetHACCEL())
357 #define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
358
359 #define GetHmenu() ((HMENU)GetHMenu())
360 #define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
361
362 #define GetHcursor() ((HCURSOR)GetHCURSOR())
363 #define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
364
365 #define GetHfont() ((HFONT)GetHFONT())
366 #define GetHfontOf(font) ((HFONT)(font).GetHFONT())
367
368 #define GetHpalette() ((HPALETTE)GetHPALETTE())
369 #define GetHpaletteOf(pal) ((HPALETTE)(pal)->GetHPALETTE())
370
371 #define GetHrgn() ((HRGN)GetHRGN())
372 #define GetHrgnOf(rgn) ((HRGN)(rgn).GetHRGN())
373
374 #endif // wxUSE_GUI
375
376 // ---------------------------------------------------------------------------
377 // global data
378 // ---------------------------------------------------------------------------
379
380 WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
381
382 WXDLLEXPORT_DATA(extern HINSTANCE) wxhInstance;
383
384 // ---------------------------------------------------------------------------
385 // global functions
386 // ---------------------------------------------------------------------------
387
388 extern "C"
389 {
390 WXDLLEXPORT HINSTANCE wxGetInstance();
391 }
392
393 WXDLLEXPORT void wxSetInstance(HINSTANCE hInst);
394
395 #if wxUSE_GUI
396
397 // cursor stuff
398 extern HCURSOR wxGetCurrentBusyCursor(); // from msw/utils.cpp
399 extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
400
401 WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
402
403 WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont *the_font);
404 WXDLLEXPORT void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
405 WXDLLEXPORT wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
406 WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int charset);
407
408 WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
409 WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
410
411 // Find maximum size of window/rectangle
412 WXDLLEXPORT extern void wxFindMaxSize(WXHWND hwnd, RECT *rect);
413
414 WXDLLEXPORT wxWindow* wxFindControlFromHandle(WXHWND hWnd);
415 WXDLLEXPORT void wxAddControlHandle(WXHWND hWnd, wxWindow *item);
416
417 // Safely get the window text (i.e. without using fixed size buffer)
418 WXDLLEXPORT extern wxString wxGetWindowText(WXHWND hWnd);
419
420 // get the window class name
421 WXDLLEXPORT extern wxString wxGetWindowClass(WXHWND hWnd);
422
423 // get the window id (should be unsigned, hence this is not wxWindowID which
424 // is, for mainly historical reasons, signed)
425 WXDLLEXPORT extern WXWORD wxGetWindowId(WXHWND hWnd);
426
427 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are different
428 extern bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
429
430 // Does this window style specify any border?
431 inline bool wxStyleHasBorder(long style)
432 {
433 return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
434 wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
435 }
436
437 // find the window for HWND which is part of some wxWindow, returns just the
438 // corresponding wxWindow for HWND which just is one
439 //
440 // may return NULL
441 extern wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
442
443 #endif // wxUSE_GUI
444
445 #endif
446 // _WX_PRIVATE_H_