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 #ifdef __GNUG__
  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 // Logical to device
  27 // Absolute
  28 #define XLOG2DEV(x) (x)
  29 #define YLOG2DEV(y) (y)
  30
  31 // Relative
  32 #define XLOG2DEVREL(x) (x)
  33 #define YLOG2DEVREL(y) (y)
  34
  35 // Device to logical
  36 // Absolute
  37 #define XDEV2LOG(x) (x)
  38
  39 #define YDEV2LOG(y) (y)
  40
  41 // Relative
  42 #define XDEV2LOGREL(x) (x)
  43 #define YDEV2LOGREL(y) (y)
  44
  45 /*
  46  * Have the same macros as for XView but not for every operation:
  47  * just for calculating window/viewport extent (a better way of scaling).
  48  */
  49
  50 // Logical to device
  51 // Absolute
  52 #define MS_XLOG2DEV(x) LogicalToDevice(x)
  53
  54 #define MS_YLOG2DEV(y) LogicalToDevice(y)
  55
  56 // Relative
  57 #define MS_XLOG2DEVREL(x) LogicalToDeviceXRel(x)
  58 #define MS_YLOG2DEVREL(y) LogicalToDeviceYRel(y)
  59
  60 // Device to logical
  61 // Absolute
  62 #define MS_XDEV2LOG(x) DeviceToLogicalX(x)
  63
  64 #define MS_YDEV2LOG(y) DeviceToLogicalY(y)
  65
  66 // Relative
  67 #define MS_XDEV2LOGREL(x) DeviceToLogicalXRel(x)
  68 #define MS_YDEV2LOGREL(y) DeviceToLogicalYRel(y)
  69
  70 #define YSCALE(y) (yorigin - (y))
  71
  72 #define     wx_round(a)    (int)((a)+.5)
  73
  74 #if wxUSE_DC_CACHEING
  75 /*
  76  * Cached blitting, maintaining a cache
  77  * of bitmaps required for transparent blitting
  78  * instead of constant creation/deletion
  79  */
  80
  81 class wxDCCacheEntry: public wxObject
  82 {
  83 public:
  84     wxDCCacheEntry(WXHBITMAP hBitmap, int w, int h, int depth);
  85     wxDCCacheEntry(WXHDC hDC, int depth);
  86     ~wxDCCacheEntry();
  87
  88     WXHBITMAP   m_bitmap;
  89     WXHDC       m_dc;
  90     int         m_width;
  91     int         m_height;
  92     int         m_depth;
  93 };
  94 #endif
  95
  96 class WXDLLEXPORT wxDC : public wxDCBase
  97 {
  98 public:
  99     wxDC();
 100     ~wxDC();
 101
 102     // implement base class pure virtuals
 103     // ----------------------------------
 104
 105     virtual void Clear();
 106
 107     virtual bool StartDoc(const wxString& message);
 108     virtual void EndDoc();
 109
 110     virtual void StartPage();
 111     virtual void EndPage();
 112
 113     virtual void SetFont(const wxFont& font);
 114     virtual void SetPen(const wxPen& pen);
 115     virtual void SetBrush(const wxBrush& brush);
 116     virtual void SetBackground(const wxBrush& brush);
 117     virtual void SetBackgroundMode(int mode);
 118 #if wxUSE_PALETTE
 119     virtual void SetPalette(const wxPalette& palette);
 120 #endif // wxUSE_PALETTE
 121
 122     virtual void DestroyClippingRegion();
 123
 124     virtual wxCoord GetCharHeight() const;
 125     virtual wxCoord GetCharWidth() const;
 126     virtual void DoGetTextExtent(const wxString& string,
 127                                  wxCoord *x, wxCoord *y,
 128                                  wxCoord *descent = NULL,
 129                                  wxCoord *externalLeading = NULL,
 130                                  wxFont *theFont = NULL) const;
 131
 132     virtual bool CanDrawBitmap() const;
 133     virtual bool CanGetTextExtent() const;
 134     virtual int GetDepth() const;
 135     virtual wxSize GetPPI() const;
 136
 137     virtual void SetMapMode(int mode);
 138     virtual void SetUserScale(double x, double y);
 139     virtual void SetSystemScale(double x, double y);
 140     virtual void SetLogicalScale(double x, double y);
 141     virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
 142     virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
 143     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 144     virtual void SetLogicalFunction(int function);
 145
 146     // implementation from now on
 147     // --------------------------
 148
 149     virtual void SetRop(WXHDC cdc);
 150     virtual void SelectOldObjects(WXHDC dc);
 151
 152     wxWindow *GetWindow() const { return m_canvas; }
 153     void SetWindow(wxWindow *win) { m_canvas = win; }
 154
 155     WXHDC GetHDC() const { return m_hDC; }
 156     void SetHDC(WXHDC dc, bool bOwnsDC = FALSE)
 157     {
 158         m_hDC = dc;
 159         m_bOwnsDC = bOwnsDC;
 160     }
 161
 162     const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
 163     wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
 164
 165     // update the internal clip box variables
 166     void UpdateClipBox();
 167
 168 #if wxUSE_DC_CACHEING
 169     static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
 170     static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
 171
 172     static void AddToBitmapCache(wxDCCacheEntry* entry);
 173     static void AddToDCCache(wxDCCacheEntry* entry);
 174     static void ClearCache();
 175 #endif
 176
 177 protected:
 178     virtual void DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 179                              int style = wxFLOOD_SURFACE);
 180
 181     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 182
 183     virtual void DoDrawPoint(wxCoord x, wxCoord y);
 184     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 185
 186     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 187                            wxCoord x2, wxCoord y2,
 188                            wxCoord xc, wxCoord yc);
 189     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 190                                  wxCoord width, wxCoord height);
 191     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 192                                    double sa, double ea);
 193
 194     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 195     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 196                                         wxCoord width, wxCoord height,
 197                                         double radius);
 198     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 199
 200     virtual void DoCrossHair(wxCoord x, wxCoord y);
 201
 202     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 203     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 204                               bool useMask = FALSE);
 205
 206     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
 207     virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 208                                    double angle);
 209
 210     virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 211                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 212                         int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 213
 214     // this is gnarly - we can't even call this function DoSetClippingRegion()
 215     // because of virtual function hiding
 216     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
 217     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 218                                      wxCoord width, wxCoord height);
 219     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
 220                                      wxCoord *width, wxCoord *height)
 221     {
 222         GetClippingBox(x, y, width, height);
 223     }
 224
 225     virtual void DoGetSize(int *width, int *height) const;
 226     virtual void DoGetSizeMM(int* width, int* height) const;
 227
 228     virtual void DoDrawLines(int n, wxPoint points[],
 229                              wxCoord xoffset, wxCoord yoffset);
 230     virtual void DoDrawPolygon(int n, wxPoint points[],
 231                                wxCoord xoffset, wxCoord yoffset,
 232                                int fillStyle = wxODDEVEN_RULE);
 233
 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     // MSW-specific member variables
 242     int               m_windowExtX;
 243     int               m_windowExtY;
 244
 245     // the window associated with this DC (may be NULL)
 246     wxWindow         *m_canvas;
 247
 248     wxBitmap          m_selectedBitmap;
 249
 250     // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
 251     bool              m_bOwnsDC:1;
 252
 253     // our HDC
 254     WXHDC             m_hDC;
 255
 256     // Store all old GDI objects when do a SelectObject, so we can select them
 257     // back in (this unselecting user's objects) so we can safely delete the
 258     // DC.
 259     WXHBITMAP         m_oldBitmap;
 260     WXHPEN            m_oldPen;
 261     WXHBRUSH          m_oldBrush;
 262     WXHFONT           m_oldFont;
 263
 264 #if wxUSE_PALETTE
 265     WXHPALETTE        m_oldPalette;
 266 #endif // wxUSE_PALETTE
 267
 268 #if wxUSE_DC_CACHEING
 269     static wxList     sm_bitmapCache;
 270     static wxList     sm_dcCache;
 271 #endif
 272
 273     DECLARE_DYNAMIC_CLASS(wxDC)
 274 };
 275
 276 // ----------------------------------------------------------------------------
 277 // wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWindows
 278 // only/mainly)
 279 // ----------------------------------------------------------------------------
 280
 281 class WXDLLEXPORT wxDCTemp : public wxDC
 282 {
 283 public:
 284     wxDCTemp(WXHDC hdc) { SetHDC(hdc); }
 285     virtual ~wxDCTemp() { SetHDC((WXHDC)NULL); }
 286 };
 287
 288 #endif
 289     // _WX_DC_H_