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