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