Trying to hide evidence of my negative programming skills...

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

diff --git a/include/wx/dc.h b/include/wx/dc.h
index 2c66232f81e32d415c13f4de3fdb8a9acf082323..667284b04181e5585fac8c3ccf1eac1580636f33 100644 (file)
--- a/include/wx/dc.h
+++ b/include/wx/dc.h
@@ -31,6 +31,65 @@
 
 #include "wx/list.h"            // we use wxList in inline functions
 
 
 #include "wx/list.h"            // we use wxList in inline functions
 

+class WXDLLEXPORT wxDCBase;
+
+class WXDLLEXPORT wxDrawObject
+{
+public:
+
+    wxDrawObject()
+    {
+        ResetBoundingBox();
+    }
+
+    virtual ~wxDrawObject() { }
+
+    virtual void Draw(wxDCBase&) const { }
+
+    virtual void CalcBoundingBox(wxCoord x, wxCoord 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.
+
+    wxCoord MinX() const { return m_minX; }
+    wxCoord MaxX() const { return m_maxX; }
+    wxCoord MinY() const { return m_minY; }
+    wxCoord MaxY() const { return m_maxY; }
+
+    //to define the type of object for derived objects
+    virtual int GetType()=0;
+
+protected:
+    //for boundingbox calculation
+    bool m_isBBoxValid:1;
+    //for boundingbox calculation
+    wxCoord m_minX, m_minY, m_maxX, m_maxY;
+};
+

 // ---------------------------------------------------------------------------
 // global variables
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // global variables
 // ---------------------------------------------------------------------------


@@ -43,15 +102,13 @@ WXDLLEXPORT_DATA(extern int) wxPageNumber;
 
 class WXDLLEXPORT wxDCBase : public wxObject
 {
 
 class WXDLLEXPORT wxDCBase : public wxObject
 {

-    DECLARE_ABSTRACT_CLASS(wxDCBase)
-

 public:
     wxDCBase()
     {
         m_clipping = FALSE;
         m_ok = TRUE;
 
 public:
     wxDCBase()
     {
         m_clipping = FALSE;
         m_ok = TRUE;
 

-        m_minX = m_minY = m_maxX = m_maxY = 0;
+        ResetBoundingBox();

 
         m_signX = m_signY = 1;
 
 
         m_signX = m_signY = 1;
 


@@ -62,7 +119,7 @@ public:
         m_userScaleX = m_userScaleY =
         m_scaleX = m_scaleY = 1.0;
 
         m_userScaleX = m_userScaleY =
         m_scaleX = m_scaleY = 1.0;
 

-        m_logicalFunction = -1;
+        m_logicalFunction = wxCOPY;

 
         m_backgroundMode = wxTRANSPARENT;
 
 
         m_backgroundMode = wxTRANSPARENT;
 


@@ -84,6 +141,13 @@ public:
     // graphic primitives
     // ------------------
 
     // graphic primitives
     // ------------------
 

+    virtual void DrawObject(wxDrawObject* drawobject)
+    {
+        drawobject->Draw(*this);
+        CalcBoundingBox(drawobject->MinX(),drawobject->MinY());
+        CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY());
+    }
+

     void FloodFill(wxCoord x, wxCoord y, const wxColour& col,
                    int style = wxFLOOD_SURFACE)
         { DoFloodFill(x, y, col, style); }
     void FloodFill(wxCoord x, wxCoord y, const wxColour& col,
                    int style = wxFLOOD_SURFACE)
         { DoFloodFill(x, y, col, style); }


@@ -112,6 +176,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 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); }
     void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
                          double sa, double ea)
         { DoDrawEllipticArc(x, y, w, h, sa, ea); }


@@ -181,6 +251,27 @@ public:
     void DrawText(const wxString& text, const wxPoint& pt)
         { DoDrawText(text, pt.x, pt.y); }
 
     void DrawText(const wxString& text, const wxPoint& pt)
         { DoDrawText(text, pt.x, pt.y); }
 

+    void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle)
+        { DoDrawRotatedText(text, x, y, angle); }
+    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)
     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
               wxDC *source, wxCoord xsrc, wxCoord ysrc,
               int rop = wxCOPY, bool useMask = FALSE)


