]> git.saurik.com Git - wxWidgets.git/blob - include/wx/os2/window.h
Make it easier to not use wxPopupWindow in wxSTC, and for now, don't
[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 // For implementation purposes - sometimes decorations make the client area
231 // smaller
232 virtual wxPoint GetClientAreaOrigin(void) const;
233
234 // Windows subclassing
235 void SubclassWin(WXHWND hWnd);
236 void UnsubclassWin(void);
237
238 WXFARPROC OS2GetOldWndProc(void) const { return m_fnOldWndProc; }
239 void OS2SetOldWndProc(WXFARPROC fnProc) { m_fnOldWndProc = fnProc; }
240
241 wxWindow* FindItem(long lId) const;
242 wxWindow* FindItemByHWND( WXHWND hWnd
243 ,bool bControlOnly = FALSE
244 ) const;
245
246 // Make a Windows extended style from the given wxWindows window style ?? applicable to OS/2??
247 static WXDWORD MakeExtendedStyle( long lStyle
248 ,bool bEliminateBorders = TRUE
249 );
250 // Determine whether 3D effects are wanted
251 WXDWORD Determine3DEffects( WXDWORD dwDefaultBorderStyle
252 ,bool* pbWant3D
253 ) const;
254
255 // PM only: TRUE if this control is part of the main control
256 virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
257
258 // translate wxWindows style flags for this control into the PM style
259 // and optional extended style for the corresponding native control
260 //
261 // this is the function that should be overridden in the derived classes,
262 // but you will mostly use OS2GetCreateWindowFlags() below
263 virtual WXDWORD OS2GetStyle( long lFlags
264 ,WXDWORD* pdwExstyle = NULL
265 ) const;
266
267 // get the MSW window flags corresponding to wxWindows ones
268 //
269 // the functions returns the flags (WS_XXX) directly and puts the ext
270 // (WS_EX_XXX) flags into the provided pointer if not NULL
271 WXDWORD OS2GetCreateWindowFlags(WXDWORD* pdwExflags = NULL) const
272 { return OS2GetStyle(GetWindowStyle(), pdwExflags); }
273
274
275 // returns TRUE if the window has been created
276 bool OS2Create( PSZ zClass
277 ,const char* zTitle
278 ,WXDWORD dwStyle
279 ,const wxPoint& rPos
280 ,const wxSize& rSize
281 ,void* pCtlData
282 ,WXDWORD dwExStyle
283 ,bool bIsChild
284 );
285 virtual bool OS2Command( WXUINT uParam
286 ,WXWORD nId
287 );
288
289 #if WXWIN_COMPATIBILITY
290 wxObject* GetChild(int nNumber) const;
291 virtual void OS2DeviceToLogical( float* pfX
292 ,float* pfY
293 ) const;
294 #endif // WXWIN_COMPATIBILITY
295
296 #ifndef __WXUNIVERSAL__
297 // Create an appropriate wxWindow from a HWND
298 virtual wxWindow* CreateWindowFromHWND( wxWindow* pParent
299 ,WXHWND hWnd
300 );
301
302 // Make sure the window style reflects the HWND style (roughly)
303 virtual void AdoptAttributesFromHWND(void);
304 #endif
305
306 // Setup background and foreground colours correctly
307 virtual void SetupColours(void);
308
309 // ------------------------------------------------------------------------
310 // helpers for message handlers: these perform the same function as the
311 // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
312 // the correct parameters
313 // ------------------------------------------------------------------------
314
315 void UnpackCommand( WXWPARAM wParam
316 ,WXLPARAM lParam,
317 WXWORD* pId
318 ,WXHWND* pHwnd
319 ,WXWORD* pCmd
320 );
321 void UnpackActivate( WXWPARAM wParam
322 ,WXLPARAM lParam
323 ,WXWORD* pState
324 ,WXHWND* pHwnd
325 );
326 void UnpackScroll( WXWPARAM wParam
327 ,WXLPARAM lParam
328 ,WXWORD* pCode
329 ,WXWORD* pPos
330 ,WXHWND* pHwnd
331 );
332 void UnpackMenuSelect( WXWPARAM wParam
333 ,WXLPARAM lParam
334 ,WXWORD* pTtem
335 ,WXWORD* pFlags
336 ,WXHMENU* pHmenu
337 );
338
339 // ------------------------------------------------------------------------
340 // internal handlers for OS2 messages: all handlers return a boolen value:
341 // TRUE means that the handler processed the event and FALSE that it didn't
342 // ------------------------------------------------------------------------
343
344 // there are several cases where we have virtual functions for PM
345 // message processing: this is because these messages often require to be
346 // processed in a different manner in the derived classes. For all other
347 // messages, however, we do *not* have corresponding OS2OnXXX() function
348 // and if the derived class wants to process them, it should override
349 // OS2WindowProc() directly.
350
351 // scroll event (both horizontal and vertical)
352 virtual bool OS2OnScroll( int nOrientation
353 ,WXWORD nSBCode
354 ,WXWORD pos
355 ,WXHWND control
356 );
357
358 // owner-drawn controls need to process these messages
359 virtual bool OS2OnDrawItem( int nId
360 ,WXDRAWITEMSTRUCT* pItem
361 );
362 virtual bool OS2OnMeasureItem( int nId
363 ,WXMEASUREITEMSTRUCT* pItem
364 );
365
366 // the rest are not virtual
367 bool HandleCreate( WXLPCREATESTRUCT vCs
368 ,bool* pMayCreate
369 );
370 bool HandleInitDialog(WXHWND hWndFocus);
371 bool HandleDestroy(void);
372 bool HandlePaint(void);
373 bool HandleEraseBkgnd(WXHDC vDC);
374 bool HandleMinimize(void);
375 bool HandleMaximize(void);
376 bool HandleSize( int nX
377 ,int nY
378 ,WXUINT uFlag
379 );
380 bool HandleGetMinMaxInfo(PSWP pMmInfo);
381 bool HandleShow( bool bShow
382 ,int nStatus
383 );
384 bool HandleActivate( int nFlag
385 ,WXHWND hActivate
386 );
387 bool HandleCommand( WXWORD nId
388 ,WXWORD nCmd
389 ,WXHWND hControl
390 );
391 bool HandleSysCommand( WXWPARAM wParam
392 ,WXLPARAM lParam
393 );
394 bool HandlePaletteChanged(void);
395 bool HandleQueryNewPalette(void);
396 bool HandleSysColorChange(void);
397 bool HandleDisplayChange(void);
398 bool HandleCaptureChanged(WXHWND hBainedCapture);
399
400 bool HandleCtlColor(WXHBRUSH* hBrush);
401 bool HandleSetFocus(WXHWND hWnd);
402 bool HandleKillFocus(WXHWND hWnd);
403 bool HandleEndDrag(WXWPARAM wParam);
404 bool HandleMouseEvent( WXUINT uMsg
405 ,int nX
406 ,int nY
407 ,WXUINT uFlags
408 );
409 bool HandleMouseMove( int nX
410 ,int nY
411 ,WXUINT uFlags
412 );
413 bool HandleChar( WXWPARAM wParam
414 ,WXLPARAM lParam
415 ,bool bIsASCII = FALSE
416 );
417 bool HandleKeyDown( WXWPARAM wParam
418 ,WXLPARAM lParam
419 );
420 bool HandleKeyUp( WXWPARAM wParam
421 ,WXLPARAM lParam
422 );
423 bool HandleQueryDragIcon(WXHICON* phIcon);
424 bool HandleSetCursor( USHORT vId
425 ,WXHWND hWnd
426 );
427
428 bool IsMouseInWindow(void) const;
429 bool OS2GetCreateWindowCoords( const wxPoint& rPos
430 ,const wxSize& rSize
431 ,int& rnX
432 ,int& rnY
433 ,int& rnWidth
434 ,int& rnHeight
435 ) const;
436
437 // Window procedure
438 virtual MRESULT OS2WindowProc( WXUINT uMsg
439 ,WXWPARAM wParam
440 ,WXLPARAM lParam
441 );
442
443 // Calls an appropriate default window procedure
444 virtual MRESULT OS2DefWindowProc( WXUINT uMsg
445 ,WXWPARAM wParam
446 ,WXLPARAM lParam
447 );
448 virtual bool OS2ProcessMessage(WXMSG* pMsg);
449 virtual bool OS2ShouldPreProcessMessage(WXMSG* pMsg);
450 virtual bool OS2TranslateMessage(WXMSG* pMsg);
451 virtual void OS2DestroyWindow(void);
452
453 // this function should return the brush to paint the window background
454 // with or 0 for the default brush
455 virtual WXHBRUSH OnCtlColor( WXHDC hDC
456 ,WXHWND hWnd
457 ,WXUINT uCtlColor
458 ,WXUINT uMessage
459 ,WXWPARAM wParam
460 ,WXLPARAM lParam
461 );
462
463 #if WXWIN_COMPATIBILITY
464 void SetShowing(bool bShow) { (void)Show(show); }
465 bool IsUserEnabled(void) const { return IsEnabled(); }
466 #endif // WXWIN_COMPATIBILITY
467
468 // Responds to colour changes: passes event on to children.
469 void OnSysColourChanged(wxSysColourChangedEvent& rEvent);
470
471 // initialize various fields of wxMouseEvent (common part of OS2OnMouseXXX)
472 void InitMouseEvent( wxMouseEvent& rEvent
473 ,int nX
474 ,int nY
475 ,WXUINT uFlags
476 );
477
478 void MoveChildren(int nDiff);
479 PSWP GetSwp(void) {return &m_vWinSwp;}
480
481 protected:
482 // PM can't create some MSW styles natively but can perform these after
483 // creation by sending messages
484 typedef enum extra_flags { kFrameToolWindow = 0x0001
485 ,kVertCaption = 0x0002
486 ,kHorzCaption = 0x0004
487 } EExtraFlags;
488 // Some internal sizeing id's to make it easy for event handlers
489 typedef enum size_types { kSizeNormal
490 ,kSizeMax
491 ,kSizeMin
492 } ESizeTypes;
493 // the window handle
494 WXHWND m_hWnd;
495
496 // the old window proc (we subclass all windows)
497 WXFARPROC m_fnOldWndProc;
498
499 // additional (OS2 specific) flags
500 bool m_bUseCtl3D:1; // Using CTL3D for this control
501 bool m_bBackgroundTransparent:1;
502 bool m_bMouseInWindow:1;
503 bool m_bDoubleClickAllowed:1;
504 bool m_bLastKeydownProcessed:1;
505 bool m_bWinCaptured:1;
506 WXDWORD m_dwExStyle;
507
508 // the size of one page for scrolling
509 int m_nXThumbSize;
510 int m_nYThumbSize;
511
512 #if wxUSE_MOUSEEVENT_HACK
513 // the coordinates of the last mouse event and the type of it
514 long m_lLastMouseX,
515 long m_lLastMouseY;
516 int m_nLastMouseEvent;
517 #endif // wxUSE_MOUSEEVENT_HACK
518
519 WXHMENU m_hMenu; // Menu, if any
520 unsigned long m_ulMenubarId; // it's Id, if any
521
522 // the return value of WM_GETDLGCODE handler
523 long m_lDlgCode;
524
525 // implement the base class pure virtuals
526 virtual void DoClientToScreen( int* pX
527 ,int* pY
528 ) const;
529 virtual void DoScreenToClient( int* pX
530 ,int* pY
531 ) const;
532 virtual void DoGetPosition( int* pX
533 ,int* pY
534 ) const;
535 virtual void DoGetSize( int* pWidth
536 ,int* pHeight
537 ) const;
538 virtual void DoGetClientSize( int* pWidth
539 ,int* pHeight
540 ) const;
541 virtual void DoSetSize( int nX
542 ,int nY
543 ,int nWidth
544 ,int nHeight
545 ,int nSizeFlags = wxSIZE_AUTO
546 );
547 virtual void DoSetClientSize( int nWidth
548 ,int nHeight
549 );
550
551 virtual void DoCaptureMouse(void);
552 virtual void DoReleaseMouse(void);
553
554 // move the window to the specified location and resize it: this is called
555 // from both DoSetSize() and DoSetClientSize() and would usually just call
556 // ::WinSetWindowPos() except for composite controls which will want to arrange
557 // themselves inside the given rectangle
558 virtual void DoMoveWindow( int nX
559 ,int nY
560 ,int nWidth
561 ,int nHeight
562 );
563
564 #if wxUSE_TOOLTIPS
565 virtual void DoSetToolTip(wxToolTip* pTip);
566 #endif // wxUSE_TOOLTIPS
567
568 int GetOS2ParentHeight(wxWindowOS2* pParent);
569
570 private:
571 // common part of all ctors
572 void Init(void);
573
574 // the (non-virtual) handlers for the events
575 bool HandleMove( int nX
576 ,int nY
577 );
578 bool HandleJoystickEvent( WXUINT uMsg
579 ,int pX
580 ,int pY
581 ,WXUINT uFlags
582 );
583
584 bool HandleNotify( int nIdCtrl
585 ,WXLPARAM lParam
586 ,WXLPARAM* pResult
587 );
588 // the helper functions used by HandleChar/KeyXXX methods
589 wxKeyEvent CreateKeyEvent( wxEventType evType
590 ,int nId
591 ,WXLPARAM lParam = 0
592 ,WXWPARAM wParam = 0
593 ) const;
594
595
596 DECLARE_DYNAMIC_CLASS(wxWindowOS2);
597 DECLARE_NO_COPY_CLASS(wxWindowOS2)
598 DECLARE_EVENT_TABLE()
599
600 private:
601 HWND m_hWndScrollBarHorz;
602 HWND m_hWndScrollBarVert;
603 SWP m_vWinSwp;
604
605 // Virtual function hiding supression
606 inline virtual bool Reparent(wxWindowBase* pNewParent)
607 { return(wxWindowBase::Reparent(pNewParent));};
608 }; // end of wxWindow
609
610 class wxWindowCreationHook
611 {
612 public:
613 wxWindowCreationHook(wxWindow* pWinBeingCreated);
614 ~wxWindowCreationHook();
615 }; // end of CLASS wxWindowCreationHook
616
617 // ---------------------------------------------------------------------------
618 // global functions
619 // ---------------------------------------------------------------------------
620
621 // kbd code translation
622 WXDLLEXPORT int wxCharCodeOS2ToWX(int nKeySym);
623 WXDLLEXPORT int wxCharCodeWXToOS2( int nId
624 ,bool* pbIsVirtual
625 );
626 #endif
627 // _WX_WINDOW_H_