include/wx/msw/dc.h

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