include/wx/msw/dc.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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_DC_H_
  13 #define _WX_DC_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "dc.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/dc.h"
  21
  22 // ---------------------------------------------------------------------------
  23 // macros
  24 // ---------------------------------------------------------------------------
  25
  26 #if wxUSE_DC_CACHEING
  27 /*
  28  * Cached blitting, maintaining a cache
  29  * of bitmaps required for transparent blitting
  30  * instead of constant creation/deletion
  31  */
  32
  33 class wxDCCacheEntry: public wxObject
  34 {
  35 public:
  36     wxDCCacheEntry(WXHBITMAP hBitmap, int w, int h, int depth);
  37     wxDCCacheEntry(WXHDC hDC, int depth);
  38     ~wxDCCacheEntry();
  39
  40     WXHBITMAP   m_bitmap;
  41     WXHDC       m_dc;
  42     int         m_width;
  43     int         m_height;
  44     int         m_depth;
  45 };
  46 #endif
  47
  48 class WXDLLEXPORT wxDC : public wxDCBase
  49 {
  50 public:
  51     wxDC();
  52     ~wxDC();
  53
  54     // implement base class pure virtuals
  55     // ----------------------------------
  56
  57     virtual void Clear();
  58
  59     virtual bool StartDoc(const wxString& message);
  60     virtual void EndDoc();
  61
  62     virtual void StartPage();
  63     virtual void EndPage();
  64
  65     virtual void SetFont(const wxFont& font);
  66     virtual void SetPen(const wxPen& pen);
  67     virtual void SetBrush(const wxBrush& brush);
  68     virtual void SetBackground(const wxBrush& brush);
  69     virtual void SetBackgroundMode(int mode);
  70 #if wxUSE_PALETTE
  71     virtual void SetPalette(const wxPalette& palette);
  72 #endif // wxUSE_PALETTE
  73
  74     virtual void DestroyClippingRegion();
  75
  76     virtual wxCoord GetCharHeight() const;
  77     virtual wxCoord GetCharWidth() const;
  78     virtual void DoGetTextExtent(const wxString& string,
  79                                  wxCoord *x, wxCoord *y,
  80                                  wxCoord *descent = NULL,
  81                                  wxCoord *externalLeading = NULL,
  82                                  wxFont *theFont = NULL) const;
  83     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
  84
  85     virtual bool CanDrawBitmap() const;
  86     virtual bool CanGetTextExtent() const;
  87     virtual int GetDepth() const;
  88     virtual wxSize GetPPI() const;
  89
  90     virtual void SetMapMode(int mode);
  91     virtual void SetUserScale(double x, double y);
  92     virtual void SetSystemScale(double x, double y);
  93     virtual void SetLogicalScale(double x, double y);
  94     virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
  95     virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
  96     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
  97     virtual void SetLogicalFunction(int function);
  98
  99     // implementation from now on
 100     // --------------------------
 101
 102     virtual void SetRop(WXHDC cdc);
 103     virtual void SelectOldObjects(WXHDC dc);
 104
 105     wxWindow *GetWindow() const { return m_canvas; }
 106     void SetWindow(wxWindow *win)
 107     {
 108         m_canvas = win;
 109
 110 #if wxUSE_PALETTE
 111         // if we have palettes use the correct one for this window
 112         InitializePalette();
 113 #endif // wxUSE_PALETTE
 114     }
 115
 116     WXHDC GetHDC() const { return m_hDC; }
 117     void SetHDC(WXHDC dc, bool bOwnsDC = FALSE)
 118     {
 119         m_hDC = dc;
 120         m_bOwnsDC = bOwnsDC;
 121     }
 122
 123     const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
 124     wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
 125
 126     // update the internal clip box variables
 127     void UpdateClipBox();
 128
 129 #if wxUSE_DC_CACHEING
 130     static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
 131     static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
 132
 133     static void AddToBitmapCache(wxDCCacheEntry* entry);
 134     static void AddToDCCache(wxDCCacheEntry* entry);
 135     static void ClearCache();
 136 #endif
 137
 138 protected:
 139     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 140                              int style = wxFLOOD_SURFACE);
 141
 142     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 143
 144     virtual void DoDrawPoint(wxCoord x, wxCoord y);
 145     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 146
 147     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 148                            wxCoord x2, wxCoord y2,
 149                            wxCoord xc, wxCoord yc);
 150     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 151                                  wxCoord width, wxCoord height);
 152     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 153                                    double sa, double ea);
 154
 155     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 156     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 157                                         wxCoord width, wxCoord height,
 158                                         double radius);
 159     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 160
 161     virtual void DoCrossHair(wxCoord x, wxCoord y);
 162
 163     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 164     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 165                               bool useMask = FALSE);
 166
 167     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
 168     virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 169                                    double angle);
 170
 171     virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 172                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 173                         int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 174
 175     // this is gnarly - we can't even call this function DoSetClippingRegion()
 176     // because of virtual function hiding
 177     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
 178     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 179                                      wxCoord width, wxCoord height);
 180     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
 181                                      wxCoord *width, wxCoord *height)
 182     {
 183         GetClippingBox(x, y, width, height);
 184     }
 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 wxWindows
 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_