[wxWidgets.git] / include / wx / mac / dc.h

/////////////////////////////////////////////////////////////////////////////
// Name:        dc.h
// Purpose:     wxDC class
// Author:      AUTHOR
// Modified by:
// Created:     ??/??/98
// RCS-ID:      $Id$
// Copyright:   (c) AUTHOR
// Licence:   	wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_DC_H_
#define _WX_DC_H_

#ifdef __GNUG__
#pragma interface "dc.h"
#endif

#include "wx/pen.h"
#include "wx/brush.h"
#include "wx/icon.h"
#include "wx/font.h"
#include "wx/gdicmn.h"
#include "wx/mac/aga.h"

//-----------------------------------------------------------------------------
// constants
//-----------------------------------------------------------------------------

#ifndef MM_TEXT
#define MM_TEXT			0
#define MM_ISOTROPIC	1
#define MM_ANISOTROPIC	2
#define MM_LOMETRIC		3
#define MM_HIMETRIC		4
#define MM_TWIPS		5
#define MM_POINTS		6
#define MM_METRIC		7
#endif

//-----------------------------------------------------------------------------
// global variables
//-----------------------------------------------------------------------------

extern int wxPageNumber;

//-----------------------------------------------------------------------------
// wxDC
//-----------------------------------------------------------------------------

class WXDLLEXPORT wxMacPortSetter
{
public :
	wxMacPortSetter( const wxDC* dc ) ;
	~wxMacPortSetter() ;
private :
	AGAPortHelper m_ph ;
} ;

class WXDLLEXPORT wxDC: public wxDCBase
{
  DECLARE_DYNAMIC_CLASS(wxDC)

  public:

    wxDC();
    ~wxDC();
    

    // implement base class pure virtuals
    // ----------------------------------

    virtual void Clear();

    virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return TRUE; }
    virtual void EndDoc(void) {};
    
    virtual void StartPage(void) {};
    virtual void EndPage(void) {};

    virtual void SetFont(const wxFont& font);
    virtual void SetPen(const wxPen& pen);
    virtual void SetBrush(const wxBrush& brush);
    virtual void SetBackground(const wxBrush& brush);
    virtual void SetBackgroundMode(int mode);
    virtual void SetPalette(const wxPalette& palette);

    virtual void DestroyClippingRegion();

    virtual wxCoord GetCharHeight() const;
    virtual wxCoord GetCharWidth() const;
    virtual void DoGetTextExtent(const wxString& string,
                                 wxCoord *x, wxCoord *y,
                                 wxCoord *descent = NULL,
                                 wxCoord *externalLeading = NULL,
                                 wxFont *theFont = NULL) const;

    virtual bool CanDrawBitmap() const;
    virtual bool CanGetTextExtent() const;
    virtual int GetDepth() const;
    virtual wxSize GetPPI() const;

    virtual void SetMapMode(int mode);
    virtual void SetUserScale(double x, double y);

    virtual void SetLogicalScale(double x, double y);
    virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
    virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
    virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
    virtual void SetLogicalFunction(int function);

    virtual void SetTextForeground(const wxColour& colour) ;
    virtual void SetTextBackground(const wxColour& colour) ;

    void ComputeScaleAndOrigin(void);
  public:
  
    
    wxCoord XDEV2LOG(wxCoord x) const
	{
	  long new_x = x - m_deviceOriginX;
	  if (new_x > 0) 
	    return (wxCoord)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
	  else
	    return (wxCoord)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
	}
    wxCoord XDEV2LOGREL(wxCoord x) const
	{ 
	  if (x > 0) 
	    return (wxCoord)((double)(x) / m_scaleX + 0.5);
	  else
	    return (wxCoord)((double)(x) / m_scaleX - 0.5);
	}
    wxCoord YDEV2LOG(wxCoord y) const
	{
	  long new_y = y - m_deviceOriginY;
	  if (new_y > 0)
	    return (wxCoord)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
	  else
	    return (wxCoord)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
	}
    wxCoord YDEV2LOGREL(wxCoord y) const
	{ 
	  if (y > 0)
	    return (wxCoord)((double)(y) / m_scaleY + 0.5);
	  else
	    return (wxCoord)((double)(y) / m_scaleY - 0.5);
	}
    wxCoord XLOG2DEV(wxCoord x) const
	{ 
	  long new_x = x - m_logicalOriginX;
	  if (new_x > 0)
	    return (wxCoord)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX;
	  else
	    return (wxCoord)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX;
	}
    wxCoord XLOG2DEVREL(wxCoord x) const
	{ 
	  if (x > 0)
	    return (wxCoord)((double)(x) * m_scaleX + 0.5);
	  else
	    return (wxCoord)((double)(x) * m_scaleX - 0.5);
	}
    wxCoord YLOG2DEV(wxCoord y) const
	{
	  long new_y = y - m_logicalOriginY;
	  if (new_y > 0)
	    return (wxCoord)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY;
	  else
	    return (wxCoord)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY;
	}
    wxCoord YLOG2DEVREL(wxCoord y) const
	{ 
	  if (y > 0)
	    return (wxCoord)((double)(y) * m_scaleY + 0.5);
	  else
	    return (wxCoord)((double)(y) * m_scaleY - 0.5);
	}
  
    RgnHandle MacGetCurrentClipRgn() { return m_macCurrentClipRgn ; }
    static MacSetupBackgroundForCurrentPort(const wxBrush& background ) ;
