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