]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dc.h
Store a pointer to the wxWindow in the wxWindowDC class
[wxWidgets.git] / include / wx / dc.h
index b49bbaacca9bc47ac14f6cca600af7529d6034b0..39d9c5563b6b758140a496054fc3abbcb1fa10e1 100644 (file)
@@ -12,7 +12,7 @@
 #ifndef _WX_DC_H_BASE_
 #define _WX_DC_H_BASE_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
     #pragma interface "dcbase.h"
 #endif
 
 #include "wx/brush.h"
 #include "wx/pen.h"
 #include "wx/palette.h"
-
 #include "wx/list.h"            // we use wxList in inline functions
 
-// ---------------------------------------------------------------------------
-// global variables
-// ---------------------------------------------------------------------------
+class WXDLLEXPORT wxDC;
+class WXDLLEXPORT wxDCBase;
 
-WXDLLEXPORT_DATA(extern int) wxPageNumber;
+class WXDLLEXPORT wxDrawObject
+{
+public:
 
-// ---------------------------------------------------------------------------
-// wxDC is the device context - object on which any drawing is done
-// ---------------------------------------------------------------------------
+    wxDrawObject()
+        : m_isBBoxValid(FALSE)
+        , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
+    { }
 
-class WXDLLEXPORT wxDCBase : public wxObject
-{
-    DECLARE_ABSTRACT_CLASS(wxDCBase)
+    virtual ~wxDrawObject() { }
 
-public:
-    wxDCBase()
+    virtual void Draw(wxDCBase&) const { }
+
+    virtual void CalcBoundingBox(wxCoord x, wxCoord y)
     {
-        m_clipping = FALSE;
-        m_ok = TRUE;
+      if ( m_isBBoxValid )
+      {
+         if ( x < m_minX ) m_minX = x;
+         if ( y < m_minY ) m_minY = y;
+         if ( x > m_maxX ) m_maxX = x;
+         if ( y > m_maxY ) m_maxY = y;
+      }
+      else
+      {
+         m_isBBoxValid = TRUE;
+
+         m_minX = x;
+         m_minY = y;
+         m_maxX = x;
+         m_maxY = y;
+      }
+    }
 
-        m_minX = m_minY = m_maxX = m_maxY = 0;
+    void ResetBoundingBox()
+    {
+        m_isBBoxValid = FALSE;
 
-        m_signX = m_signY = 1;
+        m_minX = m_maxX = m_minY = m_maxY = 0;
+    }
 
-        m_logicalOriginX = m_logicalOriginY =
-        m_deviceOriginX = m_deviceOriginY = 0;
+    // Get the final bounding box of the PostScript or Metafile picture.
 
-        m_logicalScaleX = m_logicalScaleY =
-        m_userScaleX = m_userScaleY =
-        m_scaleX = m_scaleY = 1.0;
+    wxCoord MinX() const { return m_minX; }
+    wxCoord MaxX() const { return m_maxX; }
+    wxCoord MinY() const { return m_minY; }
+    wxCoord MaxY() const { return m_maxY; }
 
-        m_logicalFunction = -1;
+    //to define the type of object for derived objects
+    virtual int GetType()=0;
 
-        m_backgroundMode = wxTRANSPARENT;
+protected:
+    //for boundingbox calculation
+    bool m_isBBoxValid:1;
+    //for boundingbox calculation
+    wxCoord m_minX, m_minY, m_maxX, m_maxY;
+};
 
-        m_mappingMode = wxMM_TEXT;
+// ---------------------------------------------------------------------------
+// global variables
+// ---------------------------------------------------------------------------
 
-        m_backgroundBrush = *wxTRANSPARENT_BRUSH;
+WXDLLEXPORT_DATA(extern int) wxPageNumber;
 
-        m_textForegroundColour = *wxBLACK;
-        m_textBackgroundColour = *wxWHITE;
+// ---------------------------------------------------------------------------
+// wxDC is the device context - object on which any drawing is done
+// ---------------------------------------------------------------------------
 
-        m_colour = wxColourDisplay();
+class WXDLLEXPORT wxDCBase : public wxObject
+{
+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
+    {
+        ResetBoundingBox();
     }
 
     ~wxDCBase() { }
@@ -84,12 +142,19 @@ public:
     // graphic primitives
     // ------------------
 
-    void FloodFill(wxCoord x, wxCoord y, const wxColour& col,
+    virtual void DrawObject(wxDrawObject* drawobject)
+    {
+        drawobject->Draw(*this);
+        CalcBoundingBox(drawobject->MinX(),drawobject->MinY());
+        CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY());
+    }
+
+    bool FloodFill(wxCoord x, wxCoord y, const wxColour& col,
                    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)
-        { 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); }
@@ -112,6 +177,12 @@ public:
     void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre)
         { DoDrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y); }
 
