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

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/palmos/dc.h
// Purpose:     wxDC class
// Author:      William Osborne - minimal working wxPalmOS port
// Modified by:
// Created:     10/13/04
// RCS-ID:      $Id$
// Copyright:   (c) William Osborne
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_DC_H_
#define _WX_DC_H_

#include "wx/defs.h"
#include "wx/dc.h"

// ---------------------------------------------------------------------------
// macros
// ---------------------------------------------------------------------------

#if wxUSE_DC_CACHEING
/*
 * Cached blitting, maintaining a cache
 * of bitmaps required for transparent blitting
 * instead of constant creation/deletion
 */

class wxDCCacheEntry: public wxObject
{
public:
    wxDCCacheEntry(WXHBITMAP hBitmap, int w, int h, int depth);
    wxDCCacheEntry(WXHDC hDC, int depth);
    virtual ~wxDCCacheEntry();

    WXHBITMAP   m_bitmap;
    WXHDC       m_dc;
    int         m_width;
    int         m_height;
    int         m_depth;
};
#endif

class WXDLLEXPORT wxDC : public wxDCBase
{
public:
    wxDC();
    virtual ~wxDC();

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

    virtual void Clear();

    virtual bool StartDoc(const wxString& message);
    virtual void EndDoc();

    virtual void StartPage();
    virtual void EndPage();

    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);
#if wxUSE_PALETTE
    virtual void SetPalette(const wxPalette& palette);
#endif // wxUSE_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 SetSystemScale(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);

    // implementation from now on
    // --------------------------

    virtual void SetRop(WXHDC cdc);
    virtual void SelectOldObjects(WXHDC dc);

    wxWindow *GetWindow() const { return m_canvas; }
    void SetWindow(wxWindow *win)
    {
        m_canvas = win;

#if wxUSE_PALETTE
        // if we have palettes use the correct one for this window
        InitializePalette();
#endif // wxUSE_PALETTE
    }

    WXHDC GetHDC() const { return m_hDC; }
    void SetHDC(WXHDC dc, bool bOwnsDC = FALSE)
    {
        m_hDC = dc;
        m_bOwnsDC = bOwnsDC;

        // we might have a pre existing clipping region, make sure that we
        // return it if asked -- but avoid calling ::GetClipBox() right now as
        // it could be unnecessary wasteful
        m_clipping = true;
        m_clipX1 =
        m_clipX2 = 0;
    }

    const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
    wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }

    // update the internal clip box variables
    void UpdateClipBox();

#if wxUSE_DC_CACHEING
    static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
    static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);

    static void AddToBitmapCache(wxDCCacheEntry* entry);
    static void AddToDCCache(wxDCCacheEntry* entry);
    static void ClearCache();
#endif

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 DoDrawCheckMark(wxCoord x, wxCoord y,
                                 wxCoord width, wxCoord height);
    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 DoGetClippingBox(wxCoord *x, wxCoord *y,
                                  wxCoord *w, wxCoord *h) const;

    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);
    virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
                                   wxCoord xoffset, wxCoord yoffset,
                                   int fillStyle = wxODDEVEN_RULE);


#if wxUSE_PALETTE
    // MSW specific, select a logical palette into the HDC
    // (tell windows to translate pixel from other palettes to our custom one
    // and vice versa)
    // Realize tells it to also reset the system palette to this one.
    void DoSelectPalette(bool realize = FALSE);

    // Find out what palette our parent window has, then select it into the dc
    void InitializePalette();
#endif // wxUSE_PALETTE

    // common part of DoDrawText() and DoDrawRotatedText()
    void DrawAnyText(const wxString& text, wxCoord x, wxCoord y);

    // common part of DoSetClippingRegion() and DoSetClippingRegionAsRegion()
    void SetClippingHrgn(WXHRGN hrgn);

    // MSW-specific member variables
    // -----------------------------

    // the window associated with this DC (may be NULL)
    wxWindow         *m_canvas;

    wxBitmap          m_selectedBitmap;

    // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
    bool              m_bOwnsDC:1;

    // our HDC
    WXHDC             m_hDC;

    // Store all old GDI objects when do a SelectObject, so we can select them
    // back in (this unselecting user's objects) so we can safely delete the
    // DC.
    WXHBITMAP         m_oldBitmap;
    WXHPEN            m_oldPen;
    WXHBRUSH          m_oldBrush;
    WXHFONT           m_oldFont;

#if wxUSE_PALETTE
    WXHPALETTE        m_oldPalette;
#endif // wxUSE_PALETTE

#if wxUSE_DC_CACHEING
    static wxList     sm_bitmapCache;
    static wxList     sm_dcCache;
#endif

    DECLARE_DYNAMIC_CLASS(wxDC)
    DECLARE_NO_COPY_CLASS(wxDC)
};

