include/wx/mac/carbon/window.h

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