include/wx/mac/dc.h

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