include/wx/mac/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        window.h
   3 // Purpose:     wxWindowMac class
   4 // Author:      AUTHOR
   5 // Modified by:
   6 // Created:     ??/??/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) AUTHOR
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_WINDOW_H_
  13 #define _WX_WINDOW_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "window.h"
  17 #endif
  18
  19 // ---------------------------------------------------------------------------
  20 // forward declarations
  21 // ---------------------------------------------------------------------------
  22
  23 class WXDLLEXPORT wxButton;
  24 class WXDLLEXPORT wxScrollBar;
  25
  26 // ---------------------------------------------------------------------------
  27 // constants
  28 // ---------------------------------------------------------------------------
  29
  30 // FIXME does anybody use those? they're unused by wxWindows...
  31 enum
  32 {
  33     wxKEY_SHIFT = 1,
  34     wxKEY_CTRL  = 2
  35 };
  36
  37 class WXDLLEXPORT wxWindowMac: public wxWindowBase
  38 {
  39   DECLARE_DYNAMIC_CLASS(wxWindowMac);
  40
  41   friend class wxDC;
  42   friend class wxPaintDC;
  43
  44 public:
  45         typedef struct MacWindowData
  46         {
  47                         SInt16                                                          m_macWindowBackgroundTheme ;
  48                         WindowRef                                                       m_macWindow ;
  49                         ControlHandle                                   m_macRootControl ;
  50                         wxWindowMac*                                                    m_macFocus ;
  51                         bool                                m_macHasReceivedFirstActivate ;
  52         } MacWindowData ;
  53
  54
  55     wxWindowMac() { Init(); }
  56
  57     wxWindowMac(wxWindowMac *parent,
  58              wxWindowID id,
  59              const wxPoint& pos = wxDefaultPosition,
  60              const wxSize& size = wxDefaultSize,
  61              long style = 0,
  62              const wxString& name = wxPanelNameStr)
  63     {
  64         Init();
  65         Create(parent, id, pos, size, style, name);
  66     }
  67
  68     virtual ~wxWindowMac();
  69
  70     bool Create(wxWindowMac *parent,
  71                 wxWindowID id,
  72                 const wxPoint& pos = wxDefaultPosition,
  73                 const wxSize& size = wxDefaultSize,
  74                 long style = 0,
  75                 const wxString& name = wxPanelNameStr);
  76
  77
  78     // implement base class pure virtuals
  79     virtual void SetTitle( const wxString& title);
  80     virtual wxString GetTitle() const;
  81
  82     virtual void Raise();
  83     virtual void Lower();
  84
  85     virtual bool Show( bool show = TRUE );
  86     virtual bool Enable( bool enable = TRUE );
  87
  88     virtual void SetFocus();
  89
  90     virtual void WarpPointer(int x, int y);
  91     virtual void CaptureMouse();
  92     virtual void ReleaseMouse();
  93
  94     virtual void Refresh( bool eraseBackground = TRUE,
  95                           const wxRect *rect = (const wxRect *) NULL );
  96     virtual void Clear();
  97
  98     virtual bool SetCursor( const wxCursor &cursor );
  99     virtual bool SetFont( const wxFont &font );
 100
 101     virtual int GetCharHeight() const;
 102     virtual int GetCharWidth() const;
 103     virtual void GetTextExtent(const wxString& string,
 104                                int *x, int *y,
 105                                int *descent = (int *) NULL,
 106                                int *externalLeading = (int *) NULL,
 107                                const wxFont *theFont = (const wxFont *) NULL)
 108                                const;
 109
 110     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 111
 112     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
 113                                int range, bool refresh = TRUE );
 114     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
 115     virtual int GetScrollPos( int orient ) const;
 116     virtual int GetScrollThumb( int orient ) const;
 117     virtual int GetScrollRange( int orient ) const;
 118     virtual void ScrollWindow( int dx, int dy,
 119                                const wxRect* rect = (wxRect *) NULL );
 120
 121 #if wxUSE_DRAG_AND_DROP
 122     virtual void SetDropTarget( wxDropTarget *dropTarget );
 123 #endif // wxUSE_DRAG_AND_DROP
 124
 125     // Accept files for dragging
 126     virtual void DragAcceptFiles(bool accept);
 127
 128 #if WXWIN_COMPATIBILITY
 129     // Set/get scroll attributes
 130     virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
 131     virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
 132     virtual int OldGetScrollRange(int orient) const;
 133     virtual int GetScrollPage(int orient) const;
 134
 135     // event handlers
 136         // Handle a control command
 137     virtual void OnCommand(wxWindowMac& win, wxCommandEvent& event);
 138
 139         // Override to define new behaviour for default action (e.g. double
 140         // clicking on a listbox)
 141     virtual void OnDefaultAction(wxControl * WXUNUSED(initiatingItem)) { }
 142 #endif // WXWIN_COMPATIBILITY
 143
 144 #if wxUSE_CARET && WXWIN_COMPATIBILITY
 145     // caret manipulation (old MSW only functions, see wxCaret class for the
 146     // new API)
 147     void CreateCaret(int w, int h);
 148     void CreateCaret(const wxBitmap *bitmap);
 149     void DestroyCaret();
 150     void ShowCaret(bool show);
 151     void SetCaretPos(int x, int y);
 152     void GetCaretPos(int *x, int *y) const;
 153 #endif // wxUSE_CARET
 154
 155     // Native resource loading (implemented in src/msw/nativdlg.cpp)
 156     // FIXME: should they really be all virtual?
 157     wxWindowMac* GetWindowChild1(wxWindowID id);
 158     wxWindowMac* GetWindowChild(wxWindowID id);
 159
 160     // implementation from now on
 161     // --------------------------
 162
 163         void MacClientToRootWindow( int *x , int *y ) const ;
 164         void MacRootWindowToClient( int *x , int *y ) const ;
 165
 166         virtual wxString MacGetToolTipString( wxPoint &where ) ;
 167
 168     // simple accessors
 169     // ----------------
 170
 171 //    WXHWND GetHWND() const { return m_hWnd; }
 172 //    void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
 173         virtual WXWidget GetHandle() const { return (WXWidget) NULL ; }
 174
 175     bool GetUseCtl3D() const { return m_useCtl3D; }
 176     bool GetTransparentBackground() const { return m_backgroundTransparent; }
 177     void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }
 178
 179     // event handlers
 180     // --------------
 181         void OnSetFocus(wxFocusEvent& event) ;
 182     void OnEraseBackground(wxEraseEvent& event);
 183     void OnIdle(wxIdleEvent& event);
 184     void MacOnScroll(wxScrollEvent&event ) ;
 185
 186     bool AcceptsFocus() const ;
 187
 188 public:
 189     // For implementation purposes - sometimes decorations make the client area
 190     // smaller
 191     virtual wxPoint GetClientAreaOrigin() const;
 192
 193     // Makes an adjustment to the window position (for example, a frame that has
 194     // a toolbar that it manages itself).
 195     virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
 196
 197     wxWindowMac *FindItem(long id) const;
 198     wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
 199
 200     // Make a Windows extended style from the given wxWindows window style
 201     static WXDWORD MakeExtendedStyle(long style,
 202                                      bool eliminateBorders = TRUE);
 203     // Determine whether 3D effects are wanted
 204     WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) const;
 205
 206     // MSW only: TRUE if this control is part of the main control
 207     virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
 208
 209  #if WXWIN_COMPATIBILITY
 210     wxObject *GetChild(int number) const;
 211     virtual void MSWDeviceToLogical(float *x, float *y) const;
 212 #endif // WXWIN_COMPATIBILITY
 213
 214     // Setup background and foreground colours correctly
 215     virtual void SetupColours();
 216
 217
 218 #if WXWIN_COMPATIBILITY
 219     void SetShowing(bool show) { (void)Show(show); }
 220     bool IsUserEnabled() const { return IsEnabled(); }
 221 #endif // WXWIN_COMPATIBILITY
 222
 223     // Responds to colour changes: passes event on to children.
 224     void OnSysColourChanged(wxSysColourChangedEvent& event);
 225 public :
 226         virtual void                                            MacCreateRealWindow( const wxString& title,
 227            const wxPoint& pos,
 228            const wxSize& size,
 229            long style,
 230            const wxString& name ) ;
 231         static bool                                                     MacGetWindowFromPoint( const wxPoint &point , wxWindowMac** outWin ) ;
 232         virtual void                                            MacActivate( EventRecord *ev , bool inIsActivating ) ;
 233         virtual void                                            MacUpdate( EventRecord *ev ) ;
 234         virtual void                                            MacUpdateImmediately() ;
 235         virtual void                                            MacRedraw( RgnHandle updatergn , long time) ;
 236         virtual void                                            MacMouseDown( EventRecord *ev , short windowPart ) ;
 237         virtual void                                            MacMouseUp( EventRecord *ev , short windowPart ) ;
 238         virtual void                                            MacMouseMoved( EventRecord *ev , short windowPart ) ;
 239         virtual void                                            MacKeyDown( EventRecord *ev ) ;
 240         virtual bool                                            MacCanFocus() const { return true ; }
 241
 242         virtual void                                            MacFireMouseEvent( EventRecord *ev ) ;
 243         virtual bool                                            MacDispatchMouseEvent(wxMouseEvent& event ) ;
 244         virtual void                                            MacEraseBackground( Rect *rect ) ;
 245         virtual void                                            MacPaintBorders() ;
 246         // obsolete : only for link compatibility
 247         virtual void                                            MacPaint( wxPaintEvent &event ) ;
 248         WindowRef                                                       GetMacRootWindow() const  ;
 249
 250         virtual ControlHandle                           MacGetContainerForEmbedding() ;
 251
 252         virtual long                                            MacGetLeftBorderSize() const ;
 253         virtual long                                            MacGetRightBorderSize() const ;
 254         virtual long                                            MacGetTopBorderSize() const ;
 255         virtual long                                            MacGetBottomBorderSize() const ;
 256
 257         static long                                                     MacRemoveBordersFromStyle( long style ) ;
 258         virtual void                                            MacSuperChangedPosition() ;
 259         virtual void                        MacTopLevelWindowChangedPosition() ;
 260         virtual void                                            MacSuperShown( bool show ) ;
 261         bool                                                            MacIsReallyShown() const ;
 262 /*
 263         bool                                                                            MacSetupFocusPort() ;
 264         bool                                                                            MacSetupDrawingPort() ;
 265         bool                                                                            MacSetupFocusClientPort() ;
 266         bool                                                                            MacSetupDrawingClientPort() ;
 267 */
 268         virtual bool                                            MacSetPortFocusParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindowMac* rootwin )  ;
 269         virtual bool                                            MacSetPortDrawingParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindowMac* rootwin )  ;
 270
 271         virtual void                                            MacGetPortParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindowMac** rootwin ) ;
 272         virtual void                                            MacGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef *window  , wxWindowMac** rootwin) ;
 273         virtual void                                            MacDoGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef *window  , wxWindowMac** rootwin) ;
 274         MacWindowData*                                          MacGetWindowData() { return m_macWindowData ; }
 275         static WindowRef                                        MacGetWindowInUpdate() { return s_macWindowInUpdate ; }
 276         bool                                                            MacIsWindowScrollbar( const wxScrollBar* sb ) { return (m_hScrollBar == sb || m_vScrollBar == sb) ; }
 277         static wxWindowMac*                                     s_lastMouseWindow ;
 278 private:
 279         virtual bool                                            MacGetWindowFromPointSub( const wxPoint &point , wxWindowMac** outWin ) ;
 280 protected:
 281         MacWindowData*                          m_macWindowData ;
 282         static WindowRef                        s_macWindowInUpdate ;
 283         RgnHandle                                       m_macUpdateRgn ;
 284         bool                                            m_macEraseOnRedraw ;
 285
 286         int                                                                     m_x ;
 287         int                                                                     m_y ;
 288         int                                                                     m_width ;
 289         int                                                                     m_height ;
 290
 291         wxScrollBar*                                    m_hScrollBar ;
 292         wxScrollBar*                                    m_vScrollBar ;
 293         wxString                                                m_label ;
 294
 295         void                                                                    MacCreateScrollBars( long style ) ;
 296         void                                                                    MacRepositionScrollBars() ;
 297
 298     // additional (MSW specific) flags
 299     bool                  m_useCtl3D:1; // Using CTL3D for this control
 300     bool                  m_backgroundTransparent:1;
 301     bool                  m_mouseInWindow:1;
 302     bool                  m_doubleClickAllowed:1;
 303     bool                  m_winCaptured:1;
 304
 305     // the size of one page for scrolling
 306     int                   m_xThumbSize;
 307     int                   m_yThumbSize;
 308
 309 //    WXHMENU               m_hMenu; // Menu, if any
 310
 311     // implement the base class pure virtuals
 312     virtual void DoClientToScreen( int *x, int *y ) const;
 313     virtual void DoScreenToClient( int *x, int *y ) const;
 314     virtual void DoGetPosition( int *x, int *y ) const;
 315     virtual void DoGetSize( int *width, int *height ) const;
 316     virtual void DoGetClientSize( int *width, int *height ) const;
 317     virtual void DoSetSize(int x, int y,
 318                            int width, int height,
 319                            int sizeFlags = wxSIZE_AUTO);
 320     virtual void DoSetClientSize(int width, int height);
 321
 322     // move the window to the specified location and resize it: this is called
 323     // from both DoSetSize() and DoSetClientSize() and would usually just call
 324     // ::MoveWindow() except for composite controls which will want to arrange
 325     // themselves inside the given rectangle
 326     virtual void DoMoveWindow(int x, int y, int width, int height);
 327
 328 #if wxUSE_TOOLTIPS
 329     virtual void DoSetToolTip( wxToolTip *tip );
 330 #endif // wxUSE_TOOLTIPS
 331
 332 private:
 333     // common part of all ctors
 334     void Init();
 335
 336     DECLARE_NO_COPY_CLASS(wxWindowMac)
 337     DECLARE_EVENT_TABLE()
 338 };
 339
 340 // associate mac windows with wx counterparts
 341
 342 wxWindowMac* wxFindWinFromMacWindow( WindowRef inWindow ) ;
 343 void wxAssociateWinWithMacWindow(WindowRef inWindow, wxWindowMac *win) ;
 344 void wxRemoveMacWindowAssociation(wxWindowMac *win) ;
 345
 346 /*
 347 class wxMacFocusHelper
 348 {
 349 public :
 350         wxMacFocusHelper( wxWindowMac * theWindow ) ;
 351         ~wxMacFocusHelper() ;
 352         bool Ok() { return m_ok ; }
 353
 354 private :
 355         GrafPtr         m_formerPort ;
 356         GrafPtr         m_currentPort ;
 357         bool                    m_ok ;
 358 } ;
 359 */
 360
 361 class wxMacDrawingHelper
 362 {
 363 public :
 364         wxMacDrawingHelper( wxWindowMac * theWindow ) ;
 365         ~wxMacDrawingHelper() ;
 366         bool Ok() { return m_ok ; }
 367
 368 private :
 369         GrafPtr         m_formerPort ;
 370         GrafPtr         m_currentPort ;
 371         PenState        m_savedPenState ;
 372         bool                    m_ok ;
 373 } ;
 374 /*
 375 class wxMacFocusClientHelper
 376 {
 377 public :
 378         wxMacFocusClientHelper( wxWindowMac * theWindow ) ;
 379         ~wxMacFocusClientHelper() ;
 380         bool Ok() { return m_ok ; }
 381
 382 private :
 383         GrafPtr         m_formerPort ;
 384         GrafPtr         m_currentPort ;
 385         bool                    m_ok ;
 386 } ;
 387 */
 388 class wxMacDrawingClientHelper
 389 {
 390 public :
 391         wxMacDrawingClientHelper( wxWindowMac * theWindow ) ;
 392         ~wxMacDrawingClientHelper() ;
 393         bool Ok() { return m_ok ; }
 394
 395 private :
 396         GrafPtr         m_formerPort ;
 397         GrafPtr         m_currentPort ;
 398         PenState        m_savedPenState ;
 399         bool                    m_ok ;
 400 } ;
 401
 402 #endif
 403     // _WX_WINDOW_H_