]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dc.h
Remove the Innotek for OS/2 addition...configure now deals with this correctly on...
[wxWidgets.git] / include / wx / dc.h
index faee757e84bcdc02db8b4986816de2d3e6687d91..777ee3170268bf3276b010b493da56c3b302657c 100644 (file)
@@ -12,7 +12,7 @@
 #ifndef _WX_DC_H_BASE_
 #define _WX_DC_H_BASE_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #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
+#include "wx/dynarray.h"
 
+class WXDLLEXPORT wxDC;
 class WXDLLEXPORT wxDCBase;
 
 class WXDLLEXPORT wxDrawObject
@@ -38,13 +39,13 @@ class WXDLLEXPORT wxDrawObject
 public:
 
     wxDrawObject()
-    {
-        ResetBoundingBox();
-    }
+        : m_isBBoxValid(FALSE)
+        , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
+    }
 
     virtual ~wxDrawObject() { }
 
-    virtual void Draw(wxDCBase& dc) const { }
+    virtual void Draw(wxDCBase&) const { }
 
     virtual void CalcBoundingBox(wxCoord x, wxCoord y)
     {
@@ -104,33 +105,34 @@ 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
     {
-        m_clipping = FALSE;
-        m_ok = TRUE;
-
         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() { }
@@ -148,12 +150,12 @@ public:
         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)
-        { 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); }
@@ -209,6 +211,11 @@ public:
                      wxCoord xoffset = 0, wxCoord yoffset = 0,
                      int fillStyle = wxODDEVEN_RULE);
 
+    void DrawPolyPolygon(int n, int count[], wxPoint points[],
+                         wxCoord xoffset = 0, wxCoord yoffset = 0,
+                         int fillStyle = wxODDEVEN_RULE)
+        { DoDrawPolyPolygon(n, count, points, xoffset, yoffset, fillStyle); }
+
     void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
         { DoDrawRectangle(x, y, width, height); }
     void DrawRectangle(const wxPoint& pt, const wxSize& sz)
@@ -227,6 +234,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)
@@ -256,19 +266,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
@@ -281,6 +307,54 @@ public:
     void DrawSpline(wxList *points) { DoDrawSpline(points); }
 #endif // wxUSE_SPLINES
 
+    // Eventually we will have wxUSE_GENERIC_DRAWELLIPSE
+#ifdef __WXWINCE__
+    //! Generic method to draw ellipses, circles and arcs with current pen and brush.
+    /*! \param x Upper left corner of bounding box.
+     *  \param y Upper left corner of bounding box.
+     *  \param w Width of bounding box.
+     *  \param h Height of bounding box.
+     *  \param sa Starting angle of arc 
+     *            (counterclockwise, start at 3 o'clock, 360 is full circle).
+     *  \param ea Ending angle of arc.
+     *  \param angle Rotation angle, the Arc will be rotated after 
+     *               calculating begin and end.
+     */
+    void DrawEllipticArcRot( wxCoord x, wxCoord y, 
+                             wxCoord width, wxCoord height, 
+                             double sa = 0, double ea = 0, double angle = 0 )
+    { DoDrawEllipticArcRot( x, y, width, height, sa, ea, angle ); }
+    
+    void DrawEllipticArcRot( const wxPoint& pt, 
+                             const wxSize& sz,
+                             double sa = 0, double ea = 0, double angle = 0 )
+    { DoDrawEllipticArcRot( pt.x, pt.y, sz.x, sz.y, sa, ea, angle ); }
+
+    void DrawEllipticArcRot( const wxRect& rect,
+                             double sa = 0, double ea = 0, double angle = 0 )
+    { DoDrawEllipticArcRot( rect.x, rect.y, rect.width, rect.height, sa, ea, angle ); }
+
+    virtual void DoDrawEllipticArcRot( wxCoord x, wxCoord y, 
+                                       wxCoord w, wxCoord h, 
+                                       double sa = 0, double ea = 0, double angle = 0 );
+    
+    //! Rotates points around center.
+    /*! This is a quite straight method, it calculates in pixels
+     *  and so it produces rounding errors.
+     *  \param points The points inside will be rotated.
+     *  \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle).
+     *  \param center Center of rotation.
+     */ 
+    void Rotate( wxList* points, double angle, wxPoint center = wxPoint() );
+
+    // used by DrawEllipticArcRot
+    // Careful: wxList gets filled with points you have to delete later.
+    void CalculateEllipticPoints( wxList* points, 
+                                  wxCoord xStart, wxCoord yStart, 
+                                  wxCoord w, wxCoord h, 
+                                  double sa, double ea );
+#endif
+    
     // global DC operations
     // --------------------
 
@@ -300,7 +374,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
     // ---------------
@@ -320,10 +396,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
@@ -332,6 +413,7 @@ 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,
@@ -339,6 +421,18 @@ 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);
+
+    // Measure cumulative width of text after each character
+    bool GetPartialTextExtents(const wxString& text, wxArrayInt& widths) const
+        { return DoGetPartialTextExtents(text, widths); }
+
+    
     // size and resolution
     // -------------------
 
@@ -553,18 +647,9 @@ public:
     }
 #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; }
-#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;
@@ -600,7 +685,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;
@@ -610,6 +695,9 @@ protected:
     virtual void DoDrawPolygon(int n, wxPoint points[],
                                wxCoord xoffset, wxCoord yoffset,
                                int fillStyle = wxODDEVEN_RULE) = 0;
+    virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
+                               wxCoord xoffset, wxCoord yoffset,
+                               int fillStyle);
 
     virtual void DoSetClippingRegionAsRegion(const wxRegion& region) = 0;
     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
@@ -652,9 +740,11 @@ protected:
                                  wxCoord *descent = NULL,
                                  wxCoord *externalLeading = NULL,
                                  wxFont *theFont = NULL) const = 0;
-
+    
+    virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
+    
 #if wxUSE_SPLINES
-    virtual void DoDrawSpline(wxList *points) = 0;
+    virtual void DoDrawSpline(wxList *points);
 #endif
 
 protected:
@@ -694,10 +784,14 @@ 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)
 };
 
@@ -711,15 +805,69 @@ 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;
+
+    DECLARE_NO_COPY_CLASS(wxDCTextColourChanger)
+};
+
+// ----------------------------------------------------------------------------
+// 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;
+
+    DECLARE_NO_COPY_CLASS(wxDCClipper)
+};
+
 #endif
     // _WX_DC_H_BASE_