added (and documented) trivial but useful IsSingleLine() and IsMultiLine() text contr...

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

diff --git a/include/wx/dc.h b/include/wx/dc.h
index 667284b04181e5585fac8c3ccf1eac1580636f33..c414a9fdbe80f2d2b5664e4d508816ed668e1b54 100644 (file)
--- a/include/wx/dc.h
+++ b/include/wx/dc.h
@@ -28,7 +28,6 @@
 #include "wx/brush.h"
 #include "wx/pen.h"
 #include "wx/palette.h"
 #include "wx/brush.h"
 #include "wx/pen.h"
 #include "wx/palette.h"

-

 #include "wx/list.h"            // we use wxList in inline functions
 
 class WXDLLEXPORT wxDCBase;
 #include "wx/list.h"            // we use wxList in inline functions
 
 class WXDLLEXPORT wxDCBase;


@@ -38,9 +37,9 @@ class WXDLLEXPORT wxDrawObject
 public:
 
     wxDrawObject()
 public:
 
     wxDrawObject()

-    {
-        ResetBoundingBox();
-    }
+        : m_isBBoxValid(FALSE)
+        , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
+    { }

 
     virtual ~wxDrawObject() { }
 
 
     virtual ~wxDrawObject() { }
 


@@ -104,33 +103,34 @@ class WXDLLEXPORT wxDCBase : public wxObject
 {
 public:
     wxDCBase()
 {
 public:
     wxDCBase()

+        : m_colour(wxColourDisplay())
+        , m_ok(TRUE)
+        , m_clipping(FALSE)
+        , m_isInteractive(0)
+        , m_isBBoxValid(FALSE)
+        , m_logicalOriginX(0), m_logicalOriginY(0)
+        , m_deviceOriginX(0), m_deviceOriginY(0)
+        , m_logicalScaleX(1.0), m_logicalScaleY(1.0)
+        , m_userScaleX(1.0), m_userScaleY(1.0)
+        , m_scaleX(1.0), m_scaleY(1.0)
+        , m_signX(1), m_signY(1)
+        , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
+        , m_clipX1(0), m_clipY1(0), m_clipX2(0), m_clipY2(0)
+        , m_logicalFunction(wxCOPY)
+        , m_backgroundMode(wxTRANSPARENT)
+        , m_mappingMode(wxMM_TEXT)
+        , m_pen()
+        , m_brush()
+        , m_backgroundBrush(*wxTRANSPARENT_BRUSH)
+        , m_textForegroundColour(*wxBLACK)
+        , m_textBackgroundColour(*wxWHITE)
+        , m_font()
+#if wxUSE_PALETTE
+        , m_palette()
+        , m_hasCustomPalette(FALSE)
+#endif // wxUSE_PALETTE

     {
     {

-        m_clipping = FALSE;
-        m_ok = TRUE;
-

         ResetBoundingBox();
         ResetBoundingBox();

-
-        m_signX = m_signY = 1;
-
-        m_logicalOriginX = m_logicalOriginY =
-        m_deviceOriginX = m_deviceOriginY = 0;
-
-        m_logicalScaleX = m_logicalScaleY =
-        m_userScaleX = m_userScaleY =
-        m_scaleX = m_scaleY = 1.0;
-
-        m_logicalFunction = wxCOPY;
-
-        m_backgroundMode = wxTRANSPARENT;
-
-        m_mappingMode = wxMM_TEXT;
-
-        m_backgroundBrush = *wxTRANSPARENT_BRUSH;
-
-        m_textForegroundColour = *wxBLACK;
-        m_textBackgroundColour = *wxWHITE;
-
-        m_colour = wxColourDisplay();

     }
 
     ~wxDCBase() { }
     }
 
     ~wxDCBase() { }


@@ -148,12 +148,12 @@ public:
         CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY());
     }
 
         CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY());
     }
 

-    void FloodFill(wxCoord x, wxCoord y, const wxColour& col,
+    bool FloodFill(wxCoord x, wxCoord y, const wxColour& col,

                    int style = wxFLOOD_SURFACE)
                    int style = wxFLOOD_SURFACE)

-        { DoFloodFill(x, y, col, style); }
-    void FloodFill(const wxPoint& pt, const wxColour& col,
+        { return DoFloodFill(x, y, col, style); }
+    bool FloodFill(const wxPoint& pt, const wxColour& col,

                    int style = wxFLOOD_SURFACE)
                    int style = wxFLOOD_SURFACE)

