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 #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 wxMSWDCImpl: public wxDCImpl
  47 {
  48 public:
  49     wxMSWDCImpl(wxDC *owner, WXHDC hDC);
  50     virtual ~wxMSWDCImpl();
  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 #if wxUSE_DC_TRANSFORM_MATRIX
  91     virtual bool CanUseTransformMatrix() const;
  92     virtual bool SetTransformMatrix(const wxAffineMatrix2D& matrix);
  93     virtual wxAffineMatrix2D GetTransformMatrix() const;
  94     virtual void ResetTransformMatrix();
  95 #endif // wxUSE_DC_TRANSFORM_MATRIX
  96
  97     virtual void SetLogicalFunction(wxRasterOperationMode function);
  98
  99     // implementation from now on
 100     // --------------------------
 101
 102     virtual void SetRop(WXHDC cdc);
 103     virtual void SelectOldObjects(WXHDC dc);
 104
 105     void SetWindow(wxWindow *win)
 106     {
 107         m_window = win;
 108
 109 #if wxUSE_PALETTE
 110         // if we have palettes use the correct one for this window
 111         InitializePalette();
 112 #endif // wxUSE_PALETTE
 113     }
 114
 115     WXHDC GetHDC() const { return m_hDC; }
 116     void SetHDC(WXHDC dc, bool bOwnsDC = false)
 117     {
 118         m_hDC = dc;
 119         m_bOwnsDC = bOwnsDC;
 120
 121         // we might have a pre existing clipping region, make sure that we
 122         // return it if asked -- but avoid calling ::GetClipBox() right now as
 123         // it could be unnecessary wasteful
 124         m_clipping = true;
 125         m_clipX1 =
 126         m_clipX2 = 0;
 127     }
 128
 129     const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
 130     wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
 131
 132     // update the internal clip box variables
 133     void UpdateClipBox();
 134
 135 #if wxUSE_DC_CACHEING
 136     static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
 137     static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
 138
 139     static void AddToBitmapCache(wxDCCacheEntry* entry);
 140     static void AddToDCCache(wxDCCacheEntry* entry);
 141     static void ClearCache();
 142 #endif
 143
 144     // RTL related functions
 145     // ---------------------
 146
 147     // get or change the layout direction (LTR or RTL) for this dc,
 148     // wxLayout_Default is returned if layout direction is not supported
 149     virtual wxLayoutDirection GetLayoutDirection() const;
 150     virtual void SetLayoutDirection(wxLayoutDirection dir);
 151
 152 protected:
 153     void Init()
 154     {
 155         m_bOwnsDC = false;
 156         m_hDC = NULL;
 157
 158         m_oldBitmap = NULL;
 159         m_oldPen = NULL;
 160         m_oldBrush = NULL;
 161         m_oldFont = NULL;
 162
 163 #if wxUSE_PALETTE
 164         m_oldPalette = NULL;
 165 #endif // wxUSE_PALETTE
 166     }
 167
 168     // create an uninitialized DC: this should be only used by the derived
 169     // classes
 170     wxMSWDCImpl( wxDC *owner ) : wxDCImpl( owner ) { Init(); }
 171
 172     void RealizeScaleAndOrigin();
 173
 174 public:
 175     virtual void DoGetFontMetrics(int *height,
 176                                   int *ascent,
 177                                   int *descent,
 178                                   int *internalLeading,
 179                                   int *externalLeading,
 180                                   int *averageWidth) const;
 181     virtual void DoGetTextExtent(const wxString& string,
 182                                  wxCoord *x, wxCoord *y,
 183                                  wxCoord *descent = NULL,
 184                                  wxCoord *externalLeading = NULL,
 185                                  const wxFont *theFont = NULL) const;
 186     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 187
 188     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 189                              wxFloodFillStyle style = wxFLOOD_SURFACE);
 190
 191     virtual void DoGradientFillLinear(const wxRect& rect,
 192                                       const wxColour& initialColour,
 193                                       const wxColour& destColour,
 194                                       wxDirection nDirection = wxEAST);
 195
 196     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 197
 198     virtual void DoDrawPoint(wxCoord x, wxCoord y);
 199     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 200
 201     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 202                            wxCoord x2, wxCoord y2,
 203                            wxCoord xc, wxCoord yc);
 204     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 205                                  wxCoord width, wxCoord height);
 206     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 207                                    double sa, double ea);
 208
 209     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 210     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 211                                         wxCoord width, wxCoord height,
 212                                         double radius);
 213     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 214
 215 #if wxUSE_SPLINES && !defined(__WXWINCE__)
 216     virtual void DoDrawSpline(const wxPointList *points);
 217 #endif
 218
 219     virtual void DoCrossHair(wxCoord x, wxCoord y);
 220
 221     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 222     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 223                               bool useMask = false);
 224
 225     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
 226     virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 227                                    double angle);
 228
 229     virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 230                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 231                         wxRasterOperationMode rop = wxCOPY, bool useMask = false,
 232                         wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
 233
 234     virtual bool DoStretchBlit(wxCoord xdest, wxCoord ydest,
 235                                wxCoord dstWidth, wxCoord dstHeight,
 236                                wxDC *source,
 237                                wxCoord xsrc, wxCoord ysrc,
 238                                wxCoord srcWidth, wxCoord srcHeight,
 239                                wxRasterOperationMode rop = wxCOPY, bool useMask = false,
 240                                wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
 241
 242     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 243                                      wxCoord width, wxCoord height);
 244     virtual void DoSetDeviceClippingRegion(const wxRegion& region);
 245     virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
 246                                   wxCoord *w, wxCoord *h) const;
 247
 248     virtual void DoGetSizeMM(int* width, int* height) const;
 249
 250     virtual void DoDrawLines(int n, wxPoint points[],
 251                              wxCoord xoffset, wxCoord yoffset);
 252     virtual void DoDrawPolygon(int n, wxPoint points[],
 253                                wxCoord xoffset, wxCoord yoffset,
 254                                wxPolygonFillMode fillStyle = wxODDEVEN_RULE);
 255     virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
 256                                    wxCoord xoffset, wxCoord yoffset,
 257                                    wxPolygonFillMode fillStyle = wxODDEVEN_RULE);
 258     virtual wxBitmap DoGetAsBitmap(const wxRect *subrect) const
 259     {
 260         return subrect == NULL ? GetSelectedBitmap()
 261                                : GetSelectedBitmap().GetSubBitmap(*subrect);
 262     }
 263
 264
 265 #if wxUSE_PALETTE
 266     // MSW specific, select a logical palette into the HDC
 267     // (tell windows to translate pixel from other palettes to our custom one
 268     // and vice versa)
 269     // Realize tells it to also reset the system palette to this one.
 270     void DoSelectPalette(bool realize = false);
 271
 272     // Find out what palette our parent window has, then select it into the dc
 273     void InitializePalette();
 274 #endif // wxUSE_PALETTE
 275
 276 protected:
 277     // common part of DoDrawText() and DoDrawRotatedText()
 278     void DrawAnyText(const wxString& text, wxCoord x, wxCoord y);
 279
 280     // common part of DoSetClippingRegion() and DoSetDeviceClippingRegion()
 281     void SetClippingHrgn(WXHRGN hrgn);
 282
 283     // implementation of DoGetSize() for wxScreen/PrinterDC: this simply
 284     // returns the size of the entire device this DC is associated with
 285     //
 286     // notice that we intentionally put it in a separate function instead of
 287     // DoGetSize() itself because we want it to remain pure virtual both
 288     // because each derived class should take care to define it as needed (this
 289     // implementation is not at all always appropriate) and because we want
 290     // wxDC to be an ABC to prevent it from being created directly
 291     void GetDeviceSize(int *width, int *height) const;
 292
 293
 294     // MSW-specific member variables
 295     // -----------------------------
 296
 297     // the window associated with this DC (may be NULL)
 298     wxWindow         *m_canvas;
 299
 300     wxBitmap          m_selectedBitmap;
 301
 302     // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
 303     bool              m_bOwnsDC:1;
 304
 305     // our HDC
 306     WXHDC             m_hDC;
 307
 308     // Store all old GDI objects when do a SelectObject, so we can select them
 309     // back in (this unselecting user's objects) so we can safely delete the
 310     // DC.
 311     WXHBITMAP         m_oldBitmap;
 312     WXHPEN            m_oldPen;
 313     WXHBRUSH          m_oldBrush;
 314     WXHFONT           m_oldFont;
 315
 316 #if wxUSE_PALETTE
 317     WXHPALETTE        m_oldPalette;
 318 #endif // wxUSE_PALETTE
 319
 320 #if wxUSE_DC_CACHEING
 321     static wxObjectList     sm_bitmapCache;
 322     static wxObjectList     sm_dcCache;
 323 #endif
 324
 325     DECLARE_CLASS(wxMSWDCImpl)
 326     wxDECLARE_NO_COPY_CLASS(wxMSWDCImpl);
 327 };
 328
 329 // ----------------------------------------------------------------------------
 330 // wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWidgets
 331 // only/mainly)
 332 // ----------------------------------------------------------------------------
 333
 334 class WXDLLIMPEXP_CORE wxDCTempImpl : public wxMSWDCImpl
 335 {
 336 public:
 337     // construct a temporary DC with the specified HDC and size (it should be
 338     // specified whenever we know it for this HDC)
 339     wxDCTempImpl(wxDC *owner, WXHDC hdc, const wxSize& size )
 340         : wxMSWDCImpl( owner, hdc ),
 341           m_size(size)
 342     {
 343     }
 344
 345     virtual ~wxDCTempImpl()
 346     {
 347         // prevent base class dtor from freeing it
 348         SetHDC((WXHDC)NULL);
 349     }
 350
 351     virtual void DoGetSize(int *w, int *h) const
 352     {
 353         wxASSERT_MSG( m_size.IsFullySpecified(),
 354                       wxT("size of this DC hadn't been set and is unknown") );
 355
 356         if ( w )
 357             *w = m_size.x;
 358         if ( h )
 359             *h = m_size.y;
 360     }
 361
 362 private:
 363     // size of this DC must be explicitly set by SetSize() as we have no way to
 364     // find it ourselves
 365     const wxSize m_size;
 366
 367     wxDECLARE_NO_COPY_CLASS(wxDCTempImpl);
 368 };
 369
 370 class WXDLLIMPEXP_CORE wxDCTemp : public wxDC
 371 {
 372 public:
 373     wxDCTemp(WXHDC hdc, const wxSize& size = wxDefaultSize)
 374         : wxDC(new wxDCTempImpl(this, hdc, size))
 375     {
 376     }
 377 };
 378
 379 #endif // _WX_MSW_DC_H_
 380