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