]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dc.h
Added GetPureVitualSize() returning just m_virtualSize.
[wxWidgets.git] / include / wx / dc.h
index 7ca8eb3b769ceb1562ab9d601439c45421e66b62..6deddb04f9606aa85fff8d8eb0cbaf5669477cd2 100644 (file)
@@ -5,14 +5,14 @@
 // Modified by:
 // Created:     05/25/99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #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/cursor.h"          // we have member variables of these classes
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"
+#include "wx/bitmap.h"          // for wxNullBitmap
 #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"
+#include "wx/math.h"
 
+class WXDLLEXPORT wxDC;
 class WXDLLEXPORT wxDCBase;
 
 class WXDLLEXPORT wxDrawObject
@@ -38,9 +41,9 @@ class WXDLLEXPORT wxDrawObject
 public:
 
     wxDrawObject()
-    {
-        ResetBoundingBox();
-    }
+        : m_isBBoxValid(false)
+        , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
+    }
 
     virtual ~wxDrawObject() { }
 
@@ -57,7 +60,7 @@ public:
       }
       else
       {
-         m_isBBoxValid = TRUE;
+         m_isBBoxValid = true;
 
          m_minX = x;
          m_minY = y;
@@ -68,7 +71,7 @@ public:
 
     void ResetBoundingBox()
     {
-        m_isBBoxValid = FALSE;
+        m_isBBoxValid = false;
 
         m_minX = m_maxX = m_minY = m_maxY = 0;
     }
@@ -94,7 +97,7 @@ protected:
 // global variables
 // ---------------------------------------------------------------------------
 
-WXDLLEXPORT_DATA(extern int) wxPageNumber;
+extern WXDLLEXPORT_DATA(int) wxPageNumber;
 
 // ---------------------------------------------------------------------------
 // wxDC is the device context - object on which any drawing is done
@@ -104,33 +107,35 @@ 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();
+        ResetClipping();
     }
 
     ~wxDCBase() { }
@@ -148,12 +153,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 +214,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 +237,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)
@@ -240,10 +253,10 @@ public:
         { DoDrawIcon(icon, pt.x, pt.y); }
 
     void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
-                    bool useMask = FALSE)
+                    bool useMask = false)
         { DoDrawBitmap(bmp, x, y, useMask); }
     void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt,
-                    bool useMask = FALSE)
+                    bool useMask = false)
         { DoDrawBitmap(bmp, pt.x, pt.y, useMask); }
 
     void DrawText(const wxString& text, wxCoord x, wxCoord y)
@@ -274,17 +287,17 @@ public:
 
     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 = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord)
     {
         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 = wxDefaultPosition)
     {
         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
@@ -297,12 +310,60 @@ 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
     // --------------------
 
     virtual void Clear() = 0;
 
-    virtual bool StartDoc(const wxString& WXUNUSED(message)) { return TRUE; }
+    virtual bool StartDoc(const wxString& WXUNUSED(message)) { return true; }
     virtual void EndDoc() { }
 
     virtual void StartPage() { }
@@ -316,7 +377,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
     // ---------------
@@ -330,16 +393,13 @@ public:
     void SetClippingRegion(const wxRegion& region)
         { DoSetClippingRegionAsRegion(region); }
 
-    virtual void DestroyClippingRegion() = 0;
+    virtual void DestroyClippingRegion() { ResetClipping(); }
 
     void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const
         { DoGetClippingBox(x, y, w, h); }
     void GetClippingBox(wxRect& rect) const
         {
-          // 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;
+          DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height);
         }
 
     // text extent
@@ -363,6 +423,11 @@ public:
                                         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
     // -------------------
 
@@ -416,26 +481,17 @@ public:
 
     virtual bool Ok() const { return m_ok; }
 
-    // accessors
-    // ---------
+    // accessors and setters
+    // ---------------------
 
-        // 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 wxPen&    GetPen() const { return m_pen; }
-    const wxColour& GetTextBackground() const { return m_textBackgroundColour; }
-    const wxColour& GetTextForeground() const { return m_textForegroundColour; }
-
-        // ... and non const
-    wxBrush&  GetBackground() { return m_backgroundBrush; }
-    wxBrush&  GetBrush() { return m_brush; }
-    wxFont&   GetFont() { return m_font; }
-    wxPen&    GetPen() { return m_pen; }
-    wxColour& GetTextBackground() { return m_textBackgroundColour; }
-    wxColour& GetTextForeground() { return m_textForegroundColour; }
 