-        { DoFloodFill(pt.x, pt.y, col, style); }
+        { return DoFloodFill(pt.x, pt.y, col, style); }

 
     bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const
         { return DoGetPixel(x, y, col); }
 
     bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const
         { return DoGetPixel(x, y, col); }


@@ -227,6 +227,9 @@ public:
 
     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius)
         { DoDrawEllipse(x - radius, y - radius, 2*radius, 2*radius); }
 
     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius)
         { DoDrawEllipse(x - radius, y - radius, 2*radius, 2*radius); }

+    void DrawCircle(const wxPoint& pt, wxCoord radius)
+        { DrawCircle(pt.x, pt.y, radius); }
+

     void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
         { DoDrawEllipse(x, y, width, height); }
     void DrawEllipse(const wxPoint& pt, const wxSize& sz)
     void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
         { DoDrawEllipse(x, y, width, height); }
     void DrawEllipse(const wxPoint& pt, const wxSize& sz)


@@ -274,17 +277,17 @@ public:
 
     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
               wxDC *source, wxCoord xsrc, wxCoord ysrc,
 
     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
               wxDC *source, wxCoord xsrc, wxCoord ysrc,

-              int rop = wxCOPY, bool useMask = FALSE)
+              int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1)

     {
         return DoBlit(xdest, ydest, width, height,
     {
         return DoBlit(xdest, ydest, width, height,

-                      source, xsrc, ysrc, rop, useMask);
+                      source, xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask);

     }
     bool Blit(const wxPoint& destPt, const wxSize& sz,
               wxDC *source, const wxPoint& srcPt,
     }
     bool Blit(const wxPoint& destPt, const wxSize& sz,
               wxDC *source, const wxPoint& srcPt,

-              int rop = wxCOPY, bool useMask = FALSE)
+              int rop = wxCOPY, bool useMask = FALSE, const wxPoint& srcPtMask = wxPoint(-1, -1))

     {
         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
     {
         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,

-                      source, srcPt.x, srcPt.y, rop, useMask);
+                      source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);

     }
 
 #if wxUSE_SPLINES
     }
 
 #if wxUSE_SPLINES


@@ -316,7 +319,9 @@ public:
     virtual void SetBrush(const wxBrush& brush) = 0;
     virtual void SetBackground(const wxBrush& brush) = 0;
     virtual void SetBackgroundMode(int mode) = 0;
     virtual void SetBrush(const wxBrush& brush) = 0;
     virtual void SetBackground(const wxBrush& brush) = 0;
     virtual void SetBackgroundMode(int mode) = 0;

+#if wxUSE_PALETTE

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

+#endif // wxUSE_PALETTE

 
     // clipping region
     // ---------------
 
     // clipping region
     // ---------------


@@ -486,6 +491,16 @@ public:
     virtual void SetOptimization(bool WXUNUSED(opt)) { }
     virtual bool GetOptimization() { return FALSE; }
 
     virtual void SetOptimization(bool WXUNUSED(opt)) { }
     virtual bool GetOptimization() { return FALSE; }
 

+    // Some platforms have a DC cache, which should be cleared
+    // at appropriate points such as after a series of DC operations.
+    // Put ClearCache in the wxDC implementation class, since it has to be
+    // static.
+    // static void ClearCache() ;
+#if 0 // wxUSE_DC_CACHEING
+    static void EnableCache(bool cacheing) { sm_cacheing = cacheing; }
+    static bool CacheEnabled() { return sm_cacheing ; }
+#endif
+

     // bounding box
     // ------------
 
     // bounding box
     // ------------
 


@@ -578,17 +593,22 @@ public:
 #endif // !Win16
 
 #if WXWIN_COMPATIBILITY
 #endif // !Win16
 
 #if WXWIN_COMPATIBILITY

+
+#if wxUSE_PALETTE

     virtual void SetColourMap(const wxPalette& palette) { SetPalette(palette); }
     virtual void SetColourMap(const wxPalette& palette) { SetPalette(palette); }

