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