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