+    void DrawCheckMark(wxCoord x, wxCoord y,
+                       wxCoord width, wxCoord height)
+        { DoDrawCheckMark(x, y, width, height); }
+    void DrawCheckMark(const wxRect& rect)
+        { DoDrawCheckMark(rect.x, rect.y, rect.width, rect.height); }
+
     void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
                          double sa, double ea)
         { DoDrawEllipticArc(x, y, w, h, sa, ea); }
@@ -157,6 +228,9 @@ public:
 
     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)
@@ -186,19 +260,35 @@ public:
     void DrawRotatedText(const wxString& text, const wxPoint& pt, double angle)
         { DoDrawRotatedText(text, pt.x, pt.y, angle); }
 
+    // this version puts both optional bitmap and the text into the given
+    // rectangle and aligns is as specified by alignment parameter; it also
+    // will emphasize the character with the given index if it is != -1 and
+    // return the bounding rectangle if required
+    virtual void DrawLabel(const wxString& text,
+                           const wxBitmap& image,
+                           const wxRect& rect,
+                           int alignment = wxALIGN_LEFT | wxALIGN_TOP,
+                           int indexAccel = -1,
+                           wxRect *rectBounding = NULL);
+
+    void DrawLabel(const wxString& text, const wxRect& rect,
+                   int alignment = wxALIGN_LEFT | wxALIGN_TOP,
+                   int indexAccel = -1)
+        { DrawLabel(text, wxNullBitmap, rect, alignment, indexAccel); }
+
     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,
-                      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,
-              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,
-                      source, srcPt.x, srcPt.y, rop, useMask);
+                      source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);
     }
 
 #if wxUSE_SPLINES
@@ -230,7 +320,9 @@ public:
     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;
+#endif // wxUSE_PALETTE
 
     // clipping region
     // ---------------
@@ -250,10 +342,15 @@ public:
         { DoGetClippingBox(x, y, w, h); }
     void GetClippingBox(wxRect& rect) const
         {
+#if 1
+          DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height);
+#else
           // Necessary to use intermediate variables for 16-bit compilation
+          // REMOVE ME if the above is OK for all current platforms
           wxCoord x, y, w, h;
           DoGetClippingBox(&x, &y, &w, &h);
           rect.x = x; rect.y = y; rect.width = w; rect.height = h;
+#endif
         }
 
     // text extent
@@ -261,7 +358,8 @@ public:
 
     virtual wxCoord GetCharHeight() const = 0;
     virtual wxCoord GetCharWidth() const = 0;
-    
+
+    // only works for single line strings
     void GetTextExtent(const wxString& string,
                        wxCoord *x, wxCoord *y,
                        wxCoord *descent = NULL,
@@ -269,6 +367,13 @@ public:
                        wxFont *theFont = NULL) const
         { DoGetTextExtent(string, x, y, descent, externalLeading, theFont); }
 
+    // works for single as well as multi-line strings
+    virtual void GetMultiLineTextExtent(const wxString& text,
+                                        wxCoord *width,
+                                        wxCoord *height,
+                                        wxCoord *heightLine = NULL,
+                                        wxFont *font = NULL);
+
     // size and resolution
     // -------------------
 
@@ -326,6 +431,7 @@ public:
     // ---------
 
         // const...
+    int GetBackgroundMode() const { return m_backgroundMode; }
     const wxBrush&  GetBackground() const { return m_backgroundBrush; }
     const wxBrush&  GetBrush() const { return m_brush; }
     const wxFont&   GetFont() const { return m_font; }
