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
 232     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 233
 234     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 235                              int style = wxFLOOD_SURFACE);
 236
 237     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 238
 239     virtual void DoDrawPoint(wxCoord x, wxCoord y);
 240
 241 #if wxMAC_USE_CORE_GRAPHICS && wxUSE_SPLINES
 242     virtual void DoDrawSpline(wxList *points);
 243 #endif
 244
 245     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 246
 247     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 248                            wxCoord x2, wxCoord y2,
 249                            wxCoord xc, wxCoord yc);
 250
 251     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 252                                    double sa, double ea);
 253
 254     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 255     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 256                                         wxCoord width, wxCoord height,
 257                                         double radius);
 258     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 259
 260     virtual void DoCrossHair(wxCoord x, wxCoord y);
 261
 262     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 263     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 264                               bool useMask = false);
 265
 266     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
 267     virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 268                                    double angle);
 269
 270     virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 271                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 272                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 273
 274     // this is gnarly - we can't even call this function DoSetClippingRegion()
 275     // because of virtual function hiding
 276
 277     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
 278     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 279                                      wxCoord width, wxCoord height);
 280
 281     virtual void DoGetSizeMM(int *width, int *height) const;
 282
 283     virtual void DoDrawLines(int n, wxPoint points[],
 284                              wxCoord xoffset, wxCoord yoffset);
 285     virtual void DoDrawPolygon(int n, wxPoint points[],
 286                                wxCoord xoffset, wxCoord yoffset,
 287                                int fillStyle = wxODDEVEN_RULE);
 288
 289 protected:
 290     // scaling variables
 291     double       m_mm_to_pix_x, m_mm_to_pix_y;
 292
 293      // To be set using SetDeviceOrigin()
 294      // by external classes such as wxScrolledWindow
 295     long         m_externalDeviceOriginX, m_externalDeviceOriginY;
 296
 297 #if !wxMAC_USE_CORE_GRAPHICS
 298     // If un-scrolled is non-zero or d.o. changes with scrolling.
 299     // Set using SetInternalDeviceOrigin().
 300     long         m_internalDeviceOriginX, m_internalDeviceOriginY;
 301
 302     WXHBITMAP            m_macMask;
 303 #endif
 304
 305     // not yet used
 306     bool         m_needComputeScaleX, m_needComputeScaleY;
 307
 308 public:
 309     // implementation
 310     void                    MacInstallFont() const;
 311
 312     // in order to preserve the const inheritance of the virtual functions,
 313     // we have to use mutable variables starting from CWPro 5
 314     wxPoint                         m_macLocalOrigin;
 315     mutable void                   *m_macATSUIStyle;
 316
 317     WXHDC                           m_macPort;
 318
 319 #if wxMAC_USE_CORE_GRAPHICS
 320     wxGraphicContext                *m_graphicContext;
 321     wxPoint                         m_macLocalOriginInPort;
 322 #else
 323     void                            MacInstallPen() const;
 324     void                            MacInstallBrush() const;
 325
 326     void                            MacSetupPort( wxMacPortStateHelper *ph ) const;
 327     void                            MacCleanupPort( wxMacPortStateHelper *ph ) const;
 328
 329     mutable wxMacPortStateHelper   *m_macCurrentPortStateHelper;
 330
 331     mutable bool                    m_macFontInstalled;
 332     mutable bool                    m_macPenInstalled;
 333     mutable bool                    m_macBrushInstalled;
 334
 335     WXHRGN                          m_macBoundaryClipRgn;
 336     WXHRGN                          m_macCurrentClipRgn;
 337     mutable bool                    m_macFormerAliasState;
 338     mutable short                   m_macFormerAliasSize;
 339     mutable bool                    m_macAliasWasEnabled;
 340     mutable void                   *m_macForegroundPixMap;
 341     mutable void                   *m_macBackgroundPixMap;
 342 #endif
 343 };
 344
 345 #endif // _WX_DC_H_