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