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
  30 class WXDLLEXPORT wxButton;
  31
  32 // ---------------------------------------------------------------------------
  33 // constants
  34 // ---------------------------------------------------------------------------
  35
  36 // FIXME does anybody use those? they're unused by wxWindows...
  37 enum
  38 {
  39     wxKEY_SHIFT = 1,
  40     wxKEY_CTRL  = 2
  41 };
  42
  43 // ---------------------------------------------------------------------------
  44 // wxWindow declaration for OS/2 PM
  45 // ---------------------------------------------------------------------------
  46
  47 class WXDLLEXPORT wxWindow : public wxWindowBase
  48 {
  49 public:
  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
 213 public:
 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                    ,WXDWORD       dwExStyle = 0L
 264                   );
 265     virtual bool OS2Command( WXUINT uParam
 266                             ,WXWORD nId
 267                            );
 268
 269 #if WXWIN_COMPATIBILITY
 270     wxObject*    GetChild(int nNumber) const;
 271     virtual void OS2DeviceToLogical( float* pfX
 272                                     ,float* pfY
 273                                    ) const;
 274 #endif // WXWIN_COMPATIBILITY
 275
 276     // Create an appropriate wxWindow from a HWND
 277     virtual wxWindow* CreateWindowFromHWND( wxWindow* pParent
 278                                            ,WXHWND    hWnd
 279                                           );
 280
 281     // Make sure the window style reflects the HWND style (roughly)
 282     virtual void AdoptAttributesFromHWND(void);
 283
 284     // Setup background and foreground colours correctly
 285     virtual void SetupColours(void);
 286
 287     // ------------------------------------------------------------------------
 288     // helpers for message handlers: these perform the same function as the
 289     // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
 290     // the correct parameters
 291     // ------------------------------------------------------------------------
 292
 293     void UnpackCommand( WXWPARAM wParam
 294                        ,WXLPARAM lParam,
 295                         WXWORD*  pId
 296                        ,WXHWND*  pHwnd
 297                        ,WXWORD*  pCmd
 298                       );
 299     void UnpackActivate( WXWPARAM wParam
 300                         ,WXLPARAM lParam
 301                         ,WXWORD*  pState
 302                         ,WXHWND*  pHwnd
 303                        );
 304     void UnpackScroll( WXWPARAM wParam
 305                       ,WXLPARAM lParam
 306                       ,WXWORD*  pCode
 307                       ,WXWORD*  pPos
 308                       ,WXHWND*  pHwnd
 309                      );
 310     void UnpackMenuSelect( WXWPARAM wParam
 311                           ,WXLPARAM lParam
 312                           ,WXWORD*  pTtem
 313                           ,WXWORD*  pFlags
 314                           ,WXHMENU* pHmenu
 315                          );
 316
 317     // ------------------------------------------------------------------------
 318     // internal handlers for OS2 messages: all handlers return a boolen value:
 319     // TRUE means that the handler processed the event and FALSE that it didn't
 320     // ------------------------------------------------------------------------
 321
 322     // there are several cases where we have virtual functions for PM
 323     // message processing: this is because these messages often require to be
 324     // processed in a different manner in the derived classes. For all other
 325     // messages, however, we do *not* have corresponding OS2OnXXX() function
 326     // and if the derived class wants to process them, it should override
 327     // OS2WindowProc() directly.
 328
 329     // scroll event (both horizontal and vertical)
 330     virtual bool OS2OnScroll( int    nOrientation
 331                              ,WXWORD nSBCode
 332                              ,WXWORD pos
 333                              ,WXHWND control
 334                             );
 335
 336     // owner-drawn controls need to process these messages
 337     virtual bool OS2OnDrawItem( int               nId
 338                                ,WXDRAWITEMSTRUCT* pItem
 339                               );
 340     virtual bool OS2OnMeasureItem( int                  nId
 341                                   ,WXMEASUREITEMSTRUCT* pItem
 342                                  );
 343
 344     // the rest are not virtual
 345     bool HandleCreate( WXLPCREATESTRUCT vCs
 346                       ,bool*            pMayCreate
 347                      );
 348     bool HandleInitDialog(WXHWND hWndFocus);
 349     bool HandleDestroy(void);
 350     bool HandlePaint(void);
 351     bool HandleEraseBkgnd(WXHDC vDC);
 352     bool HandleMinimize(void);
 353     bool HandleMaximize(void);
 354     bool HandleSize( int    nX
 355                     ,int    nY
 356                     ,WXUINT uFlag
 357                    );
 358     bool HandleGetMinMaxInfo(PSWP pMmInfo);
 359     bool HandleShow( bool bShow
 360                     ,int  nStatus
 361                    );
 362     bool HandleActivate( int    nFlag
 363                         ,WXHWND hActivate
 364                        );
 365     bool HandleCommand( WXWORD nId
 366                        ,WXWORD nCmd
 367                        ,WXHWND hControl
 368                       );
 369     bool HandleSysCommand( WXWPARAM wParam
 370                           ,WXLPARAM lParam
 371                          );
 372     bool HandleWindowParams( PWNDPARAMS pParams
 373                             ,WXLPARAM   lParam
 374                            );
 375     bool HandlePaletteChanged();
 376     bool HandlePresParamChanged(WXWPARAM wParam);
 377     bool HandleSysColorChange(void);
 378     bool HandleCtlColor(WXHBRUSH* hBrush);
 379     bool HandleSetFocus(WXHWND hWnd);
 380     bool HandleKillFocus(WXHWND hWnd);
 381     bool HandleEndDrag(WXWPARAM wParam);
 382     bool HandleMouseEvent( WXUINT uMsg
 383                           ,int    nX
 384                           ,int    nY
 385                           ,WXUINT uFlags
 386                          );
 387     bool HandleMouseMove( int    nX
 388                          ,int    nY
 389                          ,WXUINT uFlags
 390                         );
 391     bool HandleChar( WXWORD   wParam
 392                     ,WXLPARAM lParam
 393                     ,bool     bIsASCII = FALSE
 394                    );
 395     bool HandleKeyDown( WXWORD   wParam
 396                        ,WXLPARAM lParam
 397                       );
 398     bool HandleKeyUp( WXWORD   wParam
 399                      ,WXLPARAM lParam
 400                     );
 401     bool HandleQueryDragIcon(WXHICON* phIcon);
 402     bool HandleSetCursor( USHORT vId
 403                          ,WXHWND hWnd
 404                         );
 405
 406     // Window procedure
 407     virtual MRESULT OS2WindowProc( WXUINT   uMsg
 408                                   ,WXWPARAM wParam
 409                                   ,WXLPARAM lParam
 410                                  );
 411
 412     // Calls an appropriate default window procedure
 413     virtual MRESULT OS2DefWindowProc( WXUINT   uMsg
 414                                      ,WXWPARAM wParam
 415                                      ,WXLPARAM lParam
 416                                     );
 417     virtual bool    OS2ProcessMessage(WXMSG* pMsg);
 418     virtual bool    OS2TranslateMessage(WXMSG* pMsg);
 419     virtual void    OS2DestroyWindow(void);
 420
 421     // Detach "Window" menu from menu bar so it doesn't get deleted
 422     void OS2DetachWindowMenu(void);
 423
 424     // this function should return the brush to paint the window background
 425     // with or 0 for the default brush
 426     virtual WXHBRUSH OnCtlColor( WXHDC    hDC
 427                                 ,WXHWND   hWnd
 428                                 ,WXUINT   uCtlColor
 429                                 ,WXUINT   uMessage
 430                                 ,WXWPARAM wParam
 431                                 ,WXLPARAM lParam
 432                                );
 433
 434 #if WXWIN_COMPATIBILITY
 435     void SetShowing(bool bShow) { (void)Show(show); }
 436     bool IsUserEnabled(void) const { return IsEnabled(); }
 437 #endif // WXWIN_COMPATIBILITY
 438
 439     // Responds to colour changes: passes event on to children.
 440     void OnSysColourChanged(wxSysColourChangedEvent& rEvent);
 441
 442     // initialize various fields of wxMouseEvent (common part of OS2OnMouseXXX)
 443     void InitMouseEvent( wxMouseEvent& rEvent
 444                         ,int           nX
 445                         ,int           nY
 446                         ,WXUINT        uFlags
 447                        );
 448
 449 protected:
 450     // PM can't create some MSW styles natively but can perform these after
 451     // creation by sending messages
 452     typedef enum extra_flags { kFrameToolWindow = 0x0001
 453                               ,kVertCaption     = 0x0002
 454                               ,kHorzCaption     = 0x0004
 455                              } EExtraFlags;
 456     // Some internal sizeing id's to make it easy for event handlers
 457     typedef enum size_types { kSizeNormal
 458                              ,kSizeMax
 459                              ,kSizeMin
 460                             } ESizeTypes;
 461     // the window handle
 462     WXHWND                          m_hWnd;
 463
 464     // the old window proc (we subclass all windows)
 465     WXFARPROC                       m_fnOldWndProc;
 466
 467     // additional (OS2 specific) flags
 468     bool                            m_bUseCtl3D:1; // Using CTL3D for this control
 469     bool                            m_bBackgroundTransparent:1;
 470     bool                            m_bMouseInWindow:1;
 471     bool                            m_bDoubleClickAllowed:1;
 472     bool                            m_bWinCaptured:1;
 473     WXDWORD                         m_dwExStyle;
 474
 475     // the size of one page for scrolling
 476     int                             m_nXThumbSize;
 477     int                             m_nYThumbSize;
 478
 479 #if wxUSE_MOUSEEVENT_HACK
 480     // the coordinates of the last mouse event and the type of it
 481     long                            m_lLastMouseX,
 482     long                            m_lLastMouseY;
 483     int                             m_nLastMouseEvent;
 484 #endif // wxUSE_MOUSEEVENT_HACK
 485
 486     WXHMENU                         m_hMenu; // Menu, if any
 487     unsigned long                   m_ulMenubarId; // it's Id, if any
 488
 489     // the return value of WM_GETDLGCODE handler
 490     long                            m_lDlgCode;
 491
 492     // implement the base class pure virtuals
 493     virtual void DoClientToScreen( int* pX
 494                                   ,int* pY
 495                                  ) const;
 496     virtual void DoScreenToClient( int* pX
 497                                   ,int* pY
 498                                  ) const;
 499     virtual void DoGetPosition( int* pX
 500                                ,int* pY
 501                               ) const;
 502     virtual void DoGetSize( int* pWidth
 503                            ,int* pHeight
 504                           ) const;
 505     virtual void DoGetClientSize( int* pWidth
 506                                  ,int* pHeight
 507                                 ) const;
 508     virtual void DoSetSize( int nX
 509                            ,int nY
 510                            ,int nWidth
 511                            ,int nHeight
 512                            ,int nSizeFlags = wxSIZE_AUTO
 513                           );
 514     virtual void DoSetClientSize( int nWidth
 515                                  ,int nHeight
 516                                 );
 517
 518     // move the window to the specified location and resize it: this is called
 519     // from both DoSetSize() and DoSetClientSize() and would usually just call
 520     // ::WinSetWindowPos() except for composite controls which will want to arrange
 521     // themselves inside the given rectangle
 522     virtual void DoMoveWindow( int nX
 523                               ,int nY
 524                               ,int nWidth
 525                               ,int nHeight
 526                              );
 527
 528 #if wxUSE_TOOLTIPS
 529     virtual void DoSetToolTip(wxToolTip* pTip);
 530 #endif // wxUSE_TOOLTIPS
 531
 532 private:
 533     // common part of all ctors
 534     void Init(void);
 535
 536     // the (non-virtual) handlers for the events
 537     bool HandleMove( int nX
 538                     ,int nY
 539                    );
 540     bool HandleJoystickEvent( WXUINT uMsg
 541                              ,int    pX
 542                              ,int    pY
 543                              ,WXUINT uFlags
 544                             );
 545
 546     bool HandleNotify( int       nIdCtrl
 547                       ,WXLPARAM  lParam
 548                       ,WXLPARAM* pResult
 549                      );
 550     // the helper functions used by HandleChar/KeyXXX methods
 551     wxKeyEvent CreateKeyEvent(wxEventType evType, int id, WXLPARAM lp) const;
 552
 553     DECLARE_DYNAMIC_CLASS(wxWindow);
 554     DECLARE_NO_COPY_CLASS(wxWindow);
 555     DECLARE_EVENT_TABLE()
 556 private:
 557     HWND                            m_hWndScrollBarHorz;
 558     HWND                            m_hWndScrollBarVert;
 559
 560     // Virtual function hiding supression
 561     inline virtual bool Reparent(wxWindowBase* pNewParent)
 562     { return(wxWindowBase::Reparent(pNewParent));};
 563 }; // end of wxWindow
 564
 565 // ---------------------------------------------------------------------------
 566 // global functions
 567 // ---------------------------------------------------------------------------
 568
 569 // kbd code translation
 570 WXDLLEXPORT int wxCharCodeOS2ToWX(int nKeySym);
 571 WXDLLEXPORT int wxCharCodeWXToOS2( int   nId
 572                                   ,bool* pbIsVirtual
 573                                  );
 574 #endif
 575     // _WX_WINDOW_H_