don't deprecate SetItemImage() with 3 parameters; just add a default value for the...

[wxWidgets.git] / include / wx / msw / dc.h

diff --git a/include/wx/msw/dc.h b/include/wx/msw/dc.h
index f2ca533725a8c21aa3f92a3b5e41adb891861343..045299277b26cb1444d9d67e89509d57fa76f360 100644 (file)
--- a/include/wx/msw/dc.h
+++ b/include/wx/msw/dc.h
@@ -12,14 +12,40 @@
 #ifndef _WX_DC_H_
 #define _WX_DC_H_
 
 #ifndef _WX_DC_H_
 #define _WX_DC_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "dc.h"
 #endif
 
     #pragma interface "dc.h"
 #endif
 

-class WXDLLEXPORT wxDC : public wxDCBase
+#include "wx/defs.h"
+
+// ---------------------------------------------------------------------------
+// macros
+// ---------------------------------------------------------------------------
+
+#if wxUSE_DC_CACHEING
+/*
+ * Cached blitting, maintaining a cache
+ * of bitmaps required for transparent blitting
+ * instead of constant creation/deletion
+ */
+
+class wxDCCacheEntry: public wxObject

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxDC)
+public:
+    wxDCCacheEntry(WXHBITMAP hBitmap, int w, int h, int depth);
+    wxDCCacheEntry(WXHDC hDC, int depth);
+    ~wxDCCacheEntry();
+
+    WXHBITMAP   m_bitmap;
+    WXHDC       m_dc;
+    int         m_width;
+    int         m_height;
+    int         m_depth;
+};
+#endif

 
 

+class WXDLLEXPORT wxDC : public wxDCBase
+{

 public:
     wxDC();
     ~wxDC();
 public:
     wxDC();
     ~wxDC();


@@ -40,17 +66,20 @@ public:
     virtual void SetBrush(const wxBrush& brush);
     virtual void SetBackground(const wxBrush& brush);
     virtual void SetBackgroundMode(int mode);
     virtual void SetBrush(const wxBrush& brush);
     virtual void SetBackground(const wxBrush& brush);
     virtual void SetBackgroundMode(int mode);

+#if wxUSE_PALETTE

     virtual void SetPalette(const wxPalette& palette);
     virtual void SetPalette(const wxPalette& palette);

+#endif // wxUSE_PALETTE

 
     virtual void DestroyClippingRegion();
 
 
     virtual void DestroyClippingRegion();
 

-    virtual long GetCharHeight() const;
-    virtual long GetCharWidth() const;
-    virtual void GetTextExtent(const wxString& string,
-                               long *x, long *y,
-                               long *descent = NULL,
-                               long *externalLeading = NULL,
-                               wxFont *theFont = NULL) const;
+    virtual wxCoord GetCharHeight() const;
+    virtual wxCoord GetCharWidth() const;
+    virtual void DoGetTextExtent(const wxString& string,
+                                 wxCoord *x, wxCoord *y,
+                                 wxCoord *descent = NULL,
+                                 wxCoord *externalLeading = NULL,
+                                 wxFont *theFont = NULL) const;
+    virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;

 
     virtual bool CanDrawBitmap() const;
     virtual bool CanGetTextExtent() const;
 
     virtual bool CanDrawBitmap() const;
     virtual bool CanGetTextExtent() const;


@@ -61,8 +90,8 @@ public:
     virtual void SetUserScale(double x, double y);
     virtual void SetSystemScale(double x, double y);
     virtual void SetLogicalScale(double x, double y);
     virtual void SetUserScale(double x, double y);
     virtual void SetSystemScale(double x, double y);
     virtual void SetLogicalScale(double x, double y);

-    virtual void SetLogicalOrigin(long x, long y);
-    virtual void SetDeviceOrigin(long x, long y);
+    virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
+    virtual void SetDeviceOrigin(wxCoord x, wxCoord y);

     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
     virtual void SetLogicalFunction(int function);
 
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
     virtual void SetLogicalFunction(int function);
 


@@ -70,79 +99,130 @@ public:
     // --------------------------
 
     virtual void SetRop(WXHDC cdc);
     // --------------------------
 
     virtual void SetRop(WXHDC cdc);

-    virtual void DoClipping(WXHDC cdc);

     virtual void SelectOldObjects(WXHDC dc);
 
     wxWindow *GetWindow() const { return m_canvas; }
     virtual void SelectOldObjects(WXHDC dc);
 
     wxWindow *GetWindow() const { return m_canvas; }

-    void SetWindow(wxWindow *win) { m_canvas = win; }
+    void SetWindow(wxWindow *win)
+    {
+        m_canvas = win;
+
+#if wxUSE_PALETTE
+        // if we have palettes use the correct one for this window
+        InitializePalette();
+#endif // wxUSE_PALETTE
+    }

 
     WXHDC GetHDC() const { return m_hDC; }
 
     WXHDC GetHDC() const { return m_hDC; }

-    void SetHDC(WXHDC dc, bool bOwnsDC = FALSE)
+    void SetHDC(WXHDC dc, bool bOwnsDC = false)

     {
         m_hDC = dc;
         m_bOwnsDC = bOwnsDC;
     {
         m_hDC = dc;
         m_bOwnsDC = bOwnsDC;

+
+        // we might have a pre existing clipping region, make sure that we
+        // return it if asked -- but avoid calling ::GetClipBox() right now as
+        // it could be unnecessary wasteful
+        m_clipping = true;
+        m_clipX1 =
+        m_clipX2 = 0;

     }
 
     }
 

+    const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
+    wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
+
+    // update the internal clip box variables
+    void UpdateClipBox();
+
+#if wxUSE_DC_CACHEING
+    static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
+    static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
+
+    static void AddToBitmapCache(wxDCCacheEntry* entry);
+    static void AddToDCCache(wxDCCacheEntry* entry);
+    static void ClearCache();
+#endif
+

 protected:
 protected:

-    virtual void DoFloodFill(long x, long y, const wxColour& col,
+    virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,

                              int style = wxFLOOD_SURFACE);
 
                              int style = wxFLOOD_SURFACE);
 

