]> git.saurik.com Git - wxWidgets.git/blob - include/wx/palmos/dc.h
Add RunScript and implement on all backends. Document and add a very simple unit...
[wxWidgets.git] / include / wx / palmos / dc.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/palmos/dc.h
3 // Purpose: wxDC class
4 // Author: William Osborne - minimal working wxPalmOS port
5 // Modified by:
6 // Created: 10/13/04
7 // RCS-ID: $Id$
8 // Copyright: (c) William Osborne
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_PALM_DC_H_
13 #define _WX_PALM_DC_H_
14
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);
34 virtual ~wxDCCacheEntry();
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 // this is an ABC: use one of the derived classes to create a DC associated
45 // with a window, screen, printer and so on
46 class WXDLLIMPEXP_CORE wxPalmDCImpl: public wxDCImpl
47 {
48 public:
49 wxPalmDCImpl(wxDC *owner, WXHDC hDC);
50 virtual ~wxPalmDCImpl();
51
52 // implement base class pure virtuals
53 // ----------------------------------
54
55 virtual void Clear();
56
57 virtual bool StartDoc(const wxString& message);
58 virtual void EndDoc();
59
60 virtual void StartPage();
61 virtual void EndPage();
62
63 virtual void SetFont(const wxFont& font);
64 virtual void SetPen(const wxPen& pen);
65 virtual void SetBrush(const wxBrush& brush);
66 virtual void SetBackground(const wxBrush& brush);
67 virtual void SetBackgroundMode(int mode);
68 #if wxUSE_PALETTE
69 virtual void SetPalette(const wxPalette& palette);
70 #endif // wxUSE_PALETTE
71
72 virtual void DestroyClippingRegion();
73
74 virtual wxCoord GetCharHeight() const;
75 virtual wxCoord GetCharWidth() const;
76
77 virtual bool CanDrawBitmap() const;
78 virtual bool CanGetTextExtent() const;
79 virtual int GetDepth() const;
80 virtual wxSize GetPPI() const;
81
82
83 virtual void SetMapMode(wxMappingMode mode);
84 virtual void SetUserScale(double x, double y);
85 virtual void SetLogicalScale(double x, double y);
86 virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
87 virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
88 virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
89
90 virtual void SetLogicalFunction(wxRasterOperationMode function);
91
92 // implementation from now on
93 // --------------------------
94
95 virtual void SetRop(WXHDC cdc);
96 virtual void SelectOldObjects(WXHDC dc);
97
98 void SetWindow(wxWindow *win)
99 {
100 m_window = win;
101
102 #if wxUSE_PALETTE
103 // if we have palettes use the correct one for this window
104 InitializePalette();
105 #endif // wxUSE_PALETTE
106 }
107
108 WXHDC GetHDC() const { return m_hDC; }
109 void SetHDC(WXHDC dc, bool bOwnsDC = false)
110 {
111 m_hDC = dc;
112 m_bOwnsDC = bOwnsDC;
113
114 // we might have a pre existing clipping region, make sure that we
115 // return it if asked -- but avoid calling ::GetClipBox() right now as
116 // it could be unnecessary wasteful
117 m_clipping = true;
118 m_clipX1 =
119 m_clipX2 = 0;
120 }
121
122 const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
123 wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
124
125 // update the internal clip box variables
126 void UpdateClipBox();
127
128 #if wxUSE_DC_CACHEING
129 static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
130 static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
131
132 static void AddToBitmapCache(wxDCCacheEntry* entry);
133 static void AddToDCCache(wxDCCacheEntry* entry);
134 static void ClearCache();
135 #endif
136
137 // RTL related functions
138 // ---------------------
139
140 // get or change the layout direction (LTR or RTL) for this dc,
141 // wxLayout_Default is returned if layout direction is not supported
142 virtual wxLayoutDirection GetLayoutDirection() const;
143 virtual void SetLayoutDirection(wxLayoutDirection dir);
144
145 protected:
146 void Init()
147 {
148 m_bOwnsDC = false;
149 m_hDC = NULL;
150
151 m_oldBitmap = NULL;
152 m_oldPen = NULL;
153 m_oldBrush = NULL;
154 m_oldFont = NULL;
155
156 #if wxUSE_PALETTE
157 m_oldPalette = NULL;
158 #endif // wxUSE_PALETTE
159 }
160
161 // create an uninitialized DC: this should be only used by the derived
162 // classes
163 wxPalmDCImpl( wxDC *owner ) : wxDCImpl( owner ) { Init(); }
164
165 void RealizeScaleAndOrigin();
166
167 public:
168 virtual void DoGetTextExtent(const wxString& string,
169 wxCoord *x, wxCoord *y,
170 wxCoord *descent = NULL,
171 wxCoord *externalLeading = NULL,
172 const wxFont *theFont = NULL) const;
173 virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
174
175 virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
176 wxFloodFillStyle style = wxFLOOD_SURFACE);
177
178 virtual void DoGradientFillLinear(const wxRect& rect,
179 const wxColour& initialColour,
180 const wxColour& destColour,
181 wxDirection nDirection = wxEAST);
182
183 virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
184
185 virtual void DoDrawPoint(wxCoord x, wxCoord y);
186 virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
187
188 virtual void DoDrawArc(wxCoord x1, wxCoord y1,
189 wxCoord x2, wxCoord y2,
190 wxCoord xc, wxCoord yc);
191 virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
192 wxCoord width, wxCoord height);
193 virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
194 double sa, double ea);
195
196 virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
197 virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
198 wxCoord width, wxCoord height,
199 double radius);
200 virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
201
202 #if wxUSE_SPLINES
203 virtual void DoDrawSpline(const wxPointList *points);
204 #endif
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,
218 wxRasterOperationMode rop = wxCOPY, bool useMask = false,
219 wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
220
221 virtual bool DoStretchBlit(wxCoord xdest, wxCoord ydest,
222 wxCoord dstWidth, wxCoord dstHeight,
223 wxDC *source,
224 wxCoord xsrc, wxCoord ysrc,
225 wxCoord srcWidth, wxCoord srcHeight,
226 wxRasterOperationMode rop = wxCOPY, bool useMask = false,
227 wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
228
229 virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
230 wxCoord width, wxCoord height);
231 virtual void DoSetDeviceClippingRegion(const wxRegion& region);
232 virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
233 wxCoord *w, wxCoord *h) const;
234
235 virtual void DoGetSizeMM(int* width, int* height) const;
236
237 virtual void DoDrawLines(int n, wxPoint points[],
238 wxCoord xoffset, wxCoord yoffset);
239 virtual void DoDrawPolygon(int n, wxPoint points[],
240 wxCoord xoffset, wxCoord yoffset,
241 wxPolygonFillMode fillStyle = wxODDEVEN_RULE);
242 virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
243 wxCoord xoffset, wxCoord yoffset,
244 wxPolygonFillMode fillStyle = wxODDEVEN_RULE);
245 virtual wxBitmap DoGetAsBitmap(const wxRect *subrect) const
246 {
247 return subrect == NULL ? GetSelectedBitmap()
248 : GetSelectedBitmap().GetSubBitmap(*subrect);
249 }
250
251
252 #if wxUSE_PALETTE
253 // MSW specific, select a logical palette into the HDC
254 // (tell windows to translate pixel from other palettes to our custom one
255 // and vice versa)
256 // Realize tells it to also reset the system palette to this one.
257 void DoSelectPalette(bool realize = false);
258
259 // Find out what palette our parent window has, then select it into the dc
260 void InitializePalette();
261 #endif // wxUSE_PALETTE
262
263 protected:
264 // common part of DoDrawText() and DoDrawRotatedText()
265 void DrawAnyText(const wxString& text, wxCoord x, wxCoord y);
266
267 // implementation of DoGetSize() for wxScreen/PrinterDC: this simply
268 // returns the size of the entire device this DC is associated with
269 //
270 // notice that we intentionally put it in a separate function instead of
271 // DoGetSize() itself because we want it to remain pure virtual both
272 // because each derived class should take care to define it as needed (this
273 // implementation is not at all always appropriate) and because we want
274 // wxDC to be an ABC to prevent it from being created directly
275 void GetDeviceSize(int *width, int *height) const;
276
277
278 // MSW-specific member variables
279 // -----------------------------
280
281 // the window associated with this DC (may be NULL)
282 wxWindow *m_canvas;
283
284 wxBitmap m_selectedBitmap;
285
286 // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
287 bool m_bOwnsDC:1;
288
289 // our HDC
290 WXHDC m_hDC;
291
292 // Store all old GDI objects when do a SelectObject, so we can select them
293 // back in (this unselecting user's objects) so we can safely delete the
294 // DC.
295 WXHBITMAP m_oldBitmap;
296 WXHPEN m_oldPen;
297 WXHBRUSH m_oldBrush;
298 WXHFONT m_oldFont;
299
300 #if wxUSE_PALETTE
301 WXHPALETTE m_oldPalette;
302 #endif // wxUSE_PALETTE
303
304 #if wxUSE_DC_CACHEING
305 static wxObjectList sm_bitmapCache;
306 static wxObjectList sm_dcCache;
307 #endif
308
309 DECLARE_CLASS(wxPalmDCImpl)
310 wxDECLARE_NO_COPY_CLASS(wxPalmDCImpl);
311 };
312
313 // ----------------------------------------------------------------------------
314 // wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWidgets
315 // only/mainly)
316 // ----------------------------------------------------------------------------
317
318 class WXDLLIMPEXP_CORE wxDCTempImpl : public wxPalmDCImpl
319 {
320 public:
321 // construct a temporary DC with the specified HDC and size (it should be
322 // specified whenever we know it for this HDC)
323 wxDCTempImpl(wxDC *owner, WXHDC hdc, const wxSize& size )
324 : wxPalmDCImpl( owner, hdc ),
325 m_size(size)
326 {
327 }
328
329 virtual ~wxDCTempImpl()
330 {
331 // prevent base class dtor from freeing it
332 SetHDC((WXHDC)NULL);
333 }
334
335 virtual void DoGetSize(int *w, int *h) const
336 {
337 wxASSERT_MSG( m_size.IsFullySpecified(),
338 wxT("size of this DC hadn't been set and is unknown") );
339
340 if ( w )
341 *w = m_size.x;
342 if ( h )
343 *h = m_size.y;
344 }
345
346 private:
347 // size of this DC must be explicitly set by SetSize() as we have no way to
348 // find it ourselves
349 const wxSize m_size;
350
351 wxDECLARE_NO_COPY_CLASS(wxDCTempImpl);
352 };
353
354 class WXDLLIMPEXP_CORE wxDCTemp : public wxDC
355 {
356 public:
357 wxDCTemp(WXHDC hdc, const wxSize& size = wxDefaultSize)
358 : wxDC(new wxDCTempImpl(this, hdc, size))
359 {
360 }
361 };
362
363 #endif
364 // _WX_PALM_DC_H_