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

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/cocoa/dc.h
// Purpose:     wxDC
// Author:      David Elliott
// Modified by:
// Created:     2003/04/01
// RCS-ID:      $Id$
// Copyright:   (c) 2003 David Elliott
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef __WX_COCOA_DC_H__
#define __WX_COCOA_DC_H__

DECLARE_WXCOCOA_OBJC_CLASS(NSAffineTransform);

#include "wx/dc.h"

class WXDLLIMPEXP_FWD_CORE wxCocoaDCImpl;
WX_DECLARE_LIST(wxCocoaDCImpl, wxCocoaDCStack);

//=========================================================================
// wxDC
//=========================================================================
class WXDLLIMPEXP_CORE wxCocoaDCImpl: public wxDCImpl
{
    DECLARE_ABSTRACT_CLASS(wxCocoaDCImpl)
    wxDECLARE_NO_COPY_CLASS(wxCocoaDCImpl);
//-------------------------------------------------------------------------
// Initialization
//-------------------------------------------------------------------------
public:
    wxCocoaDCImpl(wxDC *owner);
    virtual ~wxCocoaDCImpl();

//-------------------------------------------------------------------------
// wxCocoa specifics
//-------------------------------------------------------------------------
public:
    static void CocoaInitializeTextSystem();
    static void CocoaShutdownTextSystem();
    static WX_NSTextStorage sm_cocoaNSTextStorage;
    static WX_NSLayoutManager sm_cocoaNSLayoutManager;
    static WX_NSTextContainer sm_cocoaNSTextContainer;
    // Create a simple Wx to Bounds transform (just flip the coordinate system)
    static WX_NSAffineTransform CocoaGetWxToBoundsTransform(bool isFlipped, float height);
protected:
// DC stack
    static wxCocoaDCStack sm_cocoaDCStack;
    virtual bool CocoaLockFocus();
    virtual bool CocoaUnlockFocus();
    bool CocoaUnwindStackAndTakeFocus();
    inline bool CocoaTakeFocus()
    {
        wxCocoaDCStack::compatibility_iterator node = sm_cocoaDCStack.GetFirst();
        if(node && (node->GetData() == this))
            return true;
        return CocoaUnwindStackAndTakeFocus();
    }
    void CocoaUnwindStackAndLoseFocus();
// DC flipping/transformation
    void CocoaApplyTransformations();
    void CocoaUnapplyTransformations();
    WX_NSAffineTransform m_cocoaWxToBoundsTransform;
// Get bounds rect (for Clear())
    // note: we use void * to mean NSRect * so that we can avoid
    // putting NSRect in the headers.
    virtual bool CocoaGetBounds(void *rectData);
// Blitting
    virtual bool CocoaDoBlitOnFocusedDC(wxCoord xdest, wxCoord ydest,
        wxCoord width, wxCoord height, wxCoord xsrc, wxCoord ysrc,
        wxRasterOperationMode logicalFunc, bool useMask, wxCoord xsrcMask, wxCoord ysrcMask);
//-------------------------------------------------------------------------
// Implementation
//-------------------------------------------------------------------------
public:
    // 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) { m_backgroundMode = 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,
                                 const wxFont *theFont = NULL) const;

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

    virtual void SetMapMode(wxMappingMode 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(wxRasterOperationMode function);

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

    virtual void ComputeScaleAndOrigin();
protected:
    virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
                             wxFloodFillStyle 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 DoSetDeviceClippingRegion(const wxRegion& region);
    virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
                                     wxCoord width, wxCoord height);

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

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

#endif // __WX_COCOA_DC_H__
Commit	Line	Data
a24aff65	1	/////////////////////////////////////////////////////////////////////////////
6c342f3f DE	2	// Name: wx/cocoa/dc.h
	3	// Purpose: wxDC
	4	// Author: David Elliott