-    virtual bool DoGetPixel(long x, long y, wxColour *col) const;
+    virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;

 
 

-    virtual void DoDrawPoint(long x, long y);
-    virtual void DoDrawLine(long x1, long y1, long x2, long y2);
+    virtual void DoDrawPoint(wxCoord x, wxCoord y);
+    virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);

 
 

-    virtual void DoDrawArc(long x1, long y1,
-                           long x2, long y2,
-                           long xc, long yc);
-    virtual void DoDrawEllipticArc(long x, long y, long w, long h,
+    virtual void DoDrawArc(wxCoord x1, wxCoord y1,
+                           wxCoord x2, wxCoord y2,
+                           wxCoord xc, wxCoord yc);
+    virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
+                                 wxCoord width, wxCoord height);
+    virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,

                                    double sa, double ea);
 
                                    double sa, double ea);
 

-    virtual void DoDrawRectangle(long x, long y, long width, long height);
-    virtual void DoDrawRoundedRectangle(long x, long y,
-                                        long width, long height,
+    virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
+    virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
+                                        wxCoord width, wxCoord height,

                                         double radius);
                                         double radius);

-    virtual void DoDrawEllipse(long x, long y, long width, long height);
+    virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);

 
 

-    virtual void DoCrossHair(long x, long y);
+    virtual void DoCrossHair(wxCoord x, wxCoord y);

 
 

-    virtual void DoDrawIcon(const wxIcon& icon, long x, long y);
-    virtual void DoDrawBitmap(const wxBitmap &bmp, long x, long y,
-                              bool useMask = FALSE);
+    virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
+    virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
+                              bool useMask = false);

 
 

-    virtual void DoDrawText(const wxString& text, long x, long y);
+    virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
+    virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
+                                   double angle);

 
 

-    virtual bool DoBlit(long xdest, long ydest, long width, long height,
-                        wxDC *source, long xsrc, long ysrc,
-                        int rop = wxCOPY, bool useMask = FALSE);
+    virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
+                        wxDC *source, wxCoord xsrc, wxCoord ysrc,
+                        int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);

 
     // this is gnarly - we can't even call this function DoSetClippingRegion()
     // because of virtual function hiding
     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
 
     // this is gnarly - we can't even call this function DoSetClippingRegion()
     // because of virtual function hiding
     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);

-    virtual void DoSetClippingRegion(long x, long y,
-                                     long width, long height);
-    virtual void DoGetClippingRegion(long *x, long *y,
-                                     long *width, long *height)
+    virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
+                                     wxCoord width, wxCoord height);
+    virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
+                                     wxCoord *width, wxCoord *height)

     {
         GetClippingBox(x, y, width, height);
     }
     {
         GetClippingBox(x, y, width, height);
     }

+    virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
+                                  wxCoord *w, wxCoord *h) const;

 
     virtual void DoGetSize(int *width, int *height) const;
     virtual void DoGetSizeMM(int* width, int* height) const;
 
     virtual void DoDrawLines(int n, wxPoint points[],
 
     virtual void DoGetSize(int *width, int *height) const;
     virtual void DoGetSizeMM(int* width, int* height) const;
 
     virtual void DoDrawLines(int n, wxPoint points[],

-                             long xoffset, long yoffset);
+                             wxCoord xoffset, wxCoord yoffset);

     virtual void DoDrawPolygon(int n, wxPoint points[],
     virtual void DoDrawPolygon(int n, wxPoint points[],

-                               long xoffset, long yoffset,
+                               wxCoord xoffset, wxCoord yoffset,

                                int fillStyle = wxODDEVEN_RULE);
                                int fillStyle = wxODDEVEN_RULE);

+    virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
+                                   wxCoord xoffset, wxCoord yoffset,
+                                   int fillStyle = wxODDEVEN_RULE);
+
+
+#if wxUSE_PALETTE
+    // MSW specific, select a logical palette into the HDC
+    // (tell windows to translate pixel from other palettes to our custom one
+    // and vice versa)
+    // Realize tells it to also reset the system palette to this one.
+    void DoSelectPalette(bool realize = false);
+
+    // Find out what palette our parent window has, then select it into the dc
+    void InitializePalette();
+#endif // wxUSE_PALETTE

 
 