+    const wxColour& GetTextForeground() const { return m_textForegroundColour; }
+    const wxColour& GetTextBackground() const { return m_textBackgroundColour; }
     virtual void SetTextForeground(const wxColour& colour)
         { m_textForegroundColour = colour; }
     virtual void SetTextBackground(const wxColour& colour)
@@ -474,17 +530,17 @@ public:
         { wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); }
     virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0;
 
+    virtual void ComputeScaleAndOrigin() {}
+
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 
     int GetLogicalFunction() const { return m_logicalFunction; }
     virtual void SetLogicalFunction(int function) = 0;
 
-    // Sometimes we need to override optimization, e.g. if other software is
-    // drawing onto our surface and we can't be sure of who's done what.
-    //
-    // FIXME: is this (still) used?
+#if WXWIN_COMPATIBILITY_2_4
     virtual void SetOptimization(bool WXUNUSED(opt)) { }
-    virtual bool GetOptimization() { return FALSE; }
+    virtual bool GetOptimization() { return false; }
+#endif
 
     // bounding box
     // ------------
@@ -500,7 +556,7 @@ public:
       }
       else
       {
-         m_isBBoxValid = TRUE;
+         m_isBBoxValid = true;
 
          m_minX = x;
          m_minY = y;
@@ -511,7 +567,7 @@ public:
 
     void ResetBoundingBox()
     {
-        m_isBBoxValid = FALSE;
+        m_isBBoxValid = false;
 
         m_minX = m_maxX = m_minY = m_maxY = 0;
     }
@@ -526,7 +582,6 @@ public:
     // ------------------
 
     // for compatibility with the old code when wxCoord was long everywhere
-#ifndef __WIN16__
     void GetTextExtent(const wxString& string,
                        long *x, long *y,
                        long *descent = NULL,
@@ -575,20 +630,10 @@ public:
         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; }
-#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;
@@ -615,7 +660,7 @@ protected:
 
     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0;
     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
-                              bool useMask = FALSE) = 0;
+                              bool useMask = false) = 0;
 
     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
     virtual void DoDrawRotatedText(const wxString& text,
@@ -624,7 +669,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 = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;
 
     virtual void DoGetSize(int *width, int *height) const = 0;
     virtual void DoGetSizeMM(int* width, int* height) const = 0;
@@ -634,29 +679,32 @@ 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,
                                      wxCoord width, wxCoord height) = 0;
 
-    // FIXME are these functions really different?
+#if WXWIN_COMPATIBILITY_2_4
+    // this was only for confusing people, use DoGetClippingBox only
     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
                                      wxCoord *w, wxCoord *h)
         { DoGetClippingBox(x, y, w, h); }
+#endif
+
     virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
                                   wxCoord *w, wxCoord *h) const
     {
-        if ( m_clipping )
-        {
-            if ( x ) *x = m_clipX1;
-            if ( y ) *y = m_clipY1;
-            if ( w ) *w = m_clipX2 - m_clipX1;
-            if ( h ) *h = m_clipY2 - m_clipY1;
-        }
-        else
-        {
-            *x = *y = *w = *h = 0;
-        }
+        if ( x )
+            *x = m_clipX1;
+        if ( y )
+            *y = m_clipY1;
+        if ( w )
+            *w = m_clipX2 - m_clipX1;
+        if ( h )
+            *h = m_clipY2 - m_clipY1;
     }
 
     virtual void DoGetLogicalOrigin(wxCoord *x, wxCoord *y) const
@@ -677,11 +725,21 @@ protected:
                                  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);
 #endif
 
 protected:
+    // unset clipping variables (after clipping region was destroyed)
+    void ResetClipping()
+    {
+        m_clipping = false;
+
+        m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0;
+    }
+
     // flags
     bool m_colour:1;
     bool m_ok:1;
@@ -718,10 +776,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)
 };
 
@@ -729,22 +791,24 @@ private:
 // now include the declaration of wxDC class
 // ----------------------------------------------------------------------------
 
-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/dc.h"
+#elif defined(__WXMSW__)
     #include "wx/msw/dc.h"
 #elif defined(__WXMOTIF__)
     #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(__WXQT__)
-    #include "wx/qt/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
 
 // ----------------------------------------------------------------------------
@@ -755,7 +819,7 @@ private:
 class WXDLLEXPORT wxDCTextColourChanger
 {
 public:
-    wxDCTextColourChanger(wxDC& dc) : m_dc(dc) { }
+    wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
 
     ~wxDCTextColourChanger()
     {
@@ -774,6 +838,29 @@ 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