include/wx/mac/carbon/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        include/wx/mac/carbon/window.h
   3 // Purpose:     wxWindowMac class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_WINDOW_H_
  13 #define _WX_WINDOW_H_
  14
  15 #include "wx/brush.h"
  16 #include "wx/dc.h"
  17
  18 class WXDLLEXPORT wxButton;
  19 class WXDLLEXPORT wxScrollBar;
  20 class WXDLLEXPORT wxTopLevelWindowMac;
  21
  22 class wxMacControl ;
  23
  24 class WXDLLEXPORT wxWindowMac: public wxWindowBase
  25 {
  26     DECLARE_DYNAMIC_CLASS(wxWindowMac)
  27
  28     friend class wxDC;
  29     friend class wxPaintDC;
  30
  31 public:
  32     wxWindowMac();
  33
  34     wxWindowMac( wxWindowMac *parent,
  35                 wxWindowID id,
  36                 const wxPoint& pos = wxDefaultPosition,
  37                 const wxSize& size = wxDefaultSize,
  38                 long style = 0,
  39                 const wxString& name = wxPanelNameStr );
  40
  41     virtual ~wxWindowMac();
  42
  43     bool Create( wxWindowMac *parent,
  44                 wxWindowID id,
  45                 const wxPoint& pos = wxDefaultPosition,
  46                 const wxSize& size = wxDefaultSize,
  47                 long style = 0,
  48                 const wxString& name = wxPanelNameStr );
  49
  50     // implement base class pure virtuals
  51     virtual void SetLabel( const wxString& label );
  52     virtual wxString GetLabel() const;
  53
  54     virtual void Raise();
  55     virtual void Lower();
  56
  57     virtual bool Show( bool show = true );
  58     virtual bool Enable( bool enable = true );
  59
  60     virtual void SetFocus();
  61
  62     virtual void WarpPointer( int x, int y );
  63
  64     virtual void Refresh( bool eraseBackground = true,
  65                           const wxRect *rect = NULL );
  66     virtual void Freeze();
  67     virtual void Thaw();
  68
  69     virtual void Update() ;
  70     virtual void ClearBackground();
  71
  72     virtual bool SetCursor( const wxCursor &cursor );
  73     virtual bool SetFont( const wxFont &font );
  74     virtual bool SetBackgroundColour( const wxColour &colour );
  75     virtual bool SetForegroundColour( const wxColour &colour );
  76
  77     virtual int GetCharHeight() const;
  78     virtual int GetCharWidth() const;
  79     virtual void GetTextExtent( const wxString& string,
  80                                int *x, int *y,
  81                                int *descent = NULL,
  82                                int *externalLeading = NULL,
  83                                const wxFont *theFont = NULL )
  84                                const;
  85 protected:
  86     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
  87 public:
  88     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  89                                int range, bool refresh = true );
  90     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
  91     virtual int GetScrollPos( int orient ) const;
  92     virtual int GetScrollThumb( int orient ) const;
  93     virtual int GetScrollRange( int orient ) const;
  94     virtual void ScrollWindow( int dx, int dy,
  95                                const wxRect* rect = (wxRect *) NULL );
  96     virtual bool Reparent( wxWindowBase *newParent );
  97
  98 #if wxUSE_DRAG_AND_DROP
  99     virtual void SetDropTarget( wxDropTarget *dropTarget );
 100 #endif
 101
 102     // Accept files for dragging
 103     virtual void DragAcceptFiles( bool accept );
 104
 105     // implementation from now on
 106     // --------------------------
 107
 108     void MacClientToRootWindow( int *x , int *y ) const;
 109     void MacRootWindowToClient( int *x , int *y ) const;
 110
 111     void MacWindowToRootWindow( int *x , int *y ) const;
 112     void MacWindowToRootWindow( short *x , short *y ) const;
 113
 114     void MacRootWindowToWindow( int *x , int *y ) const;
 115     void MacRootWindowToWindow( short *x , short *y ) const;
 116
 117     virtual wxString MacGetToolTipString( wxPoint &where );
 118
 119     // simple accessors
 120     // ----------------
 121
 122     virtual WXWidget GetHandle() const;
 123
 124     virtual bool SetTransparent(wxByte alpha);
 125     virtual bool CanSetTransparent();
 126     virtual wxByte GetTransparent() const ;
 127
 128 #if WXWIN_COMPATIBILITY_2_4
 129     bool GetTransparentBackground() const { return m_backgroundTransparent; }
 130     void SetTransparent(bool t = true) { m_backgroundTransparent = t; }
 131 #endif
 132
 133     // event handlers
 134     // --------------
 135     void OnSetFocus( wxFocusEvent& event );
 136     void OnPaint( wxPaintEvent& event );
 137     void OnNcPaint( wxNcPaintEvent& event );
 138     void OnEraseBackground(wxEraseEvent& event );
 139     void OnMouseEvent( wxMouseEvent &event );
 140
 141     void MacOnScroll( wxScrollEvent&event );
 142
 143     bool AcceptsFocus() const;
 144
 145 public:
 146     static long         MacRemoveBordersFromStyle( long style ) ;
 147
 148 public:
 149     void OnInternalIdle();
 150
 151     // For implementation purposes:
 152     // sometimes decorations make the client area smaller
 153     virtual wxPoint GetClientAreaOrigin() const;
 154
 155     wxWindowMac *FindItem(long id) const;
 156     wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;
 157
 158     virtual void        MacHandleControlClick( WXWidget control , wxInt16 controlpart , bool mouseStillDown ) ;
 159     virtual bool        MacDoRedraw( WXHRGN updatergn , long time ) ;
 160     virtual bool        MacCanFocus() const ;
 161
 162     // this should not be overriden in classes above wxWindowMac
 163     // because it is called from its destructor via DeleteChildren
 164     virtual void        RemoveChild( wxWindowBase *child );
 165     virtual void        MacPaintBorders( int left , int top ) ;
 166
 167     // invalidates the borders and focus area around the control;
 168     // must not be virtual as it will be called during destruction
 169     void                MacInvalidateBorders() ;
 170
 171     WXWindow            MacGetTopLevelWindowRef() const ;
 172     wxTopLevelWindowMac* MacGetTopLevelWindow() const ;
 173
 174     virtual long        MacGetLeftBorderSize() const ;
 175     virtual long        MacGetRightBorderSize() const ;
 176     virtual long        MacGetTopBorderSize() const ;
 177     virtual long        MacGetBottomBorderSize() const ;
 178
 179     virtual void        MacSuperChangedPosition() ;
 180
 181     // absolute coordinates of this window's root have changed
 182     virtual void        MacTopLevelWindowChangedPosition() ;
 183
 184     virtual void        MacChildAdded() ;
 185     virtual void        MacVisibilityChanged() ;
 186     virtual void        MacEnabledStateChanged() ;
 187     virtual void        MacHiliteChanged() ;
 188     virtual wxInt32     MacControlHit( WXEVENTHANDLERREF handler , WXEVENTREF event ) ;
 189
 190     bool                MacIsReallyShown() ;
 191     bool                MacIsReallyEnabled() ;
 192     bool                MacIsReallyHilited() ;
 193
 194     bool                MacIsUserPane() { return m_macIsUserPane; }
 195
 196     virtual bool        MacSetupCursor( const wxPoint& pt ) ;
 197     virtual void        MacSetBackgroundBrush( const wxBrush &brush ) ;
 198     const wxBrush&      MacGetBackgroundBrush() const { return m_macBackgroundBrush ; }
 199
 200     // return the rectangle that would be visible of this control,
 201     // regardless whether controls are hidden
 202     // only taking into account clipping by parent windows
 203     const wxRect&       MacGetClippedClientRect() const ;
 204     const wxRect&       MacGetClippedRect() const ;
 205     const wxRect&       MacGetClippedRectWithOuterStructure() const ;
 206
 207     // returns the visible region of this control in window ie non-client coordinates
 208     const wxRegion&     MacGetVisibleRegion( bool includeOuterStructures = false ) ;
 209
 210     // returns true if children have to clipped to the content area
 211     // (e.g., scrolled windows)
 212     bool                MacClipChildren() const { return m_clipChildren ; }
 213     void                MacSetClipChildren( bool clip ) { m_clipChildren = clip ; }
 214
 215     // returns true if the grandchildren need to be clipped to the children's content area
 216     // (e.g., splitter windows)
 217     virtual bool        MacClipGrandChildren() const { return false ; }
 218     bool                MacIsWindowScrollbar( const wxWindow* sb )
 219     { return ((wxWindow*)m_hScrollBar == sb || (wxWindow*)m_vScrollBar == sb) ; }
 220
 221     virtual void        MacInstallEventHandler(WXWidget native) ;
 222     void                MacPostControlCreate(const wxPoint& pos, const wxSize& size) ;
 223     wxList&             GetSubcontrols() { return m_subControls; }
 224     WXEVENTHANDLERREF   MacGetControlEventHandler() { return m_macControlEventHandler ; }
 225
 226 #ifndef __WXMAC_OSX__
 227     virtual void            MacControlUserPaneDrawProc(wxInt16 part) ;
 228     virtual wxInt16         MacControlUserPaneHitTestProc(wxInt16 x, wxInt16 y) ;
 229     virtual wxInt16         MacControlUserPaneTrackingProc(wxInt16 x, wxInt16 y, void* actionProc) ;
 230     virtual void            MacControlUserPaneIdleProc() ;
 231     virtual wxInt16         MacControlUserPaneKeyDownProc(wxInt16 keyCode, wxInt16 charCode, wxInt16 modifiers) ;
 232     virtual void            MacControlUserPaneActivateProc(bool activating) ;
 233     virtual wxInt16         MacControlUserPaneFocusProc(wxInt16 action) ;
 234     virtual void            MacControlUserPaneBackgroundProc(void* info) ;
 235 #endif
 236
 237     // translate wxWidgets coords into ones suitable
 238     // to be passed to CreateControl calls
 239     //
 240     // returns true if non-default coords are returned, false otherwise
 241     bool                MacGetBoundsForControl(const wxPoint& pos,
 242                                            const wxSize& size,
 243                                            int& x, int& y,
 244                                            int& w, int& h , bool adjustForOrigin ) const ;
 245
 246     // calculates the real window position and size from the native control
 247     void                MacGetPositionAndSizeFromControl(int& x, int& y,
 248                                            int& w, int& h) const ;
 249
 250     // gets the inset from every part
 251     virtual void        MacGetContentAreaInset( int &left , int &top , int &right , int &bottom ) ;
 252
 253     // visibly flash the current invalid area:
 254     // useful for debugging in OSX composited (double-buffered) situation
 255     void                MacFlashInvalidAreas() ;
 256
 257     // the 'true' OS level control for this wxWindow
 258     wxMacControl*       GetPeer() const { return m_peer ; }
 259
 260 #if wxMAC_USE_CORE_GRAPHICS
 261     void *              MacGetCGContextRef() { return m_cgContextRef ; }
 262     void                MacSetCGContextRef(void * cg) { m_cgContextRef = cg ; }
 263 #endif
 264
 265 protected:
 266     // For controls like radio buttons which are genuinely composite
 267     wxList              m_subControls;
 268
 269     // number of calls to Freeze() minus number of calls to Thaw()
 270     unsigned int        m_frozenness;
 271
 272     // the peer object, allowing for cleaner API support
 273     wxMacControl *       m_peer ;
 274
 275 #if wxMAC_USE_CORE_GRAPHICS
 276     void *              m_cgContextRef ;
 277 #endif
 278
 279     // cache the clipped rectangles within the window hierarchy
 280     void                MacUpdateClippedRects() const ;
 281
 282     mutable bool        m_cachedClippedRectValid ;
 283     mutable wxRect      m_cachedClippedRectWithOuterStructure ;
 284     mutable wxRect      m_cachedClippedRect ;
 285     mutable wxRect      m_cachedClippedClientRect ;
 286     mutable wxRegion    m_cachedClippedRegionWithOuterStructure ;
 287     mutable wxRegion    m_cachedClippedRegion ;
 288     mutable wxRegion    m_cachedClippedClientRegion ;
 289
 290     // true if is is not a native control but a wxWindow control
 291     bool                m_macIsUserPane ;
 292     wxBrush             m_macBackgroundBrush ;
 293
 294     // insets of the mac control from the wx top left corner
 295     wxPoint             m_macTopLeftInset ;
 296     wxPoint             m_macBottomRightInset ;
 297     wxByte              m_macAlpha ;
 298
 299     wxScrollBar*        m_hScrollBar ;
 300     wxScrollBar*        m_vScrollBar ;
 301     wxString            m_label ;
 302
 303     // set to true if we do a sharp clip at the content area of this window
 304     // must be dynamic as eg a panel normally is not clipping precisely, but if
 305     // it becomes the target window of a scrolled window it has to...
 306     bool                m_clipChildren ;
 307
 308     virtual bool        MacIsChildOfClientArea( const wxWindow* child ) const ;
 309
 310     void                MacCreateScrollBars( long style ) ;
 311     void                MacRepositionScrollBars() ;
 312     void                MacUpdateControlFont() ;
 313
 314     void                MacPropagateVisibilityChanged() ;
 315     void                MacPropagateEnabledStateChanged() ;
 316     void                MacPropagateHiliteChanged() ;
 317
 318 #if WXWIN_COMPATIBILITY_2_4
 319     bool                 m_backgroundTransparent ;
 320 #endif
 321
 322     // implement the base class pure virtuals
 323     virtual wxSize DoGetBestSize() const;
 324     virtual wxSize DoGetSizeFromClientSize( const wxSize & size ) const;
 325     virtual void DoClientToScreen( int *x, int *y ) const;
 326     virtual void DoScreenToClient( int *x, int *y ) const;
 327     virtual void DoGetPosition( int *x, int *y ) const;
 328     virtual void DoGetSize( int *width, int *height ) const;
 329     virtual void DoGetClientSize( int *width, int *height ) const;
 330     virtual void DoSetSize(int x, int y,
 331                            int width, int height,
 332                            int sizeFlags = wxSIZE_AUTO);
 333     virtual void DoSetClientSize(int width, int height);
 334
 335     virtual void DoCaptureMouse();
 336     virtual void DoReleaseMouse();
 337
 338     // move the window to the specified location and resize it: this is called
 339     // from both DoSetSize() and DoSetClientSize() and would usually just call
 340     // ::MoveWindow() except for composite controls which will want to arrange
 341     // themselves inside the given rectangle
 342     virtual void DoMoveWindow( int x, int y, int width, int height );
 343     virtual void DoSetWindowVariant( wxWindowVariant variant );
 344
 345 #if wxUSE_TOOLTIPS
 346     virtual void DoSetToolTip( wxToolTip *tip );
 347 #endif
 348
 349 private:
 350     // common part of all ctors
 351     void Init();
 352
 353     WXEVENTHANDLERREF    m_macControlEventHandler ;
 354
 355     DECLARE_NO_COPY_CLASS(wxWindowMac)
 356     DECLARE_EVENT_TABLE()
 357 };
 358
 359 #endif // _WX_WINDOW_H_