@@ -244,14 +335,20 @@ public:
     void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const
         { DoGetClippingBox(x, y, w, h); }
     void GetClippingBox(wxRect& rect) const
     void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const
         { DoGetClippingBox(x, y, w, h); }
     void GetClippingBox(wxRect& rect) const

-        { DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height); }
+        {
+          // Necessary to use intermediate variables for 16-bit compilation
+          wxCoord x, y, w, h;
+          DoGetClippingBox(&x, &y, &w, &h);
+          rect.x = x; rect.y = y; rect.width = w; rect.height = h;
+        }

 
     // text extent
     // -----------
 
     virtual wxCoord GetCharHeight() const = 0;
     virtual wxCoord GetCharWidth() const = 0;
 
     // text extent
     // -----------
 
     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,
     void GetTextExtent(const wxString& string,
                        wxCoord *x, wxCoord *y,
                        wxCoord *descent = NULL,


@@ -259,6 +356,13 @@ public:
                        wxFont *theFont = NULL) const
         { DoGetTextExtent(string, x, y, descent, externalLeading, theFont); }
 
                        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
     // -------------------
 
     // size and resolution
     // -------------------
 


@@ -316,6 +420,7 @@ public:
     // ---------
 
         // const...
     // ---------
 
         // 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; }
     const wxBrush&  GetBackground() const { return m_backgroundBrush; }
     const wxBrush&  GetBrush() const { return m_brush; }
     const wxFont&   GetFont() const { return m_font; }


@@ -386,10 +491,29 @@ public:
 
     virtual void CalcBoundingBox(wxCoord x, wxCoord y)
     {
 
     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.
     }
 
     // Get the final bounding box of the PostScript or Metafile picture.


@@ -443,13 +567,13 @@ public:
             *y = y2;
     }
     void GetClippingBox(long *x, long *y, long *w, long *h) const
             *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
 
     }
 #endif // !Win16
 


@@ -475,6 +599,8 @@ protected:
     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
                            wxCoord x2, wxCoord y2,
                            wxCoord xc, wxCoord yc) = 0;
     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;
 
     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
                                    double sa, double ea) = 0;
 


@@ -492,6 +618,8 @@ protected:
                               bool useMask = FALSE) = 0;
 
     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
                               bool useMask = FALSE) = 0;
 
     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;

+    virtual void DoDrawRotatedText(const wxString& text,
+                                   wxCoord x, wxCoord y, double angle) = 0;

 
     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
                         wxCoord width, wxCoord height,
 
     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
                         wxCoord width, wxCoord height,


@@ -550,7 +678,7 @@ protected:
                                  wxFont *theFont = NULL) const = 0;
 
 #if wxUSE_SPLINES
                                  wxFont *theFont = NULL) const = 0;
 
 #if wxUSE_SPLINES

-    virtual void DoDrawSpline(wxList *points) = 0;
+    virtual void DoDrawSpline(wxList *points);

 #endif
 
 protected:
 #endif
 
 protected:


@@ -559,6 +687,7 @@ protected:
     bool m_ok:1;
     bool m_clipping:1;
     bool m_isInteractive:1;
     bool m_ok:1;
     bool m_clipping:1;
     bool m_isInteractive:1;

+    bool m_isBBoxValid:1;

 
     // coordinate system variables
 
 
     // coordinate system variables
 


@@ -592,7 +721,8 @@ protected:
     wxPalette         m_palette;
 
 private:
     wxPalette         m_palette;
 
 private:

-    DECLARE_NO_COPY_CLASS(wxDCBase);
+    DECLARE_NO_COPY_CLASS(wxDCBase)
+    DECLARE_ABSTRACT_CLASS(wxDCBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -605,6 +735,8 @@ 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(__WXMGL__)
+    #include "wx/mgl/dc.h"

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


@@ -615,5 +747,34 @@ private:
     #include "wx/stubs/dc.h"
 #endif
 
     #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) { }
+
+    ~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;
+};
+

 #endif
     // _WX_DC_H_BASE_
 #endif
     // _WX_DC_H_BASE_