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: dc.h 42631 2006-10-29 17:55:09Z RR $
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
37class wxMacPortStateHelper;
38
39#if !wxUSE_GRAPHICS_CONTEXT
40
41class WXDLLEXPORT wxGraphicPath
42{
43public :
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
64class WXDLLEXPORT wxGraphicContext
65{
66public:
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
107class WXDLLEXPORT wxDC: public wxDCBase
108{
109    DECLARE_DYNAMIC_CLASS(wxDC)
110    DECLARE_NO_COPY_CLASS(wxDC)
111
112public:
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 SetMapMode(int mode);
145    virtual void SetUserScale(double x, double y);
146
147    virtual void SetLogicalScale(double x, double y);
148    virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
149    virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
150    virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
151    virtual void SetLogicalFunction(int function);
152
153    virtual void SetTextForeground(const wxColour& colour);
154    virtual void SetTextBackground(const wxColour& colour);
155
156    virtual void ComputeScaleAndOrigin();
157
158public:
159    wxCoord XDEV2LOG(wxCoord x) const
160    {
161        return wxRound((double)(x - m_deviceOriginX) / m_scaleX) * m_signX + m_logicalOriginX;
162    }
163    wxCoord XDEV2LOGREL(wxCoord x) const
164    {
165        return wxRound((double)(x) / m_scaleX);
166    }
167    wxCoord YDEV2LOG(wxCoord y) const
168    {
169        return wxRound((double)(y - m_deviceOriginY) / m_scaleY) * m_signY + m_logicalOriginY;
170    }
171    wxCoord YDEV2LOGREL(wxCoord y) const
172    {
173        return wxRound((double)(y) / m_scaleY);
174    }
175    wxCoord XLOG2DEV(wxCoord x) const
176    {
177        return wxRound((double)(x - m_logicalOriginX) * m_scaleX) * m_signX + m_deviceOriginX;
178    }
179    wxCoord XLOG2DEVREL(wxCoord x) const
180    {
181        return wxRound((double)(x) * m_scaleX);
182    }
183    wxCoord YLOG2DEV(wxCoord y) const
184    {
185        return wxRound((double)(y - m_logicalOriginY) * m_scaleY) * m_signY + m_deviceOriginY;
186    }
187    wxCoord YLOG2DEVREL(wxCoord y) const
188    {
189        return wxRound((double)(y) * m_scaleY);
190    }
191
192    wxCoord XLOG2DEVMAC(wxCoord x) const
193    {
194        return wxRound((double)(x - m_logicalOriginX) * m_scaleX) * m_signX + m_deviceOriginX + m_macLocalOrigin.x;
195    }
196
197    wxCoord YLOG2DEVMAC(wxCoord y) const
198    {
199        return wxRound((double)(y - m_logicalOriginY) * m_scaleY) * m_signY + m_deviceOriginY + m_macLocalOrigin.y;
200    }
201
202#if wxMAC_USE_CORE_GRAPHICS
203    wxGraphicsContext* GetGraphicsContext() { return m_graphicContext; }
204#else
205    WXHRGN MacGetCurrentClipRgn() { return m_macCurrentClipRgn; }
206    static void MacSetupBackgroundForCurrentPort(const wxBrush& background );
207#endif
208
209protected:
210    virtual void DoGetTextExtent(const wxString& string,
211        wxCoord *x, wxCoord *y,
212        wxCoord *descent = NULL,
213        wxCoord *externalLeading = NULL,
214        wxFont *theFont = NULL) const;
215
216    virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
217
218    virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
219                             int style = wxFLOOD_SURFACE);
220
221    virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
222
223    virtual void DoDrawPoint(wxCoord x, wxCoord y);
224
225#if wxMAC_USE_CORE_GRAPHICS && wxUSE_SPLINES
226    virtual void DoDrawSpline(wxList *points);
227#endif
228
229    virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
230
231    virtual void DoDrawArc(wxCoord x1, wxCoord y1,
232                           wxCoord x2, wxCoord y2,
233                           wxCoord xc, wxCoord yc);
234
235    virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
236                                   double sa, double ea);
237
238    virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
239    virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
240                                        wxCoord width, wxCoord height,
241                                        double radius);
242    virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
243
244    virtual void DoCrossHair(wxCoord x, wxCoord y);
245
246    virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
247    virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
248                              bool useMask = false);
249
250    virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
251    virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
252                                   double angle);
253
254    virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
255                        wxDC *source, wxCoord xsrc, wxCoord ysrc,
256                        int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
257
258    // this is gnarly - we can't even call this function DoSetClippingRegion()
259    // because of virtual function hiding
260
261    virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
262    virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
263                                     wxCoord width, wxCoord height);
264
265    virtual void DoGetSizeMM(int *width, int *height) const;
266
267    virtual void DoDrawLines(int n, wxPoint points[],
268                             wxCoord xoffset, wxCoord yoffset);
269    virtual void DoDrawPolygon(int n, wxPoint points[],
270                               wxCoord xoffset, wxCoord yoffset,
271                               int fillStyle = wxODDEVEN_RULE);
272
273protected:
274    // scaling variables
275    double       m_mm_to_pix_x, m_mm_to_pix_y;
276
277     // To be set using SetDeviceOrigin()
278     // by external classes such as wxScrolledWindow
279    long         m_externalDeviceOriginX, m_externalDeviceOriginY;
280
281#if !wxMAC_USE_CORE_GRAPHICS
282    // If un-scrolled is non-zero or d.o. changes with scrolling.
283    // Set using SetInternalDeviceOrigin().
284    long         m_internalDeviceOriginX, m_internalDeviceOriginY;
285
286    WXHBITMAP            m_macMask;
287#endif
288
289    // not yet used
290    bool         m_needComputeScaleX, m_needComputeScaleY;
291
292public:
293    // implementation
294    void                    MacInstallFont() const;
295
296    // in order to preserve the const inheritance of the virtual functions,
297    // we have to use mutable variables starting from CWPro 5
298    wxPoint                         m_macLocalOrigin;
299    mutable void                   *m_macATSUIStyle;
300
301    WXHDC                           m_macPort;
302
303#if wxMAC_USE_CORE_GRAPHICS
304    wxGraphicsContext              *m_graphicContext;
305#else
306    void                            MacInstallPen() const;
307    void                            MacInstallBrush() const;
308
309    void                            MacSetupPort( wxMacPortStateHelper *ph ) const;
310    void                            MacCleanupPort( wxMacPortStateHelper *ph ) const;
311
312    mutable wxMacPortStateHelper   *m_macCurrentPortStateHelper;
313
314    mutable bool                    m_macFontInstalled;
315    mutable bool                    m_macPenInstalled;
316    mutable bool                    m_macBrushInstalled;
317
318    WXHRGN                          m_macBoundaryClipRgn;
319    WXHRGN                          m_macCurrentClipRgn;
320    mutable bool                    m_macFormerAliasState;
321    mutable short                   m_macFormerAliasSize;
322    mutable bool                    m_macAliasWasEnabled;
323    mutable void                   *m_macForegroundPixMap;
324    mutable void                   *m_macBackgroundPixMap;
325#endif
326};
327
328#endif
329
330#endif // _WX_DC_H_
331