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

/////////////////////////////////////////////////////////////////////////////
// Name:        dc.h
// Purpose:     wxDC class
// Author:      Stefan Csomor
// Modified by:
// Created:     1998-01-01
// RCS-ID:      $Id$
// Copyright:   (c) Stefan Csomor
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_DC_H_
#define _WX_DC_H_

#include "wx/pen.h"
#include "wx/brush.h"
#include "wx/icon.h"
#include "wx/font.h"
#include "wx/gdicmn.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
//-----------------------------------------------------------------------------

class wxMacPortStateHelper ;
//-----------------------------------------------------------------------------
// wxDC
//-----------------------------------------------------------------------------

class WXDLLEXPORT wxDC: public wxDCBase
{
    DECLARE_DYNAMIC_CLASS(wxDC)
    DECLARE_NO_COPY_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 DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) 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) ;

    virtual void ComputeScaleAndOrigin();

  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);
    }
    wxCoord XLOG2DEVMAC(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 + m_macLocalOrigin.x ;
      else
        return (wxCoord)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX + m_macLocalOrigin.x ;
    }
    wxCoord YLOG2DEVMAC(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 + m_macLocalOrigin.y ;
      else
        return (wxCoord)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY + m_macLocalOrigin.y ;
    }

    WXHRGN MacGetCurrentClipRgn() { return m_macCurrentClipRgn ; }
    static void MacSetupBackgroundForCurrentPort(const wxBrush& background ) ;
//

protected:
    virtual bool 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 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:

    WXHDC                m_macPort ;
    WXHBITMAP            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 ;

    WXHRGN                    m_macBoundaryClipRgn ;
    WXHRGN                  m_macCurrentClipRgn ;
    wxPoint                    m_macLocalOrigin ;
    void                    MacSetupPort( wxMacPortStateHelper* ph ) const ;
    void                    MacCleanupPort( wxMacPortStateHelper* ph ) const ;
    mutable void*                   m_macATSUIStyle ;
    mutable wxMacPortStateHelper*   m_macCurrentPortStateHelper ;
    mutable bool                    m_macFormerAliasState ;
    mutable short                   m_macFormerAliasSize ;
    mutable bool                    m_macAliasWasEnabled ;
    mutable void*                   m_macForegroundPixMap ;
    mutable void*                   m_macBackgroundPixMap ;
};

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