]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/os2/window.h
wxDateTime::IsValid() now returns m_time != (wxLongLong)-1
[wxWidgets.git] / include / wx / os2 / window.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: window.h
3// Purpose: wxWindow class
4// Author: David Webster
5// Modified by:
6// Created: 10/12/99
7// RCS-ID: $Id$
8// Copyright: (c) David Webster
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_WINDOW_H_
13#define _WX_WINDOW_H_
14
15#define wxUSE_MOUSEEVENT_HACK 0
16
17// ---------------------------------------------------------------------------
18// headers
19// ---------------------------------------------------------------------------
20#define INCL_DOS
21#define INCL_PM
22#define INCL_GPI
23#include <os2.h>
24
25
26// ---------------------------------------------------------------------------
27// forward declarations
28// ---------------------------------------------------------------------------
29
30class WXDLLEXPORT wxButton;
31
32// ---------------------------------------------------------------------------
33// constants
34// ---------------------------------------------------------------------------
35
36// FIXME does anybody use those? they're unused by wxWindows...
37enum
38{
39 wxKEY_SHIFT = 1,
40 wxKEY_CTRL = 2
41};
42
43// ---------------------------------------------------------------------------
44// wxWindow declaration for OS/2 PM
45// ---------------------------------------------------------------------------
46
47class WXDLLEXPORT wxWindow : public wxWindowBase
48{
49public:
50 wxWindow()
51 {
52 Init();
53 }
54
55 wxWindow( wxWindow* pParent
56 ,wxWindowID vId
57 ,const wxPoint& rPos = wxDefaultPosition
58 ,const wxSize& rSize = wxDefaultSize
59 ,long lStyle = 0
60 ,const wxString& rName = wxPanelNameStr
61 )
62 {
63 Init();
64 Create( pParent
65 ,vId
66 ,rPos
67 ,rSize
68 ,lStyle
69 ,rName
70 );
71 }
72
73 virtual ~wxWindow();
74
75 bool Create( wxWindow* pParent
76 ,wxWindowID vId
77 ,const wxPoint& rPos = wxDefaultPosition
78 ,const wxSize& rSize = wxDefaultSize
79 ,long lStyle = 0
80 ,const wxString& rName = wxPanelNameStr
81 );
82
83 // implement base class pure virtuals
84 virtual void SetTitle(const wxString& rTitle);
85 virtual wxString GetTitle(void) const;
86 virtual void Raise(void);
87 virtual void Lower(void);
88 virtual bool Show(bool bShow = TRUE);
89 virtual bool Enable(bool bEnable = TRUE);
90 virtual void SetFocus(void);
91 virtual bool Reparent(wxWindow* pNewParent);
92 virtual void WarpPointer( int x
93 ,int y
94 );
95 virtual void CaptureMouse(void);
96 virtual void ReleaseMouse(void);
97 virtual void Refresh( bool bEraseBackground = TRUE
98 ,const wxRect* pRect = (const wxRect *)NULL
99 );
100 virtual void Clear(void);
101 virtual bool SetCursor(const wxCursor& rCursor);
102 virtual bool SetFont(const wxFont& rFont);
103 virtual int GetCharHeight(void) const;
104 virtual int GetCharWidth(void) const;
105 virtual void GetTextExtent( const wxString& rString
106 ,int* pX
107 ,int* pY
108 ,int* pDescent = (int *)NULL
109 ,int* pExternalLeading = (int *)NULL
110 ,const wxFont* pTheFont = (const wxFont *)NULL
111 ) const;
112 virtual bool DoPopupMenu( wxMenu* pMenu
113 ,int nX
114 ,int nY
115 );
116
117 virtual void SetScrollbar( int nOrient
118 ,int nPos
119 ,int nThumbVisible
120 ,int nRange
121 ,bool bRefresh = TRUE
122 );
123 virtual void SetScrollPos( int nOrient
124 ,int nPos
125 ,bool bRefresh = TRUE
126 );
127 virtual int GetScrollPos(int nOrient) const;
128 virtual int GetScrollThumb(int nOrient) const;
129 virtual int GetScrollRange(int nOrient) const;
130 virtual void ScrollWindow( int nDx
131 ,int nDy
132 ,const wxRect* pRect = (wxRect *)NULL
133 );
134
135#if wxUSE_DRAG_AND_DROP
136 virtual void SetDropTarget(wxDropTarget* pDropTarget);
137#endif // wxUSE_DRAG_AND_DROP
138
139 // Accept files for dragging
140 virtual void DragAcceptFiles(bool bAccept);
141
142#if WXWIN_COMPATIBILITY
143 // Set/get scroll attributes
144 virtual void SetScrollRange( int nOrient
145 ,int nRange
146 ,bool bRefresh = TRUE
147 );
148 virtual void SetScrollPage( int nOrient
149 ,int nPage
150 ,bool bRefresh = TRUE
151 );
152 virtual int OldGetScrollRange(int nOrient) const;
153 virtual int GetScrollPage(int nOrient) const;
154
155 //
156 // event handlers
157 //
158 // Handle a control command
159 virtual void OnCommand( wxWindow& rWin
160 ,wxCommandEvent& rEvent
161 );
162
163 // Override to define new behaviour for default action (e.g. double
164 // clicking on a listbox)
165 virtual void OnDefaultAction(wxControl* WXUNUSED(pInitiatingItem)) { }
166#endif // WXWIN_COMPATIBILITY
167
168#if wxUSE_CARET && WXWIN_COMPATIBILITY
169 void CreateCaret( int nWidth
170 ,int nHeight
171 );
172 void CreateCaret(const wxBitmap* pBitmap);
173 void DestroyCaret(void);
174 void ShowCaret(bool bShow);
175 void SetCaretPos( int nX
176 ,int nY
177 );
178 void GetCaretPos( int* pX
179 ,int* pY
180 ) const;
181#endif // wxUSE_CARET
182
183 // Native resource loading (implemented in src/os2/nativdlg.cpp)
184 // FIXME: should they really be all virtual?
185 virtual bool LoadNativeDialog( wxWindow* pParent
186 ,wxWindowID& vId
187 );
188 virtual bool LoadNativeDialog( wxWindow* pParent
189 ,const wxString& rName
190 );
191 wxWindow* GetWindowChild1(wxWindowID vId);
192 wxWindow* GetWindowChild(wxWindowID vId);
193
194 // implementation from now on
195 // --------------------------
196
197 // simple accessors
198 // ----------------
199
200 WXHWND GetHWND(void) const { return m_hWnd; }
201 void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
202 virtual WXWidget GetHandle(void) const { return GetHWND(); }
203 bool GetUseCtl3D(void) const { return m_bUseCtl3D; }
204 bool GetTransparentBackground(void) const { return m_bBackgroundTransparent; }
205 void SetTransparent(bool bT = TRUE) { m_bBackgroundTransparent = bT; }
206
207 // event handlers
208 // --------------
209 void OnSetFocus(wxFocusEvent& rEvent);
210 void OnEraseBackground(wxEraseEvent& rEvent);
211 void OnIdle(wxIdleEvent& rEvent);
212
213public:
214 // For implementation purposes - sometimes decorations make the client area
215 // smaller
216 virtual wxPoint GetClientAreaOrigin(void) const;
217
218 // Makes an adjustment to the window position (for example, a frame that has
219 // a toolbar that it manages itself).
220 virtual void AdjustForParentClientOrigin( int& rX
221 ,int& rY
222 ,int nSizeFlags
223 );
224
225 // Windows subclassing
226 void SubclassWin(WXHWND hWnd);
227 void UnsubclassWin(void);
228
229 WXFARPROC OS2GetOldWndProc(void) const { return m_fnOldWndProc; }
230 void OS2SetOldWndProc(WXFARPROC fnProc) { m_fnOldWndProc = fnProc; }
231
232 wxWindow* FindItem(long lId) const;
233 wxWindow* FindItemByHWND( WXHWND hWnd
234 ,bool bControlOnly = FALSE
235 ) const;
236
237 // Make a Windows extended style from the given wxWindows window style ?? applicable to OS/2??
238 static WXDWORD MakeExtendedStyle( long lStyle
239 ,bool bEliminateBorders = TRUE
240 );
241 // Determine whether 3D effects are wanted
242 WXDWORD Determine3DEffects( WXDWORD dwDefaultBorderStyle
243 ,bool* pbWant3D
244 ) const;
245
246 // PM only: TRUE if this control is part of the main control
247 virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
248
249 // returns TRUE if the window has been created
250 bool OS2Create( WXHWND hParent
251 ,PSZ zClass
252 ,const wxChar* zTitle
253 ,WXDWORD dwStyle
254 ,long lX
255 ,long lY
256 ,long lWidth
257 ,long lHeight
258 ,WXHWND hOwner
259 ,WXHWND hZOrder
260 ,unsigned long lId
261 ,void* pCtlData = NULL
262 ,void* pPresParams = NULL
263 );
264 virtual bool OS2Command( WXUINT uParam
265 ,WXWORD nId
266 );
267
268#if WXWIN_COMPATIBILITY
269 wxObject* GetChild(int nNumber) const;
270 virtual void OS2DeviceToLogical( float* pfX
271 ,float* pfY
272 ) const;
273#endif // WXWIN_COMPATIBILITY
274
275 // Create an appropriate wxWindow from a HWND
276 virtual wxWindow* CreateWindowFromHWND( wxWindow* pParent
277 ,WXHWND hWnd
278 );
279
280 // Make sure the window style reflects the HWND style (roughly)
281 virtual void AdoptAttributesFromHWND(void);
282
283 // Setup background and foreground colours correctly
284 virtual void SetupColours(void);
285
286 // ------------------------------------------------------------------------
287 // helpers for message handlers: these perform the same function as the
288 // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
289 // the correct parameters
290 // ------------------------------------------------------------------------
291
292 void UnpackCommand( WXWPARAM wParam
293 ,WXLPARAM lParam,
294 WXWORD* pId
295 ,WXHWND* pHwnd
296 ,WXWORD* pCmd
297 );
298 void UnpackActivate( WXWPARAM wParam
299 ,WXLPARAM lParam
300 ,WXWORD* pState
301 ,WXHWND* pHwnd
302 );
303 void UnpackScroll( WXWPARAM wParam
304 ,WXLPARAM lParam
305 ,WXWORD* pCode
306 ,WXWORD* pPos
307 ,WXHWND* pHwnd
308 );
309 void UnpackMenuSelect( WXWPARAM wParam
310 ,WXLPARAM lParam
311 ,WXWORD* pTtem
312 ,WXWORD* pFlags
313 ,WXHMENU* pHmenu
314 );
315
316 // ------------------------------------------------------------------------
317 // internal handlers for OS2 messages: all handlers return a boolen value:
318 // TRUE means that the handler processed the event and FALSE that it didn't
319 // ------------------------------------------------------------------------
320
321 // there are several cases where we have virtual functions for PM
322 // message processing: this is because these messages often require to be
323 // processed in a different manner in the derived classes. For all other
324 // messages, however, we do *not* have corresponding OS2OnXXX() function
325 // and if the derived class wants to process them, it should override
326 // OS2WindowProc() directly.
327
328 // scroll event (both horizontal and vertical)
329 virtual bool OS2OnScroll( int nOrientation
330 ,WXWORD nSBCode
331 ,WXWORD pos
332 ,WXHWND control
333 );
334
335 // owner-drawn controls need to process these messages
336 virtual bool OS2OnDrawItem( int nId
337 ,WXDRAWITEMSTRUCT* pItem
338 );
339 virtual bool OS2OnMeasureItem( int nId
340 ,WXMEASUREITEMSTRUCT* pItem
341 );
342
343 // the rest are not virtual
344 bool HandleCreate( WXLPCREATESTRUCT vCs
345 ,bool* pMayCreate
346 );
347 bool HandleInitDialog(WXHWND hWndFocus);
348 bool HandleDestroy(void);
349 bool HandlePaint(void);
350 bool HandleEraseBkgnd(WXHDC vDC);
351 bool HandleMinimize(void);
352 bool HandleMaximize(void);
353 bool HandleSize( int nX
354 ,int nY
355 ,WXUINT uFlag
356 );
357 bool HandleGetMinMaxInfo(PSWP pMmInfo);
358 bool HandleShow( bool bShow
359 ,int nStatus
360 );
361 bool HandleActivate( int nFlag
362 ,WXHWND hActivate
363 );
364 bool HandleCommand( WXWORD nId
365 ,WXWORD nCmd
366 ,WXHWND hControl
367 );
368 bool HandleSysCommand( WXWPARAM wParam
369 ,WXLPARAM lParam
370 );
371 bool HandleWindowParams( PWNDPARAMS pParams
372 ,WXLPARAM lParam
373 );
374 bool HandlePaletteChanged();
375 bool HandlePresParamChanged(WXWPARAM wParam);
376 bool HandleSysColorChange(void);
377 bool HandleCtlColor(WXHBRUSH* hBrush);
378 bool HandleSetFocus(WXHWND hWnd);
379 bool HandleKillFocus(WXHWND hWnd);
380 bool HandleEndDrag(WXWPARAM wParam);
381 bool HandleMouseEvent( WXUINT uMsg
382 ,int nX
383 ,int nY
384 ,WXUINT uFlags
385 );
386 bool HandleMouseMove( int nX
387 ,int nY
388 ,WXUINT uFlags
389 );
390 bool HandleChar( WXWORD wParam
391 ,WXLPARAM lParam
392 ,bool bIsASCII = FALSE
393 );
394 bool HandleKeyDown( WXWORD wParam
395 ,WXLPARAM lParam
396 );
397 bool HandleKeyUp( WXWORD wParam
398 ,WXLPARAM lParam
399 );
400 bool HandleQueryDragIcon(WXHICON* phIcon);
401 bool HandleSetCursor( USHORT vId
402 ,WXHWND hWnd
403 );
404
405 // Window procedure
406 virtual MRESULT OS2WindowProc( WXUINT uMsg
407 ,WXWPARAM wParam
408 ,WXLPARAM lParam
409 );
410
411 // Calls an appropriate default window procedure
412 virtual MRESULT OS2DefWindowProc( WXUINT uMsg
413 ,WXWPARAM wParam
414 ,WXLPARAM lParam
415 );
416 virtual bool OS2ProcessMessage(WXMSG* pMsg);
417 virtual bool OS2TranslateMessage(WXMSG* pMsg);
418 virtual void OS2DestroyWindow(void);
419
420 // Detach "Window" menu from menu bar so it doesn't get deleted
421 void OS2DetachWindowMenu(void);
422
423 // this function should return the brush to paint the window background
424 // with or 0 for the default brush
425 virtual WXHBRUSH OnCtlColor( WXHDC hDC
426 ,WXHWND hWnd
427 ,WXUINT uCtlColor
428 ,WXUINT uMessage
429 ,WXWPARAM wParam
430 ,WXLPARAM lParam
431 );
432
433#if WXWIN_COMPATIBILITY
434 void SetShowing(bool bShow) { (void)Show(show); }
435 bool IsUserEnabled(void) const { return IsEnabled(); }
436#endif // WXWIN_COMPATIBILITY
437
438 // Responds to colour changes: passes event on to children.
439 void OnSysColourChanged(wxSysColourChangedEvent& rEvent);
440
441 // initialize various fields of wxMouseEvent (common part of OS2OnMouseXXX)
442 void InitMouseEvent( wxMouseEvent& rEvent
443 ,int nX
444 ,int nY
445 ,WXUINT uFlags
446 );
447
448protected:
449 // PM can't create some MSW styles natively but can perform these after
450 // creation by sending messages
451 typedef enum extra_flags { kFrameToolWindow = 0x0001
452 ,kVertCaption = 0x0002
453 ,kHorzCaption = 0x0004
454 } EExtraFlags;
455 // Some internal sizeing id's to make it easy for event handlers
456 typedef enum size_types { kSizeNormal
457 ,kSizeMax
458 ,kSizeMin
459 } ESizeTypes;
460 // the window handle
461 WXHWND m_hWnd;
462
463 // the old window proc (we subclass all windows)
464 WXFARPROC m_fnOldWndProc;
465
466 // additional (MSW specific) flags
467 bool m_bUseCtl3D:1; // Using CTL3D for this control
468 bool m_bBackgroundTransparent:1;
469 bool m_bMouseInWindow:1;
470 bool m_bDoubleClickAllowed:1;
471 bool m_bWinCaptured:1;
472
473 // the size of one page for scrolling
474 int m_nXThumbSize;
475 int m_nYThumbSize;
476
477#if wxUSE_MOUSEEVENT_HACK
478 // the coordinates of the last mouse event and the type of it
479 long m_lLastMouseX,
480 long m_lLastMouseY;
481 int m_nLastMouseEvent;
482#endif // wxUSE_MOUSEEVENT_HACK
483
484 WXHMENU m_hMenu; // Menu, if any
485 unsigned long m_ulMenubarId; // it's Id, if any
486
487 // the return value of WM_GETDLGCODE handler
488 long m_lDlgCode;
489
490 // implement the base class pure virtuals
491 virtual void DoClientToScreen( int* pX
492 ,int* pY
493 ) const;
494 virtual void DoScreenToClient( int* pX
495 ,int* pY
496 ) const;
497 virtual void DoGetPosition( int* pX
498 ,int* pY
499 ) const;
500 virtual void DoGetSize( int* pWidth
501 ,int* pHeight
502 ) const;
503 virtual void DoGetClientSize( int* pWidth
504 ,int* pHeight
505 ) const;
506 virtual void DoSetSize( int nX
507 ,int nY
508 ,int nWidth
509 ,int nHeight
510 ,int nSizeFlags = wxSIZE_AUTO
511 );
512 virtual void DoSetClientSize( int nWidth
513 ,int nHeight
514 );
515
516 // move the window to the specified location and resize it: this is called
517 // from both DoSetSize() and DoSetClientSize() and would usually just call
518 // ::WinSetWindowPos() except for composite controls which will want to arrange
519 // themselves inside the given rectangle
520 virtual void DoMoveWindow( int nX
521 ,int nY
522 ,int nWidth
523 ,int nHeight
524 );
525
526#if wxUSE_TOOLTIPS
527 virtual void DoSetToolTip(wxToolTip* pTip);
528#endif // wxUSE_TOOLTIPS
529
530private:
531 // common part of all ctors
532 void Init(void);
533
534 // the (non-virtual) handlers for the events
535 bool HandleMove( int nX
536 ,int nY
537 );
538 bool HandleJoystickEvent( WXUINT uMsg
539 ,int pX
540 ,int pY
541 ,WXUINT uFlags
542 );
543
544 bool HandleNotify( int nIdCtrl
545 ,WXLPARAM lParam
546 ,WXLPARAM* pResult
547 );
548 // the helper functions used by HandleChar/KeyXXX methods
549 wxKeyEvent CreateKeyEvent(wxEventType evType, int id, WXLPARAM lp) const;
550
551 DECLARE_DYNAMIC_CLASS(wxWindow);
552 DECLARE_NO_COPY_CLASS(wxWindow);
553 DECLARE_EVENT_TABLE()
554private:
555 // Virtual function hiding supression
556 inline virtual bool Reparent(wxWindowBase* pNewParent)
557 { return(wxWindowBase::Reparent(pNewParent));};
558}; // end of wxWindow
559
560// ---------------------------------------------------------------------------
561// global functions
562// ---------------------------------------------------------------------------
563
564// kbd code translation
565WXDLLEXPORT int wxCharCodeOS2ToWX(int nKeySym);
566WXDLLEXPORT int wxCharCodeWXToOS2( int nId
567 ,bool* pbIsVirtual
568 );
569#endif
570 // _WX_WINDOW_H_