// ----------------------------------------------------------------------------
// wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWidgets
// only/mainly)
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxDCTemp : public wxDC
{
public:
    wxDCTemp(WXHDC hdc) { SetHDC(hdc); }
    virtual ~wxDCTemp() { SetHDC((WXHDC)NULL); }

private:
    DECLARE_NO_COPY_CLASS(wxDCTemp)
};

#endif
    // _WX_DC_H_
Commit	Line	Data
ffecfa5a	1	/////////////////////////////////////////////////////////////////////////////
e1d63b79	2	// Name: wx/palmos/dc.h
ffecfa5a	3	// Purpose: wxDC class
e1d63b79	4	// Author: William Osborne - minimal working wxPalmOS port
ffecfa5a JS	5	// Modified by:
ffecfa5a JS	6	// Created: 10/13/04
e1d63b79	7	// RCS-ID: $Id$
ffecfa5a JS	8	// Copyright: (c) William Osborne
	9	// Licence: wxWindows licence
	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_DC_H_
	13	#define _WX_DC_H_
	14
ffecfa5a JS	15	#include "wx/defs.h"
	16	#include "wx/dc.h"
	17
	18	// ---------------------------------------------------------------------------
	19	// macros
	20	// ---------------------------------------------------------------------------
	21
	22	#if wxUSE_DC_CACHEING
	23	/*
	24	* Cached blitting, maintaining a cache
	25	* of bitmaps required for transparent blitting
	26	* instead of constant creation/deletion
	27	*/
	28
	29	class wxDCCacheEntry: public wxObject
	30	{
	31	public:
	32	wxDCCacheEntry(WXHBITMAP hBitmap, int w, int h, int depth);
	33	wxDCCacheEntry(WXHDC hDC, int depth);
d3c7fc99	34	virtual ~wxDCCacheEntry();
ffecfa5a JS	35
	36	WXHBITMAP m_bitmap;
	37	WXHDC m_dc;
	38	int m_width;
	39	int m_height;
	40	int m_depth;
	41	};
	42	#endif
	43
	44	class WXDLLEXPORT wxDC : public wxDCBase
	45	{
	46	public:
	47	wxDC();
d3c7fc99	48	virtual ~wxDC();
ffecfa5a JS	49
	50	// implement base class pure virtuals
	51	// ----------------------------------
	52
	53	virtual void Clear();
	54
	55	virtual bool StartDoc(const wxString& message);
	56	virtual void EndDoc();
	57
	58	virtual void StartPage();
	59	virtual void EndPage();
	60
	61	virtual void SetFont(const wxFont& font);
	62	virtual void SetPen(const wxPen& pen);
	63	virtual void SetBrush(const wxBrush& brush);
	64	virtual void SetBackground(const wxBrush& brush);
	65	virtual void SetBackgroundMode(int mode);
	66	#if wxUSE_PALETTE
	67	virtual void SetPalette(const wxPalette& palette);
	68	#endif // wxUSE_PALETTE
	69
	70	virtual void DestroyClippingRegion();
	71
	72	virtual wxCoord GetCharHeight() const;
	73	virtual wxCoord GetCharWidth() const;
	74	virtual void DoGetTextExtent(const wxString& string,
	75	wxCoord x, wxCoord y,
	76	wxCoord *descent = NULL,
	77	wxCoord *externalLeading = NULL,
	78	wxFont *theFont = NULL) const;
	79	virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
	80
	81	virtual bool CanDrawBitmap() const;
	82	virtual bool CanGetTextExtent() const;
	83	virtual int GetDepth() const;
	84	virtual wxSize GetPPI() const;
	85
	86	virtual void SetMapMode(int mode);
	87	virtual void SetUserScale(double x, double y);
	88	virtual void SetSystemScale(double x, double y);
	89	virtual void SetLogicalScale(double x, double y);
	90	virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
	91	virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
	92	virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
	93	virtual void SetLogicalFunction(int function);
	94
	95	// implementation from now on
	96	// --------------------------
	97
	98	virtual void SetRop(WXHDC cdc);
	99	virtual void SelectOldObjects(WXHDC dc);
	100
	101	wxWindow *GetWindow() const { return m_canvas; }
	102	void SetWindow(wxWindow *win)
	103	{
	104	m_canvas = win;
	105
	106	#if wxUSE_PALETTE
	107	// if we have palettes use the correct one for this window
	108	InitializePalette();
	109	#endif // wxUSE_PALETTE
	110	}
	111
	112	WXHDC GetHDC() const { return m_hDC; }
113	void SetHDC(WXHDC dc, bool bOwnsDC = FALSE)
114	{
115	m_hDC = dc;
116	m_bOwnsDC = bOwnsDC;
117
118	// we might have a pre existing clipping region, make sure that we
119	// return it if asked -- but avoid calling ::GetClipBox() right now as
120	// it could be unnecessary wasteful
121	m_clipping = true;
122	m_clipX1 =
123	m_clipX2 = 0;
124	}
125
126	const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
127	wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
128
129	// update the internal clip box variables
130	void UpdateClipBox();
131
132	#if wxUSE_DC_CACHEING
133	static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
134	static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
135
136	static void AddToBitmapCache(wxDCCacheEntry* entry);
137	static void AddToDCCache(wxDCCacheEntry* entry);
138	static void ClearCache();
139	#endif
140
141	protected:
142	virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
143	int style = wxFLOOD_SURFACE);
144
145	virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
146
147	virtual void DoDrawPoint(wxCoord x, wxCoord y);
148	virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
149
150	virtual void DoDrawArc(wxCoord x1, wxCoord y1,
151	wxCoord x2, wxCoord y2,
152	wxCoord xc, wxCoord yc);
153	virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
154	wxCoord width, wxCoord height);
155	virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
156	double sa, double ea);
157
158	virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
159	virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
160	wxCoord width, wxCoord height,
161	double radius);
162	virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
163
164	virtual void DoCrossHair(wxCoord x, wxCoord y);
165
166	virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
167	virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
168	bool useMask = FALSE);
169
170	virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
171	virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
172	double angle);
173
174	virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
175	wxDC *source, wxCoord xsrc, wxCoord ysrc,
176	int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
177
178	// this is gnarly - we can't even call this function DoSetClippingRegion()
179	// because of virtual function hiding
180	virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
181	virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
182	wxCoord width, wxCoord height);
ffecfa5a JS	183	virtual void DoGetClippingBox(wxCoord x, wxCoord y,
	184	wxCoord w, wxCoord h) const;
	185
	186	virtual void DoGetSize(int width, int height) const;
	187	virtual void DoGetSizeMM(int* width, int* height) const;
	188
	189	virtual void DoDrawLines(int n, wxPoint points[],
	190	wxCoord xoffset, wxCoord yoffset);
	191	virtual void DoDrawPolygon(int n, wxPoint points[],
	192	wxCoord xoffset, wxCoord yoffset,
	193	int fillStyle = wxODDEVEN_RULE);
	194	virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
	195	wxCoord xoffset, wxCoord yoffset,
	196	int fillStyle = wxODDEVEN_RULE);
	197
	198
	199	#if wxUSE_PALETTE
	200	// MSW specific, select a logical palette into the HDC
	201	// (tell windows to translate pixel from other palettes to our custom one
	202	// and vice versa)
	203	// Realize tells it to also reset the system palette to this one.
	204	void DoSelectPalette(bool realize = FALSE);
	205
	206	// Find out what palette our parent window has, then select it into the dc
	207	void InitializePalette();
	208	#endif // wxUSE_PALETTE
	209
	210	// common part of DoDrawText() and DoDrawRotatedText()
	211	void DrawAnyText(const wxString& text, wxCoord x, wxCoord y);
	212
	213	// common part of DoSetClippingRegion() and DoSetClippingRegionAsRegion()
	214	void SetClippingHrgn(WXHRGN hrgn);
	215
	216	// MSW-specific member variables
	217	// -----------------------------
	218
	219	// the window associated with this DC (may be NULL)
	220	wxWindow *m_canvas;
	221
	222	wxBitmap m_selectedBitmap;
	223
	224	// TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
	225	bool m_bOwnsDC:1;
	226
	227	// our HDC
	228	WXHDC m_hDC;
	229
	230	// Store all old GDI objects when do a SelectObject, so we can select them
	231	// back in (this unselecting user's objects) so we can safely delete the
	232	// DC.
	233	WXHBITMAP m_oldBitmap;
	234	WXHPEN m_oldPen;
	235	WXHBRUSH m_oldBrush;
	236	WXHFONT m_oldFont;
	237
	238	#if wxUSE_PALETTE
	239	WXHPALETTE m_oldPalette;
	240	#endif // wxUSE_PALETTE
	241
	242	#if wxUSE_DC_CACHEING
	243	static wxList sm_bitmapCache;
	244	static wxList sm_dcCache;
	245	#endif
	246
247	DECLARE_DYNAMIC_CLASS(wxDC)
248	DECLARE_NO_COPY_CLASS(wxDC)
249	};
250
251	// ----------------------------------------------------------------------------
252	// wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWidgets
253	// only/mainly)
254	// ----------------------------------------------------------------------------
255
256	class WXDLLEXPORT wxDCTemp : public wxDC
257	{
258	public:
259	wxDCTemp(WXHDC hdc) { SetHDC(hdc); }
260	virtual ~wxDCTemp() { SetHDC((WXHDC)NULL); }
261
262	private:
263	DECLARE_NO_COPY_CLASS(wxDCTemp)
264	};
265
266	#endif
267	// _WX_DC_H_