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