a24aff65	5	// Modified by:
6c342f3f	6	// Created: 2003/04/01
a24aff65	7	// RCS-ID: $Id$
6c342f3f	8	// Copyright: (c) 2003 David Elliott
b1263dcf	9	// Licence: wxWindows licence
a24aff65 DE	10	/////////////////////////////////////////////////////////////////////////////
a24aff65 DE	11
6c342f3f DE	12	#ifndef __WX_COCOA_DC_H__
6c342f3f DE	13	#define __WX_COCOA_DC_H__
a24aff65	14
4db3c8ac DE	15	DECLARE_WXCOCOA_OBJC_CLASS(NSAffineTransform);
4db3c8ac DE	16
938156b2 DE	17	#include "wx/dc.h"
	18
	19	class WXDLLIMPEXP_FWD_CORE wxCocoaDCImpl;
	20	WX_DECLARE_LIST(wxCocoaDCImpl, wxCocoaDCStack);
fe8f7943	21
6c342f3f DE	22	//=========================================================================
	23	// wxDC
	24	//=========================================================================
938156b2	25	class WXDLLIMPEXP_CORE wxCocoaDCImpl: public wxDCImpl
a24aff65	26	{
938156b2	27	DECLARE_ABSTRACT_CLASS(wxCocoaDCImpl)
c0c133e1	28	wxDECLARE_NO_COPY_CLASS(wxCocoaDCImpl);
fe8f7943 DE	29	//-------------------------------------------------------------------------
	30	// Initialization
	31	//-------------------------------------------------------------------------
6c342f3f	32	public:
938156b2 DE	33	wxCocoaDCImpl(wxDC *owner);
938156b2 DE	34	virtual ~wxCocoaDCImpl();
b1263dcf	35
fe8f7943 DE	36	//-------------------------------------------------------------------------
	37	// wxCocoa specifics
	38	//-------------------------------------------------------------------------
	39	public:
6c342f3f DE	40	static void CocoaInitializeTextSystem();
6c342f3f DE	41	static void CocoaShutdownTextSystem();
6c342f3f DE	42	static WX_NSTextStorage sm_cocoaNSTextStorage;
	43	static WX_NSLayoutManager sm_cocoaNSLayoutManager;
	44	static WX_NSTextContainer sm_cocoaNSTextContainer;
4db3c8ac DE	45	// Create a simple Wx to Bounds transform (just flip the coordinate system)
4db3c8ac DE	46	static WX_NSAffineTransform CocoaGetWxToBoundsTransform(bool isFlipped, float height);
fe8f7943 DE	47	protected:
	48	// DC stack
	49	static wxCocoaDCStack sm_cocoaDCStack;
	50	virtual bool CocoaLockFocus();
	51	virtual bool CocoaUnlockFocus();
	52	bool CocoaUnwindStackAndTakeFocus();
	53	inline bool CocoaTakeFocus()
	54	{
7ce8248b	55	wxCocoaDCStack::compatibility_iterator node = sm_cocoaDCStack.GetFirst();
fe8f7943 DE	56	if(node && (node->GetData() == this))
	57	return true;
	58	return CocoaUnwindStackAndTakeFocus();
	59	}
	60	void CocoaUnwindStackAndLoseFocus();
	61	// DC flipping/transformation
	62	void CocoaApplyTransformations();
3e21fc05	63	void CocoaUnapplyTransformations();
4db3c8ac	64	WX_NSAffineTransform m_cocoaWxToBoundsTransform;
3e21fc05 DE	65	// Get bounds rect (for Clear())
	66	// note: we use void * to mean NSRect * so that we can avoid
	67	// putting NSRect in the headers.
	68	virtual bool CocoaGetBounds(void *rectData);
2c23fe91 DE	69	// Blitting
	70	virtual bool CocoaDoBlitOnFocusedDC(wxCoord xdest, wxCoord ydest,
	71	wxCoord width, wxCoord height, wxCoord xsrc, wxCoord ysrc,
89efaf2b	72	wxRasterOperationMode logicalFunc, bool useMask, wxCoord xsrcMask, wxCoord ysrcMask);
fe8f7943 DE	73	//-------------------------------------------------------------------------
	74	// Implementation
	75	//-------------------------------------------------------------------------
	76	public:
a24aff65 DE	77	// implement base class pure virtuals
	78	// ----------------------------------
	79
	80	virtual void Clear();
	81
b1263dcf	82	virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return true; }
6dd0883d	83	virtual void EndDoc(void) {}
b1263dcf	84
6dd0883d SN	85	virtual void StartPage(void) {}
6dd0883d SN	86	virtual void EndPage(void) {}
a24aff65	87
e7e97a59	88	virtual void SetFont(const wxFont& font);
a24aff65 DE	89	virtual void SetPen(const wxPen& pen);
	90	virtual void SetBrush(const wxBrush& brush);
	91	virtual void SetBackground(const wxBrush& brush);
