]> git.saurik.com Git - wxWidgets.git/blame - include/wx/os2/private.h
typos due to much cut-and-paste: colour -> font in the docs and comment
[wxWidgets.git] / include / wx / os2 / private.h
CommitLineData
0e320a79
DW
1/////////////////////////////////////////////////////////////////////////////
2// Name: private.h
45fcbf3b
DW
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
0e320a79 7// Modified by:
45fcbf3b 8// Created: 01/02/97
0e320a79 9// RCS-ID: $Id$
45fcbf3b
DW
10// Copyright: (c) Julian Smart
11// Licence: wxWindows licence
0e320a79
DW
12/////////////////////////////////////////////////////////////////////////////
13
14#ifndef _WX_PRIVATE_H_
15#define _WX_PRIVATE_H_
16
b86737ee 17#define INCL_BASE
45fcbf3b 18#define INCL_PM
20947e08 19#define INCL_GPI
61243a51 20#define INCL_WINSYS
f6bcfd97 21#define INCL_SHLERRORS
45fcbf3b 22#include <os2.h>
74707ecf
SN
23#if defined (__EMX__) && !defined(USE_OS2_TOOLKIT_HEADERS)
24/* struct missing in "os2emx.h" */
25 typedef struct _SPBCDATA {
26 ULONG cbSize; /* Size of control block. */
27 ULONG ulTextLimit; /* Entryfield text limit. */
28 LONG lLowerLimit; /* Spin lower limit (numeric only). */
29 LONG lUpperLimit; /* Spin upper limit (numeric only). */
30 ULONG idMasterSpb; /* ID of the servant's master spinbutton. */
31 PVOID pHWXCtlData; /* Handwriting control data structure flag. */
32 } SPBCDATA;
f140b352 33
74707ecf
SN
34 typedef SPBCDATA *PSPBCDATA;
35#endif
0e320a79 36
f5b5c15c
DW
37#include "wx/fontenc.h"
38
45fcbf3b
DW
39class WXDLLEXPORT wxFont;
40class WXDLLEXPORT wxWindow;
74707ecf 41class WXDLLEXPORT wxString;
45fcbf3b
DW
42
43// ---------------------------------------------------------------------------
44// private constants
45// ---------------------------------------------------------------------------
46
47// Conversion
48static const double METRIC_CONVERSION_CONSTANT = 0.0393700787;
49
50// Scaling factors for various unit conversions
51static const double mm2inches = (METRIC_CONVERSION_CONSTANT);
52static const double inches2mm = (1/METRIC_CONVERSION_CONSTANT);
53
54static const double mm2twips = (METRIC_CONVERSION_CONSTANT*1440);
55static const double twips2mm = (1/(METRIC_CONVERSION_CONSTANT*1440));
56
57static const double mm2pt = (METRIC_CONVERSION_CONSTANT*72);
58static const double pt2mm = (1/(METRIC_CONVERSION_CONSTANT*72));
59
511ac294
DW
60//
61// Constant strings for control names and classes
62//
63
64//
65// Controls
66//
67WXDLLEXPORT_DATA(extern const wxChar*) wxButtonNameStr;
68WXDLLEXPORT_DATA(extern const wxChar*) wxCanvasNameStr;
69WXDLLEXPORT_DATA(extern const wxChar*) wxCheckBoxNameStr;
70WXDLLEXPORT_DATA(extern const wxChar*) wxChoiceNameStr;
71WXDLLEXPORT_DATA(extern const wxChar*) wxComboBoxNameStr;
72WXDLLEXPORT_DATA(extern const wxChar*) wxDialogNameStr;
73WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
74WXDLLEXPORT_DATA(extern const wxChar*) wxGaugeNameStr;
75WXDLLEXPORT_DATA(extern const wxChar*) wxStaticBoxNameStr;
76WXDLLEXPORT_DATA(extern const wxChar*) wxListBoxNameStr;
77WXDLLEXPORT_DATA(extern const wxChar*) wxStaticTextNameStr;
78WXDLLEXPORT_DATA(extern const wxChar*) wxStaticBitmapNameStr;
79WXDLLEXPORT_DATA(extern const wxChar*) wxMultiTextNameStr;
80WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
81WXDLLEXPORT_DATA(extern const wxChar*) wxRadioBoxNameStr;
82WXDLLEXPORT_DATA(extern const wxChar*) wxRadioButtonNameStr;
83WXDLLEXPORT_DATA(extern const wxChar*) wxBitmapRadioButtonNameStr;
84WXDLLEXPORT_DATA(extern const wxChar*) wxScrollBarNameStr;
85WXDLLEXPORT_DATA(extern const wxChar*) wxSliderNameStr;
86WXDLLEXPORT_DATA(extern const wxChar*) wxStaticNameStr;
87WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlWindowNameStr;
88WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
89WXDLLEXPORT_DATA(extern const wxChar*) wxVirtListBoxNameStr;
90WXDLLEXPORT_DATA(extern const wxChar*) wxButtonBarNameStr;
91WXDLLEXPORT_DATA(extern const wxChar*) wxEnhDialogNameStr;
92WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
93WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
94WXDLLEXPORT_DATA(extern const wxChar*) wxGetTextFromUserPromptStr;
95WXDLLEXPORT_DATA(extern const wxChar*) wxMessageBoxCaptionStr;
96WXDLLEXPORT_DATA(extern const wxChar*) wxFileSelectorPromptStr;
97WXDLLEXPORT_DATA(extern const wxChar*) wxFileSelectorDefaultWildcardStr;
98WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
99WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
100WXDLLEXPORT_DATA(extern const wxChar*) wxTreeCtrlNameStr;
101WXDLLEXPORT_DATA(extern const wxChar*) wxDirDialogNameStr;
102WXDLLEXPORT_DATA(extern const wxChar*) wxDirDialogDefaultFolderStr;
103
104//
105// Class names
106//
107WXDLLEXPORT_DATA(extern const wxChar*) wxFrameClassName;
108WXDLLEXPORT_DATA(extern const wxChar*) wxFrameClassNameNoRedraw;
109WXDLLEXPORT_DATA(extern const wxChar*) wxMDIFrameClassName;
110WXDLLEXPORT_DATA(extern const wxChar*) wxMDIFrameClassNameNoRedraw;
111WXDLLEXPORT_DATA(extern const wxChar*) wxMDIChildFrameClassName;
112WXDLLEXPORT_DATA(extern const wxChar*) wxMDIChildFrameClassNameNoRedraw;
113WXDLLEXPORT_DATA(extern const wxChar*) wxPanelClassName;
114WXDLLEXPORT_DATA(extern const wxChar*) wxPanelClassNameNR;
115WXDLLEXPORT_DATA(extern const wxChar*) wxCanvasClassName;
116WXDLLEXPORT_DATA(extern const wxChar*) wxCanvasClassNameNR;
117
45fcbf3b
DW
118// ---------------------------------------------------------------------------
119// standard icons from the resources
120// ---------------------------------------------------------------------------
121
122WXDLLEXPORT_DATA(extern HICON) wxSTD_FRAME_ICON;
123WXDLLEXPORT_DATA(extern HICON) wxSTD_MDIPARENTFRAME_ICON;
124WXDLLEXPORT_DATA(extern HICON) wxSTD_MDICHILDFRAME_ICON;
125WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_FRAME_ICON;
126WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDIPARENTFRAME_ICON;
127WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDICHILDFRAME_ICON;
128WXDLLEXPORT_DATA(extern HFONT) wxSTATUS_LINE_FONT;
129
130// ---------------------------------------------------------------------------
131// this defines a CASTWNDPROC macro which casts a pointer to the type of a
132// window proc for PM.
133// MPARAM is a void * but is really a 32-bit value
134// ---------------------------------------------------------------------------
135
136typedef MRESULT (APIENTRY * WndProcCast) (HWND, ULONG, MPARAM, MPARAM);
137#define CASTWNDPROC (WndProcCast)
138
139#if wxUSE_ITSY_BITSY
140 #define IBS_HORZCAPTION 0x4000L
141 #define IBS_VERTCAPTION 0x8000L
142
86de7616
DW
143 UINT APIENTRY ibGetCaptionSize( HWND hWnd ) ;
144 UINT APIENTRY ibSetCaptionSize( HWND hWnd, UINT nSize ) ;
145 MRESULT APIENTRY ibDefWindowProc( HWND hWnd, ULONG ulMsg, MPARAM wParam, MPARAM lParam ) ;
146 VOID APIENTRY ibAdjustWindowRect( HWND hWnd, LPRECT lprc ) ;
45fcbf3b
DW
147#endif // wxUSE_ITSY_BITSY
148
149/*
150 * Decide what window classes we're going to use
151 * for this combination of CTl3D/FAFA settings
0e320a79
DW
152 */
153
45fcbf3b
DW
154#define STATIC_CLASS _T("STATIC")
155#define STATIC_FLAGS (SS_TEXT|DT_LEFT|SS_LEFT|WS_VISIBLE)
86de7616 156#define CHECK_CLASS _T("BUTTON")
45fcbf3b
DW
157#define CHECK_FLAGS (BS_AUTOCHECKBOX|WS_TABSTOP)
158#define CHECK_IS_FAFA FALSE
86de7616 159#define RADIO_CLASS _T("BUTTON" )
45fcbf3b
DW
160#define RADIO_FLAGS (BS_AUTORADIOBUTTON|WS_VISIBLE)
161#define RADIO_SIZE 20
162#define RADIO_IS_FAFA FALSE
163#define PURE_WINDOWS
164/* PM has no group box button style
165#define GROUP_CLASS "BUTTON"
166#define GROUP_FLAGS (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
167*/
168
169/*
170#define BITCHECK_FLAGS (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
171#define BITRADIO_FLAGS (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
172*/
173
174// ---------------------------------------------------------------------------
175// misc macros
176// ---------------------------------------------------------------------------
177
178#define MEANING_CHARACTER '0'
179#define DEFAULT_ITEM_WIDTH 200
180#define DEFAULT_ITEM_HEIGHT 80
181
182// Scale font to get edit control height
183#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy) (3*(cy)/2)
184
185// Generic subclass proc, for panel item moving/sizing and intercept
186// EDIT control VK_RETURN messages
86de7616 187extern LONG APIENTRY wxSubclassedGenericControlProc(WXHWND hWnd, WXDWORD message, WXWPARAM wParam, WXLPARAM lParam);
45fcbf3b
DW
188
189// ---------------------------------------------------------------------------
190// constants which might miss from some compilers' headers
191// ---------------------------------------------------------------------------
192
193#if !defined(WS_EX_CLIENTEDGE)
008089f6 194 #define WS_EX_CLIENTEDGE 0x00000200L
45fcbf3b
DW
195#endif
196
197#ifndef ENDSESSION_LOGOFF
198 #define ENDSESSION_LOGOFF 0x80000000
199#endif
200
201// ---------------------------------------------------------------------------
202// debug messages -- OS/2 has no native debug output system
203// ---------------------------------------------------------------------------
204
205// ---------------------------------------------------------------------------
206// macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
207// returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
208// an argument which should be a pointer or reference to the object of the
209// corresponding class (this depends on the macro)
210// ---------------------------------------------------------------------------
211
212#define GetHwnd() ((HWND)GetHWND())
213#define GetHwndOf(win) ((HWND)((win)->GetHWND()))
214// old name
215#define GetWinHwnd GetHwndOf
216
217#define GetHdc() ((HDC)GetHDC())
218#define GetHdcOf(dc) ((HDC)(dc).GetHDC())
219
8bb6da4a
DW
220#define GetHbitmap() ((HBITMAP)GetHBITMAP())
221#define GetHbitmapOf(bmp) ((HBITMAP)(bmp).GetHBITMAP())
222
45fcbf3b
DW
223#define GetHicon() ((HICON)GetHICON())
224#define GetHiconOf(icon) ((HICON)(icon).GetHICON())
225
226#define GetHaccel() ((HACCEL)GetHACCEL())
227#define GetHaccelOf(table) ((HACCEL)((table).GetHACCEL()))
228
229#define GetHmenu() ((HMENU)GetHMenu())
230#define GetHmenuOf(menu) ((HMENU)menu->GetHMenu())
231
8bb6da4a
DW
232#define GetHcursor() ((HCURSOR)GetHCURSOR())
233#define GetHcursorOf(cursor) ((HCURSOR)(cursor).GetHCURSOR())
234
235#define GetHfont() ((HFONT)GetHFONT())
236#define GetHfontOf(font) ((HFONT)(font).GetHFONT())
237
238// OS/2 convention of the mask is opposed to the wxWindows one, so we need
239// to invert the mask each time we pass one/get one to/from Windows
240extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
241
45fcbf3b
DW
242// ---------------------------------------------------------------------------
243// global data
244// ---------------------------------------------------------------------------
245
246// The MakeProcInstance version of the function wxSubclassedGenericControlProc
86de7616 247WXDLLEXPORT_DATA(extern) wxGenericControlSubClassProc;
45fcbf3b
DW
248WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
249WXDLLEXPORT_DATA(extern HINSTANCE) wxhInstance;
250
251// ---------------------------------------------------------------------------
252// global functions
253// ---------------------------------------------------------------------------
254
255extern "C"
256{
257WXDLLEXPORT HINSTANCE wxGetInstance();
258}
259
008089f6
DW
260WXDLLEXPORT void wxDrawBorder( HPS hPS
261 ,RECTL& rRect
262 ,WXDWORD dwStyle
263 );
264
45fcbf3b
DW
265WXDLLEXPORT void wxSetInstance(HINSTANCE hInst);
266
267WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
268
e99762c0
DW
269WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y,wxFont *the_font);
270WXDLLEXPORT void wxFillLogFont( LOGFONT* pLogFont
271 ,PFACENAMEDESC pFaceName
f140b352 272 ,HPS* phPS
cc95f4f9
DW
273 ,long* pflId
274 ,wxString& sFaceName
275 ,wxFont* pFont
e99762c0 276 );
cc95f4f9
DW
277WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int nCharSet);
278WXDLLEXPORT void wxOS2SelectMatchingFontByName( PFATTRS vFattrs
279 ,PFACENAMEDESC pFaceName
280 ,PFONTMETRICS pFM
281 ,int nNumFonts
282 ,const wxFont* pFont
283 );
e99762c0
DW
284WXDLLEXPORT wxFont wxCreateFontFromLogFont( LOGFONT* pLogFont
285 ,PFONTMETRICS pFM
286 ,PFACENAMEDESC pFace
287 );
288WXDLLEXPORT int wxGpiStrcmp(char* s0, char* s1);
45fcbf3b
DW
289
290WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
291WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
292
293// Find maximum size of window/rectangle
294WXDLLEXPORT extern void wxFindMaxSize(WXHWND hwnd, RECT *rect);
295
296WXDLLEXPORT wxWindow* wxFindControlFromHandle(WXHWND hWnd);
297WXDLLEXPORT void wxAddControlHandle(WXHWND hWnd, wxWindow *item);
298
299// Safely get the window text (i.e. without using fixed size buffer)
300WXDLLEXPORT extern wxString wxGetWindowText(WXHWND hWnd);
301
302// get the window class name
303WXDLLEXPORT extern wxString wxGetWindowClass(WXHWND hWnd);
304
305// get the window id (should be unsigned, hence this is not wxWindowID which
306// is, for mainly historical reasons, signed)
307WXDLLEXPORT extern WXWORD wxGetWindowId(WXHWND hWnd);
308
914589c2
DW
309// Convert a PM Error code to a string
310WXDLLEXPORT extern wxString wxPMErrorToStr(ERRORID vError);
311
45fcbf3b
DW
312// Does this window style specify any border?
313inline bool wxStyleHasBorder(long style)
314{
315 return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
316 wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
317}
318
3011bf2b
DW
319inline RECTL wxGetWindowRect(HWND hWnd)
320{
321 RECTL vRect;
322
323 ::WinQueryWindowRect(hWnd, &vRect);
324 return vRect;
325} // end of wxGetWindowRect
326
3c299c3a
DW
327WXDLLEXPORT extern void wxOS2SetFont( HWND hWnd
328 ,const wxFont& rFont
329 );
330
008089f6 331
3011bf2b
DW
332WXDLLEXPORT extern bool wxCheckWindowWndProc( WXHWND hWnd
333 ,WXFARPROC fnWndProc
334 );
335
0e320a79
DW
336#endif
337 // _WX_PRIVATE_H_