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 class wxMacPortStateHelper;
  38
  39 #if !wxUSE_GRAPHICS_CONTEXT
  40
  41 class WXDLLEXPORT wxGraphicPath
  42 {
  43 public :
  44     virtual ~wxGraphicPath() {}
  45
  46     virtual void MoveToPoint( wxCoord x1, wxCoord y1 ) = 0;
  47
  48     virtual void AddLineToPoint( wxCoord x1, wxCoord y1 ) = 0;
  49
  50     virtual void AddQuadCurveToPoint( wxCoord cx1, wxCoord cy1, wxCoord x1, wxCoord y1 ) = 0;
  51
  52     virtual void AddRectangle( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) = 0;
  53
  54     virtual void AddCircle( wxCoord x, wxCoord y, wxCoord r ) = 0;
  55
  56     // draws a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1)
  57     virtual void AddArcToPoint( wxCoord x1, wxCoord y1 , wxCoord x2, wxCoord y2, wxCoord r ) = 0 ;
  58
  59     virtual void AddArc( wxCoord x, wxCoord y, wxCoord r, double startAngle, double endAngle, bool clockwise ) = 0 ;
  60
  61     virtual void CloseSubpath() = 0;
  62 };
  63
  64 class WXDLLEXPORT wxGraphicContext
  65 {
  66 public:
  67     virtual ~wxGraphicContext() {}
  68
  69     virtual wxGraphicPath * CreatePath() = 0;
  70
  71     virtual void PushState() = 0 ;
  72
  73     virtual void PopState() = 0 ;
  74
  75     virtual void Clip( const wxRegion &region ) = 0;
  76
  77     virtual void SetPen( const wxPen &pen ) = 0;
  78
  79     virtual void SetBrush( const wxBrush &brush ) = 0;
  80
  81     virtual void SetFont( const wxFont &font ) = 0 ;
  82
  83     virtual void SetTextColor( const wxColour &col ) = 0 ;
  84
  85     virtual void StrokePath( const wxGraphicPath *path ) = 0;
  86
  87     virtual void DrawPath( const wxGraphicPath *path, int fillStyle = wxWINDING_RULE ) = 0;
  88
  89     virtual void FillPath( const wxGraphicPath *path, const wxColor &fillColor, int fillStyle = wxWINDING_RULE ) = 0;
  90
  91     virtual void DrawBitmap( const wxBitmap &bmp, wxCoord x, wxCoord y, wxCoord w, wxCoord h ) = 0 ;
  92
  93     virtual void DrawIcon( const wxIcon &icon, wxCoord x, wxCoord y, wxCoord w, wxCoord h ) = 0 ;
  94
  95     virtual void DrawText( const wxString &str, wxCoord x, wxCoord y, double angle ) = 0 ;
  96
  97     virtual void GetTextExtent( const wxString &text, wxCoord *width, wxCoord *height,
  98                             wxCoord *descent, wxCoord *externalLeading ) const  = 0 ;
  99
 100     virtual void GetPartialTextExtents(const wxString& text, wxArrayInt& widths) const = 0 ;
 101
 102     virtual void Translate( wxCoord dx , wxCoord dy ) = 0 ;
 103
 104     virtual void Scale( wxCoord xScale , wxCoord yScale ) = 0 ;
 105 };
 106
 107 class WXDLLEXPORT wxDC: public wxDCBase
 108 {
 109     DECLARE_DYNAMIC_CLASS(wxDC)
 110     DECLARE_NO_COPY_CLASS(wxDC)
 111
 112 public:
 113     wxDC();
 114     virtual ~wxDC();
 115
 116     // implement base class pure virtuals
 117     // ----------------------------------
 118
 119     virtual void Clear();
 120
 121     virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return true; }
 122     virtual void EndDoc(void) {}
 123
 124     virtual void StartPage(void) {}
 125     virtual void EndPage(void) {}
 126
 127     virtual void SetFont(const wxFont& font);
 128     virtual void SetPen(const wxPen& pen);
 129     virtual void SetBrush(const wxBrush& brush);
 130     virtual void SetBackground(const wxBrush& brush);
 131     virtual void SetBackgroundMode(int mode);
 132     virtual void SetPalette(const wxPalette& palette);
 133
 134     virtual void DestroyClippingRegion();
 135
 136     virtual wxCoord GetCharHeight() const;
 137     virtual wxCoord GetCharWidth() const;
 138
 139     virtual bool CanDrawBitmap() const;
 140     virtual bool CanGetTextExtent() const;
 141     virtual int GetDepth() const;
 142     virtual wxSize GetPPI() const;
 143
 144     virtual void SetLogicalFunction(int function);
 145
 146     virtual void SetTextForeground(const wxColour& colour);
 147     virtual void SetTextBackground(const wxColour& colour);
 148
 149 public:
 150     wxCoord XDEV2LOG(wxCoord x) const       { return DeviceToLogicalX( x ); }
 151     wxCoord XDEV2LOGREL(wxCoord x) const    { return DeviceToLogicalXRel( x ); }
 152     wxCoord YDEV2LOG(wxCoord y) const       { return DeviceToLogicalY( y ); }
 153     wxCoord YDEV2LOGREL(wxCoord y) const    { return DeviceToLogicalYRel( y ); }
 154     wxCoord XLOG2DEV(wxCoord x) const       { return LogicalToDeviceX( x ); }
 155     wxCoord XLOG2DEVREL(wxCoord x) const    { return LogicalToDeviceXRel( x ); }
 156     wxCoord YLOG2DEV(wxCoord y) const       { return LogicalToDeviceY( y ); }
 157     wxCoord YLOG2DEVREL(wxCoord y) const    { return LogicalToDeviceYRel( y ); }
 158     // probably no longer needed
 159     wxCoord XLOG2DEVMAC(wxCoord x) const    { return LogicalToDeviceX( x ); }
 160     wxCoord YLOG2DEVMAC(wxCoord y) const    { return LogicalToDeviceY( y ); }
 161
 162 #if wxMAC_USE_CORE_GRAPHICS
 163     wxGraphicsContext* GetGraphicsContext() { return m_graphicContext; }
 164 #else
 165     WXHRGN MacGetCurrentClipRgn() { return m_macCurrentClipRgn; }
 166     static void MacSetupBackgroundForCurrentPort(const wxBrush& background );
 167 #endif
 168
 169 protected:
 170     virtual void DoGetTextExtent(const wxString& string,
 171         wxCoord *x, wxCoord *y,
 172         wxCoord *descent = NULL,
 173         wxCoord *externalLeading = NULL,
 174         const wxFont *theFont = NULL) const;
 175
 176     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 177
 178     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 179                              int style = wxFLOOD_SURFACE);
 180
 181     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 182
 183     virtual void DoDrawPoint(wxCoord x, wxCoord y);
 184
 185 #if wxMAC_USE_CORE_GRAPHICS && wxUSE_SPLINES
 186     virtual void DoDrawSpline(wxList *points);
 187 #endif
 188
 189     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 190
 191     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 192                            wxCoord x2, wxCoord y2,
 193                            wxCoord xc, wxCoord yc);
 194
 195     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 196                                    double sa, double ea);
 197
 198     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 199     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 200                                         wxCoord width, wxCoord height,
 201                                         double radius);
 202     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 203
 204     virtual void DoCrossHair(wxCoord x, wxCoord y);
 205
 206     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 207     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 208                               bool useMask = false);
 209
 210     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
 211     virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 212                                    double angle);
 213
 214     virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 215                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 216                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 217
 218     virtual bool DoStretchBlit(wxCoord xdest, wxCoord ydest,
 219                                wxCoord dstWidth, wxCoord dstHeight,
 220                                wxDC *source,
 221                                wxCoord xsrc, wxCoord ysrc,
 222                                wxCoord srcWidth, wxCoord srcHeight,
 223                                int rop = wxCOPY, bool useMask = false,
 224                                wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
 225
 226     // this is gnarly - we can't even call this function DoSetClippingRegion()
 227     // because of virtual function hiding
 228
 229     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
 230     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 231                                      wxCoord width, wxCoord height);
 232
 233     virtual void DoGetSizeMM(int *width, int *height) const;
 234
 235     virtual void DoDrawLines(int n, wxPoint points[],
 236                              wxCoord xoffset, wxCoord yoffset);
 237     virtual void DoDrawPolygon(int n, wxPoint points[],
 238                                wxCoord xoffset, wxCoord yoffset,
 239                                int fillStyle = wxODDEVEN_RULE);
 240
 241 protected:
 242     // scaling variables
 243     double       m_mm_to_pix_x, m_mm_to_pix_y;
 244
 245      // To be set using SetDeviceOrigin()
 246      // by external classes such as wxScrolledWindow
 247     long         m_externalDeviceOriginX, m_externalDeviceOriginY;
 248
 249 #if !wxMAC_USE_CORE_GRAPHICS
 250     // If un-scrolled is non-zero or d.o. changes with scrolling.
 251     // Set using SetInternalDeviceOrigin().
 252     long         m_internalDeviceOriginX, m_internalDeviceOriginY;
 253
 254     WXHBITMAP            m_macMask;
 255 #endif
 256
 257     // not yet used
 258     bool         m_needComputeScaleX, m_needComputeScaleY;
 259
 260 public:
 261     // implementation
 262     void                    MacInstallFont() const;
 263
 264     // in order to preserve the const inheritance of the virtual functions,
 265     // we have to use mutable variables starting from CWPro 5
 266     wxPoint                         m_macLocalOrigin;
 267     mutable void                   *m_macATSUIStyle;
 268
 269     WXHDC                           m_macPort;
 270
 271 #if wxMAC_USE_CORE_GRAPHICS
 272     wxGraphicsContext              *m_graphicContext;
 273 #else
 274     void                            MacInstallPen() const;
 275     void                            MacInstallBrush() const;
 276
 277     void                            MacSetupPort( wxMacPortStateHelper *ph ) const;
 278     void                            MacCleanupPort( wxMacPortStateHelper *ph ) const;
 279
 280     mutable wxMacPortStateHelper   *m_macCurrentPortStateHelper;
 281
 282     mutable bool                    m_macFontInstalled;
 283     mutable bool                    m_macPenInstalled;
 284     mutable bool                    m_macBrushInstalled;
 285
 286     WXHRGN                          m_macBoundaryClipRgn;
 287     WXHRGN                          m_macCurrentClipRgn;
 288     mutable bool                    m_macFormerAliasState;
 289     mutable short                   m_macFormerAliasSize;
 290     mutable bool                    m_macAliasWasEnabled;
 291     mutable void                   *m_macForegroundPixMap;
 292     mutable void                   *m_macBackgroundPixMap;
 293 #endif
 294 };
 295
 296 #endif
 297
 298 #endif // _WX_DC_H_