//

protected:
    virtual void DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
                             int style = wxFLOOD_SURFACE);

    virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;

    virtual void DoDrawPoint(wxCoord x, wxCoord y);
    virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);

    virtual void DoDrawArc(wxCoord x1, wxCoord y1,
                           wxCoord x2, wxCoord y2,
                           wxCoord xc, wxCoord yc);
    
    virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
                                   double sa, double ea);

    virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
    virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
                                        wxCoord width, wxCoord height,
                                        double radius);
    virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);

    virtual void DoCrossHair(wxCoord x, wxCoord y);

    virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
    virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
                              bool useMask = FALSE);

    virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
    virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
                                   double angle);

    virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
                        wxDC *source, wxCoord xsrc, wxCoord ysrc,
                        int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);

    // this is gnarly - we can't even call this function DoSetClippingRegion()
    // because of virtual function hiding
    virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
    virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
                                     wxCoord width, wxCoord height);
    virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
                                     wxCoord *width, wxCoord *height)
    {
        GetClippingBox(x, y, width, height);
    }

    virtual void DoGetSize(int *width, int *height) const;
    virtual void DoGetSizeMM(int* width, int* height) const;

    virtual void DoDrawLines(int n, wxPoint points[],
                             wxCoord xoffset, wxCoord yoffset);
    virtual void DoDrawPolygon(int n, wxPoint points[],
                               wxCoord xoffset, wxCoord yoffset,
                               int fillStyle = wxODDEVEN_RULE);

  protected:
    //begin wxmac
    // Variables used for scaling
    double       m_mm_to_pix_x,m_mm_to_pix_y; 
    // not yet used
    bool         m_needComputeScaleX,m_needComputeScaleY;         
    // If un-scrolled is non-zero or d.o. changes with scrolling.
	// Set using SetInternalDeviceOrigin().
	long         m_internalDeviceOriginX,m_internalDeviceOriginY;  
	 // To be set by external classes such as wxScrolledWindow
	 // using SetDeviceOrigin()
    long         m_externalDeviceOriginX,m_externalDeviceOriginY;  
                                                                    
    // Begin implementation for Mac
    public:
								    
	GrafPtr				m_macPort ;
	GWorldPtr			m_macMask ;

	// in order to preserve the const inheritance of the virtual functions, we have to 
	// use mutable variables starting from CWPro 5

	void					MacInstallFont() const ;
	void					MacInstallPen() const ;
	void					MacInstallBrush() const ;
	
	mutable bool	m_macFontInstalled ;
	mutable bool	m_macPenInstalled ;
	mutable bool	m_macBrushInstalled ;
	
	RgnHandle				m_macBoundaryClipRgn ;
	RgnHandle               m_macCurrentClipRgn ;
	Point					m_macLocalOrigin ;
	void					MacSetupPort( AGAPortHelper* ph ) const ;
};

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