-#if wxUSE_SPLINES
-    virtual void DoDrawSpline(wxList *points);
-#endif // wxUSE_SPLINES
+    // common part of DoDrawText() and DoDrawRotatedText()
+    void DrawAnyText(const wxString& text, wxCoord x, wxCoord y);
+
+    // common part of DoSetClippingRegion() and DoSetClippingRegionAsRegion()
+    void SetClippingHrgn(WXHRGN hrgn);

 
     // MSW-specific member variables
 
     // MSW-specific member variables

-    int               m_windowExtX;
-    int               m_windowExtY;
+    // -----------------------------

 
     // the window associated with this DC (may be NULL)
     wxWindow         *m_canvas;
 
     // the window associated with this DC (may be NULL)
     wxWindow         *m_canvas;


@@ -152,10 +232,8 @@ protected:
     // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
     bool              m_bOwnsDC:1;
 
     // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
     bool              m_bOwnsDC:1;
 

-    // our HDC and its usage count: we only free it when the usage count drops
-    // to 0
+    // our HDC

     WXHDC             m_hDC;
     WXHDC             m_hDC;

-    int               m_hDCCount;

 
     // Store all old GDI objects when do a SelectObject, so we can select them
     // back in (this unselecting user's objects) so we can safely delete the
 
     // Store all old GDI objects when do a SelectObject, so we can select them
     // back in (this unselecting user's objects) so we can safely delete the


@@ -164,70 +242,34 @@ protected:
     WXHPEN            m_oldPen;
     WXHBRUSH          m_oldBrush;
     WXHFONT           m_oldFont;
     WXHPEN            m_oldPen;
     WXHBRUSH          m_oldBrush;
     WXHFONT           m_oldFont;

-    WXHPALETTE        m_oldPalette;
-};
-
-// Logical to device
-// Absolute
-#define XLOG2DEV(x) (x)
-#define YLOG2DEV(y) (y)
-
-// Relative
-#define XLOG2DEVREL(x) (x)
-#define YLOG2DEVREL(y) (y)
-
-// Device to logical
-// Absolute
-#define XDEV2LOG(x) (x)
-
-#define YDEV2LOG(y) (y)
-
-// Relative
-#define XDEV2LOGREL(x) (x)
-#define YDEV2LOGREL(y) (y)
-
-/*
- * Have the same macros as for XView but not for every operation:
- * just for calculating window/viewport extent (a better way of scaling).
- */
-
-// Logical to device
-// Absolute
-#define MS_XLOG2DEV(x) LogicalToDevice(x)

 
 

-#define MS_YLOG2DEV(y) LogicalToDevice(y)
-
-// Relative
-#define MS_XLOG2DEVREL(x) LogicalToDeviceXRel(x)
-#define MS_YLOG2DEVREL(y) LogicalToDeviceYRel(y)
-
-// Device to logical
-// Absolute
-#define MS_XDEV2LOG(x) DeviceToLogicalX(x)
-
-#define MS_YDEV2LOG(y) DeviceToLogicalY(y)
-
-// Relative
-#define MS_XDEV2LOGREL(x) DeviceToLogicalXRel(x)
-#define MS_YDEV2LOGREL(y) DeviceToLogicalYRel(y)
-
-#define MM_POINTS      9
-#define MM_METRIC     10
+#if wxUSE_PALETTE
+    WXHPALETTE        m_oldPalette;
+#endif // wxUSE_PALETTE

 
 

-// Conversion
-#define METRIC_CONVERSION_CONSTANT  0.0393700787
+#if wxUSE_DC_CACHEING
+    static wxList     sm_bitmapCache;
+    static wxList     sm_dcCache;
+#endif

 
 

-// Scaling factors for various unit conversions
-#define mm2inches (METRIC_CONVERSION_CONSTANT)
-#define inches2mm (1/METRIC_CONVERSION_CONSTANT)
+    DECLARE_DYNAMIC_CLASS(wxDC)
+    DECLARE_NO_COPY_CLASS(wxDC)
+};

 
 

-#define mm2twips (METRIC_CONVERSION_CONSTANT*1440)
-#define twips2mm (1/(METRIC_CONVERSION_CONSTANT*1440))
+// ----------------------------------------------------------------------------
+// wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWidgets
+// only/mainly)
+// ----------------------------------------------------------------------------

 
 

-#define mm2pt (METRIC_CONVERSION_CONSTANT*72)
-#define pt2mm (1/(METRIC_CONVERSION_CONSTANT*72))
+class WXDLLEXPORT wxDCTemp : public wxDC
+{
+public:
+    wxDCTemp(WXHDC hdc) { SetHDC(hdc); }
+    virtual ~wxDCTemp() { SetHDC((WXHDC)NULL); }

 
 

-#define     wx_round(a)    (int)((a)+.5)
+private:
+    DECLARE_NO_COPY_CLASS(wxDCTemp)
+};

 
 #endif
     // _WX_DC_H_
 
 #endif
     // _WX_DC_H_