include/wx/os2/window.h

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