ed881889	92	virtual void SetBackgroundMode(int mode) { m_backgroundMode = mode; }
a24aff65 DE	93	virtual void SetPalette(const wxPalette& palette);
	94
	95	virtual void DestroyClippingRegion();
	96
	97	virtual wxCoord GetCharHeight() const;
	98	virtual wxCoord GetCharWidth() const;
	99	virtual void DoGetTextExtent(const wxString& string,
	100	wxCoord x, wxCoord y,
	101	wxCoord *descent = NULL,
	102	wxCoord *externalLeading = NULL,
c94f845b	103	const wxFont *theFont = NULL) const;
a24aff65 DE	104
	105	virtual bool CanDrawBitmap() const;
	106	virtual bool CanGetTextExtent() const;
	107	virtual int GetDepth() const;
	108	virtual wxSize GetPPI() const;
	109
89efaf2b	110	virtual void SetMapMode(wxMappingMode mode);
a24aff65 DE	111	virtual void SetUserScale(double x, double y);
	112
	113	virtual void SetLogicalScale(double x, double y);
	114	virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
	115	virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
	116	virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
89efaf2b	117	virtual void SetLogicalFunction(wxRasterOperationMode function);
a24aff65 DE	118
	119	virtual void SetTextForeground(const wxColour& colour) ;
	120	virtual void SetTextBackground(const wxColour& colour) ;
	121
b1263dcf	122	virtual void ComputeScaleAndOrigin();
a24aff65 DE	123	protected:
a24aff65 DE	124	virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
89efaf2b	125	wxFloodFillStyle style = wxFLOOD_SURFACE);
a24aff65 DE	126
	127	virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
	128
	129	virtual void DoDrawPoint(wxCoord x, wxCoord y);
	130	virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
	131
	132	virtual void DoDrawArc(wxCoord x1, wxCoord y1,
	133	wxCoord x2, wxCoord y2,
	134	wxCoord xc, wxCoord yc);
b1263dcf	135
a24aff65 DE	136	virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
	137	double sa, double ea);
	138
	139	virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
	140	virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
	141	wxCoord width, wxCoord height,
	142	double radius);
	143	virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
	144
	145	virtual void DoCrossHair(wxCoord x, wxCoord y);
	146
	147	virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
	148	virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
b1263dcf	149	bool useMask = false);
a24aff65 DE	150
	151	virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
	152	virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
	153	double angle);
	154
	155	virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
	156	wxDC *source, wxCoord xsrc, wxCoord ysrc,
b1263dcf	157	int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
a24aff65 DE	158
	159	// this is gnarly - we can't even call this function DoSetClippingRegion()
	160	// because of virtual function hiding
fdaad94e	161	virtual void DoSetDeviceClippingRegion(const wxRegion& region);
a24aff65 DE	162	virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
a24aff65 DE	163	wxCoord width, wxCoord height);
a24aff65 DE	164
	165	virtual void DoGetSize(int width, int height) const;
	166	virtual void DoGetSizeMM(int* width, int* height) const;
	167
4787c92d	168	virtual void DoDrawLines(int n, const wxPoint points[],
a24aff65	169	wxCoord xoffset, wxCoord yoffset);
4787c92d	170	virtual void DoDrawPolygon(int n, const wxPoint points[],
a24aff65	171	wxCoord xoffset, wxCoord yoffset,
89efaf2b	172	wxPolygonFillMode fillStyle = wxODDEVEN_RULE);
a24aff65 DE	173	};
a24aff65 DE	174
6c342f3f	175	#endif // __WX_COCOA_DC_H__