include/wx/mac/carbon/dc.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dc.h
   3 // Purpose:     wxDC 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_DC_H_
  13 #define _WX_DC_H_
  14
  15 #include "wx/pen.h"
  16 #include "wx/brush.h"
  17 #include "wx/icon.h"
  18 #include "wx/font.h"
  19 #include "wx/gdicmn.h"
  20
  21 //-----------------------------------------------------------------------------
  22 // constants
  23 //-----------------------------------------------------------------------------
  24
  25 #ifndef MM_TEXT
  26 #define MM_TEXT            0
  27 #define MM_ISOTROPIC    1
  28 #define MM_ANISOTROPIC    2
  29 #define MM_LOMETRIC        3
  30 #define MM_HIMETRIC        4
  31 #define MM_TWIPS        5
  32 #define MM_POINTS        6
  33 #define MM_METRIC        7
  34 #endif
  35
  36
  37 extern int wxPageNumber;
  38
  39
  40 class wxMacPortStateHelper ;
  41
  42 class WXDLLEXPORT wxGraphicPath
  43 {
  44 public :
  45     virtual ~wxGraphicPath() {}
  46
  47     virtual void MoveToPoint( wxCoord x1 , wxCoord y1 ) = 0 ;
  48
  49     virtual void AddLineToPoint( wxCoord x1 , wxCoord y1 ) = 0 ;
  50
  51     virtual void AddQuadCurveToPoint( wxCoord cx1, wxCoord cy1, wxCoord x1, wxCoord y1 ) = 0 ;
  52
  53     virtual void AddRectangle( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) = 0 ;
  54
  55     virtual void AddCircle( wxCoord x, wxCoord y , wxCoord r ) = 0 ;
  56
  57     virtual void CloseSubpath() = 0 ;
  58 } ;
  59
  60 class WXDLLEXPORT wxGraphicContext
  61 {
  62 public:
  63     virtual ~wxGraphicContext() {}
  64
  65     virtual void Clip( const wxRegion &region ) = 0 ;
  66
  67     virtual void StrokePath( const wxGraphicPath *path ) = 0 ;
  68
  69     virtual void DrawPath( const wxGraphicPath *path , int fillStyle = wxWINDING_RULE ) = 0 ;
  70
  71     virtual void FillPath( const wxGraphicPath *path , const wxColor &fillColor , int fillStyle = wxWINDING_RULE ) = 0 ;
  72
  73     virtual void SetPen( const wxPen &pen ) = 0 ;
  74
  75     virtual void SetBrush( const wxBrush &brush ) = 0 ;
  76
  77     virtual wxGraphicPath* CreatePath() = 0 ;
  78 } ;
  79
  80 class WXDLLEXPORT wxDC: public wxDCBase
  81 {
  82     DECLARE_DYNAMIC_CLASS(wxDC)
  83     DECLARE_NO_COPY_CLASS(wxDC)
  84
  85 public:
  86     wxDC();
  87     ~wxDC();
  88
  89     // implement base class pure virtuals
  90     // ----------------------------------
  91
  92     virtual void Clear();
  93
  94     virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return true; }
  95     virtual void EndDoc(void) {};
  96
  97     virtual void StartPage(void) {};
  98     virtual void EndPage(void) {};
  99
 100     virtual void SetFont(const wxFont& font);
 101     virtual void SetPen(const wxPen& pen);
 102     virtual void SetBrush(const wxBrush& brush);
 103     virtual void SetBackground(const wxBrush& brush);
 104     virtual void SetBackgroundMode(int mode);
 105     virtual void SetPalette(const wxPalette& palette);
 106
 107     virtual void DestroyClippingRegion();
 108
 109     virtual wxCoord GetCharHeight() const;
 110     virtual wxCoord GetCharWidth() const;
 111
 112     virtual bool CanDrawBitmap() const;
 113     virtual bool CanGetTextExtent() const;
 114     virtual int GetDepth() const;
 115     virtual wxSize GetPPI() const;
 116
 117     virtual void SetMapMode(int mode);
 118     virtual void SetUserScale(double x, double y);
 119
 120     virtual void SetLogicalScale(double x, double y);
 121     virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
 122     virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
 123     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 124     virtual void SetLogicalFunction(int function);
 125
 126     virtual void SetTextForeground(const wxColour& colour) ;
 127     virtual void SetTextBackground(const wxColour& colour) ;
 128
 129     virtual void ComputeScaleAndOrigin();
 130
 131 public:
 132     wxCoord XDEV2LOG(wxCoord x) const
 133     {
 134       long new_x = x - m_deviceOriginX ;
 135       if (new_x > 0)
 136         return (wxCoord)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
 137       else
 138         return (wxCoord)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
 139     }
 140
 141     wxCoord XDEV2LOGREL(wxCoord x) const
 142     {
 143       if (x > 0)
 144         return (wxCoord)((double)(x) / m_scaleX + 0.5);
 145       else
 146         return (wxCoord)((double)(x) / m_scaleX - 0.5);
 147     }
 148
 149     wxCoord YDEV2LOG(wxCoord y) const
 150     {
 151       long new_y = y - m_deviceOriginY ;
 152       if (new_y > 0)
 153         return (wxCoord)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
 154       else
 155         return (wxCoord)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
 156     }
 157
 158     wxCoord YDEV2LOGREL(wxCoord y) const
 159     {
 160       if (y > 0)
 161         return (wxCoord)((double)(y) / m_scaleY + 0.5);
 162       else
 163         return (wxCoord)((double)(y) / m_scaleY - 0.5);
 164     }
 165
 166     wxCoord XLOG2DEV(wxCoord x) const
 167     {
 168       long new_x = x - m_logicalOriginX;
 169       if (new_x > 0)
 170         return (wxCoord)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX  ;
 171       else
 172         return (wxCoord)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX ;
 173     }
 174
 175     wxCoord XLOG2DEVREL(wxCoord x) const
 176     {
 177       if (x > 0)
 178         return (wxCoord)((double)(x) * m_scaleX + 0.5);
 179       else
 180         return (wxCoord)((double)(x) * m_scaleX - 0.5);
 181     }
 182
 183     wxCoord YLOG2DEV(wxCoord y) const
 184     {
 185       long new_y = y - m_logicalOriginY ;
 186       if (new_y > 0)
 187         return (wxCoord)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY ;
 188       else
 189         return (wxCoord)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY ;
 190     }
 191
 192     wxCoord YLOG2DEVREL(wxCoord y) const
 193     {
 194       if (y > 0)
 195         return (wxCoord)((double)(y) * m_scaleY + 0.5);
 196       else
 197         return (wxCoord)((double)(y) * m_scaleY - 0.5);
 198     }
 199
 200     wxCoord XLOG2DEVMAC(wxCoord x) const
 201     {
 202       long new_x = x - m_logicalOriginX;
 203       if (new_x > 0)
 204         return (wxCoord)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX + m_macLocalOrigin.x ;
 205       else
 206         return (wxCoord)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX + m_macLocalOrigin.x ;
 207     }
 208
 209     wxCoord YLOG2DEVMAC(wxCoord y) const
 210     {
 211       long new_y = y - m_logicalOriginY ;
 212       if (new_y > 0)
 213         return (wxCoord)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY + m_macLocalOrigin.y ;
 214       else
 215         return (wxCoord)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY + m_macLocalOrigin.y ;
 216     }
 217
 218 #if wxMAC_USE_CORE_GRAPHICS
 219     wxGraphicContext* GetGraphicContext() { return m_graphicContext ; }
 220 #else
 221     WXHRGN MacGetCurrentClipRgn() { return m_macCurrentClipRgn ; }
 222     static void MacSetupBackgroundForCurrentPort(const wxBrush& background ) ;
 223 #endif
 224
 225 protected:
 226     virtual void DoGetTextExtent(const wxString& string,
 227         wxCoord *x, wxCoord *y,
 228         wxCoord *descent = NULL,
 229         wxCoord *externalLeading = NULL,
 230         wxFont *theFont = NULL) const;
 231     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 232
 233     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 234                              int style = wxFLOOD_SURFACE);
 235
 236     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 237
 238     virtual void DoDrawPoint(wxCoord x, wxCoord y);
 239 #if wxMAC_USE_CORE_GRAPHICS && wxUSE_SPLINES
 240     virtual void DoDrawSpline(wxList *points);
 241 #endif
 242     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 243
 244     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 245                            wxCoord x2, wxCoord y2,
 246                            wxCoord xc, wxCoord yc);
 247
 248     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 249                                    double sa, double ea);
 250
 251     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 252     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 253                                         wxCoord width, wxCoord height,
 254                                         double radius);
 255     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 256
 257     virtual void DoCrossHair(wxCoord x, wxCoord y);
 258
 259     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 260     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 261                               bool useMask = false);
 262
 263     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
 264     virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 265                                    double angle);
 266
 267     virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 268                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 269                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 270
 271     // this is gnarly - we can't even call this function DoSetClippingRegion()
 272     // because of virtual function hiding
 273     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
 274     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 275                                      wxCoord width, wxCoord height);
 276
 277     virtual void DoGetSizeMM(int* width, int* height) const;
 278
 279     virtual void DoDrawLines(int n, wxPoint points[],
 280                              wxCoord xoffset, wxCoord yoffset);
 281     virtual void DoDrawPolygon(int n, wxPoint points[],
 282                                wxCoord xoffset, wxCoord yoffset,
 283                                int fillStyle = wxODDEVEN_RULE);
 284
 285 protected:
 286     // scaling variables
 287     double       m_mm_to_pix_x, m_mm_to_pix_y;
 288
 289      // To be set using SetDeviceOrigin()
 290      // by external classes such as wxScrolledWindow
 291     long         m_externalDeviceOriginX, m_externalDeviceOriginY;
 292
 293 #if !wxMAC_USE_CORE_GRAPHICS
 294     // If un-scrolled is non-zero or d.o. changes with scrolling.
 295     // Set using SetInternalDeviceOrigin().
 296     long         m_internalDeviceOriginX, m_internalDeviceOriginY;
 297
 298     WXHBITMAP            m_macMask ;
 299 #endif
 300
 301     // not yet used
 302     bool         m_needComputeScaleX, m_needComputeScaleY;
 303
 304 public:
 305     // implementation
 306     void                    MacInstallFont() const ;
 307
 308     // in order to preserve the const inheritance of the virtual functions,
 309     // we have to use mutable variables starting from CWPro 5
 310     wxPoint                         m_macLocalOrigin ;
 311     mutable void*                   m_macATSUIStyle ;
 312
 313     WXHDC                           m_macPort ;
 314
 315 #if wxMAC_USE_CORE_GRAPHICS
 316     wxGraphicContext                * m_graphicContext ;
 317     wxPoint                         m_macLocalOriginInPort ;
 318 #else
 319     void                            MacInstallPen() const ;
 320     void                            MacInstallBrush() const ;
 321
 322     void                            MacSetupPort( wxMacPortStateHelper* ph ) const ;
 323     void                            MacCleanupPort( wxMacPortStateHelper* ph ) const ;
 324     mutable wxMacPortStateHelper*   m_macCurrentPortStateHelper ;
 325
 326     mutable bool                    m_macFontInstalled ;
 327     mutable bool                    m_macPenInstalled ;
 328     mutable bool                    m_macBrushInstalled ;
 329
 330     WXHRGN                          m_macBoundaryClipRgn ;
 331     WXHRGN                          m_macCurrentClipRgn ;
 332     mutable bool                    m_macFormerAliasState ;
 333     mutable short                   m_macFormerAliasSize ;
 334     mutable bool                    m_macAliasWasEnabled ;
 335     mutable void*                   m_macForegroundPixMap ;
 336     mutable void*                   m_macBackgroundPixMap ;
 337 #endif
 338 };
 339
 340 #endif // _WX_DC_H_