Change GetC to return an int so that it can return wxEOF on error.

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

diff --git a/include/wx/dc.h b/include/wx/dc.h
index 668140b75821089b5920c4f35a4d8ed2bd968837..dbe62c4d95e2f94754072a0c0c5c4e3ceeef919b 100644 (file)
--- a/include/wx/dc.h
+++ b/include/wx/dc.h
@@ -18,6 +18,7 @@
 
 #include "wx/object.h"          // the base class
 
 
 #include "wx/object.h"          // the base class
 

+#include "wx/intl.h"            // for wxLayoutDirection

 #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/cursor.h"          // we have member variables of these classes
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"


@@ -132,12 +133,7 @@ public:
         ResetClipping();
     }
 
         ResetClipping();
     }
 

-    ~wxDCBase() { }
-
-#if WXWIN_COMPATIBILITY_2_6
-    wxDEPRECATED( virtual void BeginDrawing() );
-    wxDEPRECATED( virtual void EndDrawing() );
-#endif // WXWIN_COMPATIBILITY_2_6
+    virtual ~wxDCBase() { }

 
     // graphic primitives
     // ------------------
 
     // graphic primitives
     // ------------------


@@ -168,7 +164,8 @@ public:
     void GradientFillConcentric(const wxRect& rect,
                                 const wxColour& initialColour,
                                 const wxColour& destColour,
     void GradientFillConcentric(const wxRect& rect,
                                 const wxColour& initialColour,
                                 const wxColour& destColour,

-                                const wxPoint& circleCenter);
+                                const wxPoint& circleCenter)
+        { DoGradientFillConcentric(rect, initialColour, destColour, circleCenter); }

 
     // fill the area specified by rect with a linear gradient
     void GradientFillLinear(const wxRect& rect,
 
     // fill the area specified by rect with a linear gradient
     void GradientFillLinear(const wxRect& rect,


@@ -316,6 +313,11 @@ public:
         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
                       source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);
     }
         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
                       source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);
     }

+    
+    wxBitmap GetAsBitmap(const wxRect *subrect = (const wxRect *) NULL) const
+    {
+        return DoGetAsBitmap(subrect);
+    }

 
 #if wxUSE_SPLINES
     // TODO: this API needs fixing (wxPointList, why (!const) "wxList *"?)
 
 #if wxUSE_SPLINES
     // TODO: this API needs fixing (wxPointList, why (!const) "wxList *"?)


@@ -386,6 +388,12 @@ public:
     virtual void StartPage() { }
     virtual void EndPage() { }
 
     virtual void StartPage() { }
     virtual void EndPage() { }
 

+#if WXWIN_COMPATIBILITY_2_6
+    wxDEPRECATED( void BeginDrawing() );
+    wxDEPRECATED( void EndDrawing() );
+#endif // WXWIN_COMPATIBILITY_2_6
+
+

     // set objects to use for drawing
     // ------------------------------
 
     // set objects to use for drawing
     // ------------------------------
 


@@ -496,25 +504,26 @@ public:
     // Resolution in Pixels per inch
     virtual wxSize GetPPI() const = 0;
 
     // Resolution in Pixels per inch
     virtual wxSize GetPPI() const = 0;
 

-    virtual bool Ok() const { return m_ok; }
+    virtual bool Ok() const { return IsOk(); }
+    virtual bool IsOk() const { return m_ok; }

 
     // accessors and setters
     // ---------------------
 
 
     // accessors and setters
     // ---------------------
 

-    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; }
+    virtual int GetBackgroundMode() const { return m_backgroundMode; }
+    virtual const wxBrush&  GetBackground() const { return m_backgroundBrush; }
+    virtual const wxBrush&  GetBrush() const { return m_brush; }
+    virtual const wxFont&   GetFont() const { return m_font; }
+    virtual const wxPen&    GetPen() const { return m_pen; }

 
 