@@ -396,10 +502,29 @@ public:
 
     virtual void CalcBoundingBox(wxCoord x, wxCoord y)
     {
-        if ( x < m_minX ) m_minX = x;
-        if ( y < m_minY ) m_minY = y;
-        if ( x > m_maxX ) m_maxX = x;
-        if ( y > m_maxY ) m_maxY = y;
+      if ( m_isBBoxValid )
+      {
+         if ( x < m_minX ) m_minX = x;
+         if ( y < m_minY ) m_minY = y;
+         if ( x > m_maxX ) m_maxX = x;
+         if ( y > m_maxY ) m_maxY = y;
+      }
+      else
+      {
+         m_isBBoxValid = TRUE;
+
+         m_minX = x;
+         m_minY = y;
+         m_maxX = x;
+         m_maxY = y;
+      }
+    }
+
+    void ResetBoundingBox()
+    {
+        m_isBBoxValid = FALSE;
+
+        m_minX = m_maxX = m_minY = m_maxY = 0;
     }
 
     // Get the final bounding box of the PostScript or Metafile picture.
@@ -453,28 +578,29 @@ public:
             *y = y2;
     }
     void GetClippingBox(long *x, long *y, long *w, long *h) const
-    { 
-       wxCoord xx,yy,ww,hh;
-       DoGetClippingBox(&xx, &yy, &ww, &hh);
-       if (x) *x = xx;
-       if (y) *y = yy;
-       if (w) *w = ww;
-       if (h) *h = hh;
+    {
+        wxCoord xx,yy,ww,hh;
+        DoGetClippingBox(&xx, &yy, &ww, &hh);
+        if (x) *x = xx;
+        if (y) *y = yy;
+        if (w) *w = ww;
+        if (h) *h = hh;
     }
 #endif // !Win16
 
 #if WXWIN_COMPATIBILITY
-    virtual void SetColourMap(const wxPalette& palette) { SetPalette(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 GetSizeMM(float *width, float *height) const { int 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
-    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;
@@ -485,6 +611,8 @@ protected:
     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
                            wxCoord x2, wxCoord y2,
                            wxCoord xc, wxCoord yc) = 0;
+    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) = 0;
 
@@ -508,7 +636,7 @@ protected:
     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;
@@ -562,7 +690,7 @@ protected:
                                  wxFont *theFont = NULL) const = 0;
 
 #if wxUSE_SPLINES
-    virtual void DoDrawSpline(wxList *points) = 0;
+    virtual void DoDrawSpline(wxList *points);
 #endif
 
 protected:
@@ -571,6 +699,7 @@ protected:
     bool m_ok:1;
     bool m_clipping:1;
     bool m_isInteractive:1;
+    bool m_isBBoxValid:1;
 
     // coordinate system variables
 
@@ -601,10 +730,15 @@ protected:
     wxColour          m_textForegroundColour;
     wxColour          m_textBackgroundColour;
     wxFont            m_font;
+
+#if wxUSE_PALETTE
     wxPalette         m_palette;
+    bool              m_hasCustomPalette;
+#endif // wxUSE_PALETTE
 
 private:
-    DECLARE_NO_COPY_CLASS(wxDCBase);
+    DECLARE_NO_COPY_CLASS(wxDCBase)
+    DECLARE_ABSTRACT_CLASS(wxDCBase)
 };
 
 // ----------------------------------------------------------------------------
@@ -617,15 +751,65 @@ private:
     #include "wx/motif/dc.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/dc.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/dc.h"
+#elif defined(__WXX11__)
+    #include "wx/x11/dc.h"
+#elif defined(__WXMGL__)
+    #include "wx/mgl/dc.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/dc.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/dc.h"
 #elif defined(__WXPM__)
     #include "wx/os2/dc.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/dc.h"
 #endif
 
+// ----------------------------------------------------------------------------
+// helper class: you can use it to temporarily change the DC text colour and
+// restore it automatically when the object goes out of scope
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxDCTextColourChanger
+{
+public:
+    wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
+
+    ~wxDCTextColourChanger()
+    {
+        if ( m_colFgOld.Ok() )
+            m_dc.SetTextForeground(m_colFgOld);
+    }
+
+    void Set(const wxColour& col)
+    {
+        if ( !m_colFgOld.Ok() )
+            m_colFgOld = m_dc.GetTextForeground();
+        m_dc.SetTextForeground(col);
+    }
+
+private:
+    wxDC& m_dc;
+
+    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_