+#endif // wxUSE_PALETTE
+

     void GetTextExtent(const wxString& string, float *x, float *y,
             float *descent = NULL, float *externalLeading = NULL,
             wxFont *theFont = NULL, bool use16bit = FALSE) const ;
     void GetSize(float* width, float* height) const { int w, h; GetSize(& w, & h); *width = w; *height = h; }
     void GetSizeMM(float *width, float *height) const { long w, h; GetSizeMM(& w, & h); *width = (float) w; *height = (float) h; }
     void GetTextExtent(const wxString& string, float *x, float *y,
             float *descent = NULL, float *externalLeading = NULL,
             wxFont *theFont = NULL, bool use16bit = FALSE) const ;
     void GetSize(float* width, float* height) const { int w, h; GetSize(& w, & h); *width = w; *height = h; }
     void GetSizeMM(float *width, float *height) const { long w, h; GetSizeMM(& w, & h); *width = (float) w; *height = (float) h; }

+

 #endif // WXWIN_COMPATIBILITY
 
 protected:
     // the pure virtual functions which should be implemented by wxDC
 #endif // WXWIN_COMPATIBILITY
 
 protected:
     // the pure virtual functions which should be implemented by wxDC

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

                              int style = wxFLOOD_SURFACE) = 0;
 
     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
                              int style = wxFLOOD_SURFACE) = 0;
 
     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;


@@ -624,7 +644,7 @@ protected:
     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
                         wxCoord width, wxCoord height,
                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
                         wxCoord width, wxCoord height,
                         wxDC *source, wxCoord xsrc, wxCoord ysrc,

-                        int rop = wxCOPY, bool useMask = FALSE) = 0;
+                        int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1) = 0;

 
     virtual void DoGetSize(int *width, int *height) const = 0;
     virtual void DoGetSizeMM(int* width, int* height) const = 0;
 
     virtual void DoGetSize(int *width, int *height) const = 0;
     virtual void DoGetSizeMM(int* width, int* height) const = 0;


@@ -688,6 +708,9 @@ protected:
     bool m_clipping:1;
     bool m_isInteractive:1;
     bool m_isBBoxValid:1;
     bool m_clipping:1;
     bool m_isInteractive:1;
     bool m_isBBoxValid:1;

+#if wxUSE_DC_CACHEING
+//    static bool sm_cacheing;
+#endif

 
     // coordinate system variables
 
 
     // coordinate system variables
 


@@ -718,7 +741,11 @@ protected:
     wxColour          m_textForegroundColour;
     wxColour          m_textBackgroundColour;
     wxFont            m_font;
     wxColour          m_textForegroundColour;
     wxColour          m_textBackgroundColour;
     wxFont            m_font;

+
+#if wxUSE_PALETTE

     wxPalette         m_palette;
     wxPalette         m_palette;

+    bool              m_hasCustomPalette;
+#endif // wxUSE_PALETTE

 
 private:
     DECLARE_NO_COPY_CLASS(wxDCBase)
 
 private:
     DECLARE_NO_COPY_CLASS(wxDCBase)


@@ -735,10 +762,10 @@ private:
     #include "wx/motif/dc.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/dc.h"
     #include "wx/motif/dc.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/dc.h"

+#elif defined(__WXX11__)
+    #include "wx/x11/dc.h"

 #elif defined(__WXMGL__)
     #include "wx/mgl/dc.h"
 #elif defined(__WXMGL__)
     #include "wx/mgl/dc.h"

-#elif defined(__WXQT__)
-    #include "wx/qt/dc.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/dc.h"
 #elif defined(__WXPM__)
 #elif defined(__WXMAC__)
     #include "wx/mac/dc.h"
 #elif defined(__WXPM__)


@@ -755,7 +782,7 @@ private:
 class WXDLLEXPORT wxDCTextColourChanger
 {
 public:
 class WXDLLEXPORT wxDCTextColourChanger
 {
 public:

-    wxDCTextColourChanger(wxDC& dc) : m_dc(dc) { }
+    wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }

 
     ~wxDCTextColourChanger()
     {
 
     ~wxDCTextColourChanger()
     {


@@ -776,5 +803,24 @@ private:
     wxColour m_colFgOld;
 };
 
     wxColour m_colFgOld;
 };
 

+// ----------------------------------------------------------------------------
+// another small helper class: sets the clipping region in its ctor and
+// destroys it in the dtor
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxDCClipper
+{
+public:
+    wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc)
+        { dc.SetClippingRegion(r.x, r.y, r.width, r.height); }
+    wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc)
+        { dc.SetClippingRegion(x, y, w, h); }
+
+    ~wxDCClipper() { m_dc.DestroyClippingRegion(); }
+
+private:
+    wxDC& m_dc;
+};
+

 #endif
     // _WX_DC_H_BASE_
 #endif
     // _WX_DC_H_BASE_