-    const wxColour& GetTextForeground() const { return m_textForegroundColour; }
-    const wxColour& GetTextBackground() const { return m_textBackgroundColour; }
+    virtual const wxColour& GetTextForeground() const { return m_textForegroundColour; }
+    virtual const wxColour& GetTextBackground() const { return m_textBackgroundColour; }

     virtual void SetTextForeground(const wxColour& colour)
         { m_textForegroundColour = colour; }
     virtual void SetTextBackground(const wxColour& colour)
         { m_textBackgroundColour = colour; }
 
     virtual void SetTextForeground(const wxColour& colour)
         { m_textForegroundColour = colour; }
     virtual void SetTextBackground(const wxColour& colour)
         { m_textBackgroundColour = colour; }
 

-    int GetMapMode() const { return m_mappingMode; }
+    virtual int GetMapMode() const { return m_mappingMode; }

     virtual void SetMapMode(int mode) = 0;
 
     virtual void GetUserScale(double *x, double *y) const
     virtual void SetMapMode(int mode) = 0;
 
     virtual void GetUserScale(double *x, double *y) const


@@ -551,7 +560,7 @@ public:
 
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 
 
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 

-    int GetLogicalFunction() const { return m_logicalFunction; }
+    virtual int GetLogicalFunction() const { return m_logicalFunction; }

     virtual void SetLogicalFunction(int function) = 0;
 
 #if WXWIN_COMPATIBILITY_2_4
     virtual void SetLogicalFunction(int function) = 0;
 
 #if WXWIN_COMPATIBILITY_2_4


@@ -648,6 +657,16 @@ public:
         if (h) *h = hh;
     }
 
         if (h) *h = hh;
     }
 

+    // RTL related functions
+    // ---------------------
+
+    // get or change the layout direction (LTR or RTL) for this dc,
+    // wxLayout_Default is returned if layout direction is not supported
+    virtual wxLayoutDirection GetLayoutDirection() const
+        { return wxLayout_Default; }
+    virtual void SetLayoutDirection(wxLayoutDirection WXUNUSED(dir))
+        { }
+

 protected:
     // the pure virtual functions which should be implemented by wxDC
     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 protected:
     // the pure virtual functions which should be implemented by wxDC
     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,


@@ -658,6 +677,11 @@ protected:
                                       const wxColour& destColour,
                                       wxDirection nDirection = wxEAST);
 
                                       const wxColour& destColour,
                                       wxDirection nDirection = wxEAST);
 

+    virtual void DoGradientFillConcentric(const wxRect& rect,
+                                        const wxColour& initialColour,
+                                        const wxColour& destColour,
+                                        const wxPoint& circleCenter);
+

     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
 
     virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;
     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
 
     virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;


@@ -693,6 +717,8 @@ protected:
                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;
 
                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;
 

+    virtual wxBitmap DoGetAsBitmap(const wxRect *WXUNUSED(subrect)) const { return wxNullBitmap; }
+

     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;
 


@@ -837,6 +863,10 @@ private:
     #include "wx/os2/dc.h"
 #endif
 
     #include "wx/os2/dc.h"
 #endif
 

+#if wxUSE_GRAPHICS_CONTEXT
+    #include "wx/dcgraph.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
 // ----------------------------------------------------------------------------
 // helper class: you can use it to temporarily change the DC text colour and
 // restore it automatically when the object goes out of scope


@@ -847,6 +877,11 @@ class WXDLLEXPORT wxDCTextColourChanger
 public:
     wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
 
 public:
     wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
 

+    wxDCTextColourChanger(wxDC& dc, const wxColour& col) : m_dc(dc)
+    {
+        Set(col);
+    }
+

     ~wxDCTextColourChanger()
     {
         if ( m_colFgOld.Ok() )
     ~wxDCTextColourChanger()
     {
         if ( m_colFgOld.Ok() )


@@ -945,5 +980,4 @@ private:
     DECLARE_NO_COPY_CLASS(wxDCClipper)
 };
 
     DECLARE_NO_COPY_CLASS(wxDCClipper)
 };
 

-#endif
-    // _WX_DC_H_BASE_
+#endif // _WX_DC_H_BASE_