Added a set of 2.4 compatibility classes for the wxDC classes that

replaces the normal Draw methods with those that have 2.4 compatible
parameter lists.  These classes are used by default only when
importing from wxPython.wx (the "old" namespace.)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25074 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/wxPython/docs/MigrationGuide.txt b/wxPython/docs/MigrationGuide.txt
index 70c968ada17e5197052b2835f4d404224e428830..bb274019e02feac7d47f2dbe33c399760198d9f3 100644 (file)
--- a/wxPython/docs/MigrationGuide.txt
+++ b/wxPython/docs/MigrationGuide.txt
@@ -281,13 +281,14 @@ that are affected are listed here::
     SetClippingRegionAsRegion(region);
 
        
-If you have code that draws on a DC you **will** get errors because of
-these changes, but it should be easy to fix the code.  You can either
-change the name of the *Type B* method called to the names shown
-above, or just add parentheses around the parameters as needed to turn
-them into tuples and let the SWIG typemaps turn them into the wx.Point
-or wx.Size object that is expected.  Then you will be calling the new
-*Type A* method.  For example, if you had this code before::
+If you have code that draws on a DC and you are using the new wx
+namespace then you **will** get errors because of these changes, but
+it should be easy to fix the code.  You can either change the name of
+the *Type B* method called to the names shown above, or just add
+parentheses around the parameters as needed to turn them into tuples
+and let the SWIG typemaps turn them into the wx.Point or wx.Size
+object that is expected.  Then you will be calling the new *Type A*
+method.  For example, if you had this code before::
 
     dc.DrawRectangle(x, y, width, height)
 
@@ -305,6 +306,14 @@ Then you can just simplify it like this::
 
     dc.DrawRectangle(p, s)
 
+Now before you start yelling and screaming at me for breaking all your
+code, take note that I said above "...using the new wx namespace..."
+That's because if you are still importing from wxPython.wx then there
+are some classes defined there with Draw and etc. methods that have
+2.4 compatible signatures.  However if/when the old wxPython.wx
+namespace is removed then these classes will be removed too so you
+should plam on migrating to the new namespace and new DC Draw methods
+before that time.
 
 
 

diff --git a/wxPython/src/_dc.i b/wxPython/src/_dc.i
index d394706e8b5c3e951e28a667c15f4440c5ff92ef..def4b15852f0c97b73e63bd4db1e087210494436 100644 (file)
--- a/wxPython/src/_dc.i
+++ b/wxPython/src/_dc.i
@@ -13,6 +13,7 @@
 // Not a %module
 
 
+
 //---------------------------------------------------------------------------
 
 %{
@@ -52,7 +53,7 @@ public:
 
 
 
-#if 0  // The old way
+#if defined(wxUSE_DC_OLD_METHODS)
 
     bool FloodFill(wxCoord x, wxCoord y, const wxColour& col, int style = wxFLOOD_SURFACE);
     //bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const;
@@ -86,7 +87,7 @@ public:
 
 
 #else  // The new way
-    
+
     %name(FloodFillXY) bool FloodFill(wxCoord x, wxCoord y, const wxColour& col, int style = wxFLOOD_SURFACE);
     bool FloodFill(const wxPoint& pt, const wxColour& col, int style = wxFLOOD_SURFACE);
 
@@ -149,18 +150,18 @@ public:
     %name(DrawRotatedTextXY) void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle);
     void DrawRotatedText(const wxString& text, const wxPoint& pt, double angle);
 
-    
+
     %name(BlitXY) bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
                             wxDC *source, wxCoord xsrc, wxCoord ysrc,
                             int rop = wxCOPY, bool useMask = False,
                             wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
-    bool Blit(const wxPoint& destPt, const wxSize& sz,  
+    bool Blit(const wxPoint& destPt, const wxSize& sz,
               wxDC *source, const wxPoint& srcPt,
               int rop = wxCOPY, bool useMask = False,
               const wxPoint& srcPtMask = wxDefaultPosition);
 
 #endif
-    
+
     void DrawLines(int points, wxPoint* points_array, wxCoord xoffset = 0, wxCoord yoffset = 0);
 
     void DrawPolygon(int points, wxPoint* points_array,
@@ -192,7 +193,7 @@ public:
     void DrawSpline(int points, wxPoint* points_array);
 
 
-    
+
     // global DC operations
     // --------------------
 
@@ -204,7 +205,7 @@ public:
     virtual void StartPage();
     virtual void EndPage();
 
-    
+
     // set objects to use for drawing
     // ------------------------------
 
@@ -215,7 +216,7 @@ public:
     virtual void SetBackgroundMode(int mode);
     virtual void SetPalette(const wxPalette& palette);
 
-    
+
     // clipping region
     // ---------------
 
@@ -229,7 +230,7 @@ public:
     DocDeclA(
         void, GetClippingBox(wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT) const,
         "GetClippingBox() -> (x, y, width, height)");
-    
+
     %extend {
         wxRect GetClippingRect() {
             wxRect rect;
@@ -237,9 +238,9 @@ public:
             return rect;
         }
     }
-    
 
-    
+
+
     // text extent
     // -----------
 
@@ -254,14 +255,14 @@ public:
         "Only works for single line strings.");
     DocDeclAStrName(
         void, GetTextExtent(const wxString& string,
-                            wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord* OUTPUT, 
+                            wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord* OUTPUT,
                             wxFont* font = NULL),
         "GetFullTextExtent(wxString string, Font font=None) ->\n   (width, height, descent, externalLeading)",
         "Get the width, height, decent and leading of the text using the current or specified font.\n"
         "Only works for single line strings.",
         GetFullTextExtent);
 
-    
+
     // works for single as well as multi-line strings
     DocDeclAStr(
         void, GetMultiLineTextExtent(const wxString& text,
@@ -281,7 +282,7 @@ public:
         void, GetSize( int *OUTPUT, int *OUTPUT ),
         "GetSizeTuple() -> (width, height)",
         GetSizeTuple);
-    
+
 
     DocStr(GetSizeMM, "Get the DC size in milimeters.");
     wxSize GetSizeMM() const;
@@ -289,8 +290,8 @@ public:
         void, GetSizeMM( int *OUTPUT, int *OUTPUT ) const,
         "GetSizeMMTuple() -> (width, height)",
         GetSizeMMTuple);
-    
-    
+
+
 
     // coordinates conversions
     // -----------------------
@@ -320,7 +321,7 @@ public:
 
     virtual bool Ok() const;
 
-    
+
 
     int GetBackgroundMode() const;
     const wxBrush&  GetBackground() const;
@@ -336,14 +337,14 @@ public:
     int GetMapMode() const;
     virtual void SetMapMode(int mode);
 
-    
+
     DocDeclA(
         virtual void, GetUserScale(double *OUTPUT, double *OUTPUT) const,
         "GetUserScale() -> (xScale, yScale)");
-    
+
     virtual void SetUserScale(double x, double y);
 
-    
+
     DocDeclA(
         virtual void, GetLogicalScale(double *OUTPUT, double *OUTPUT),
         "GetLogicalScale() -> (xScale, yScale)");
@@ -356,16 +357,16 @@ public:
         void, GetLogicalOrigin(wxCoord *OUTPUT, wxCoord *OUTPUT) const,
         "GetLogicalOriginTuple() -> (x,y)",
         GetLogicalOriginTuple);
-        
+
     virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
 
-    
+
     wxPoint GetDeviceOrigin() const;
     DocDeclAName(
         void, GetDeviceOrigin(wxCoord *OUTPUT, wxCoord *OUTPUT) const,
         "GetDeviceOriginTuple() -> (x,y)",
         GetDeviceOriginTuple);
-    
+
     virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
 
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
@@ -375,7 +376,7 @@ public:
 
     virtual void SetOptimization(bool opt);
     virtual bool GetOptimization();
-    
+
 
     // bounding box
     // ------------
@@ -395,7 +396,7 @@ public:
     %extend {
         void GetBoundingBox(int* OUTPUT, int* OUTPUT, int* OUTPUT, int* OUTPUT);
         // See below for implementation
-    }    
+    }
     %pythoncode { def __nonzero__(self): return self.Ok() };
 
 
@@ -486,8 +487,8 @@ public:
 
 
     def DrawPolygonList(self, polygons, pens=None, brushes=None):
-        ## Note: This does not currently support fill style or offset
-        ## you can always use the non-List version if need be.
+        %## Note: This does not currently support fill style or offset
+        %## you can always use the non-List version if need be.
         if pens is None:
            pens = []
         elif isinstance(pens, wx.Pen):
@@ -504,9 +505,9 @@ public:
 
 
     def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None, fonts = None):
-        ## NOTE: this does not currently support changing the font
-        ##       Make sure you set Background mode to wxSolid (DC.SetBackgroundMode)
-        ##       If you want backgounds to do anything.
+        %## NOTE: this does not currently support changing the font
+        %##       Make sure you set Background mode to wxSolid (DC.SetBackgroundMode)
+        %##       If you want backgounds to do anything.
         if type(textList) == type(''):
            textList = [textList]
         elif len(textList) != len(coords):
@@ -547,7 +548,7 @@ class wxMemoryDC : public wxDC {
 public:
     wxMemoryDC();
     %name(MemoryDCFromDC) wxMemoryDC(wxDC* oldDC);
-        
+
     void SelectObject(const wxBitmap& bitmap);
 };
 
@@ -557,9 +558,9 @@ public:
 class wxBufferedDC : public wxMemoryDC
 {
 public:
-    %addtofunc wxBufferedDC( wxDC *dc, const wxBitmap &buffer ) 
+    %addtofunc wxBufferedDC( wxDC *dc, const wxBitmap &buffer )
         "self._dc = args[0] # save a ref so the other dc will not be deleted before self";
-    %addtofunc wxBufferedDC( wxDC *dc, const wxSize &area ) 
+    %addtofunc wxBufferedDC( wxDC *dc, const wxSize &area )
         "val._dc = args[0] # save a ref so the other dc will not be deleted before self";
 
     // Construct a wxBufferedDC using a user supplied buffer.
@@ -752,12 +753,12 @@ class  wxPrinterDC : public wxClientDC {
 public:
     wxPrinterDC(const wxPrintData&)
         { wxPyRaiseNotImplemented(); }
-    
+
 //     wxPrinterDC(const wxString&, const wxString&, const wxString&, bool, int)
 //         { wxPyRaiseNotImplemented(); }
 };
 %}
- 
+
 class  wxPrinterDC : public wxDC {
 public:
     wxPrinterDC(const wxPrintData& printData);
@@ -769,4 +770,49 @@ public:
 };
 #endif
 
+//---------------------------------------------------------------------------
+//---------------------------------------------------------------------------
+
+// Now define some Python classes that rename the Draw methods to be
+// compatible with the DC Draw methods in 2.4.  See also wxPython/_wx.py.
+
+
+%define MAKE_OLD_DC_CLASS(classname)
+    %pythoncode {
+    class classname##_old(classname):
+        """DC class that has methods with 2.4 compatible parameters."""
+        FloodFill = classname.FloodFillXY
+        GetPixel = classname.GetPixelXY
+        DrawLine = classname.DrawLineXY
+        CrossHair = classname.CrossHairXY
+        DrawArc = classname.DrawArcXY
+        DrawCheckMark = classname.DrawCheckMarkXY
+        DrawEllipticArc = classname.DrawEllipticArcXY
+        DrawPoint = classname.DrawPointXY
+        DrawRectangle = classname.DrawRectangleXY
+        DrawRoundedRectangle = classname.DrawRoundedRectangleXY
+        DrawCircle = classname.DrawCircleXY
+        DrawEllipse = classname.DrawEllipseXY
+        DrawIcon = classname.DrawIconXY
+        DrawBitmap = classname.DrawBitmapXY
+        DrawText = classname.DrawTextXY
+        DrawRotatedText = classname.DrawRotatedTextXY
+        Blit = classname.BlitXY
+    }
+%enddef
+
+MAKE_OLD_DC_CLASS(DC);
+MAKE_OLD_DC_CLASS(MemoryDC);
+MAKE_OLD_DC_CLASS(BufferedDC);
+MAKE_OLD_DC_CLASS(BufferedPaintDC);
+MAKE_OLD_DC_CLASS(ScreenDC);
+MAKE_OLD_DC_CLASS(ClientDC);
+MAKE_OLD_DC_CLASS(PaintDC);
+MAKE_OLD_DC_CLASS(WindowDC);
+MAKE_OLD_DC_CLASS(MirrorDC);
+MAKE_OLD_DC_CLASS(PostScriptDC);
+MAKE_OLD_DC_CLASS(MetaFileDC);
+MAKE_OLD_DC_CLASS(PrinterDC);
+
+
 //---------------------------------------------------------------------------

diff --git a/wxPython/src/_gdi_reverse.txt b/wxPython/src/_gdi_reverse.txt
index 67f45d777ae1ff2fb13e1daad69c886eec4895ed..ea42acfa7127b03dc1d20a86dc810148f4b45300 100644 (file)
--- a/wxPython/src/_gdi_reverse.txt
+++ b/wxPython/src/_gdi_reverse.txt
@@ -1,7 +1,18 @@
 # Other names that need to be reverse-renamed for the old namespace
 
 
-#Color
-#NamedColor
+DC_old
+MemoryDC_old
+BufferedDC_old
+BufferedPaintDC_old
+ScreenDC_old
+ClientDC_old
+PaintDC_old
+WindowDC_old
+MirrorDC_old
+PostScriptDC_old
+MetaFileDC_old
+PrinterDC_old
+
 
 

diff --git a/wxPython/wxPython/_wx.py b/wxPython/wxPython/_wx.py
index 876836e56ec04c5971467270b2229860aa34aa1b..fe3ea11ac1139ad9555dfcd69cd5a443369c4cc6 100644 (file)
--- a/wxPython/wxPython/_wx.py
+++ b/wxPython/wxPython/_wx.py
@@ -35,28 +35,23 @@ def wxPyTypeCast(obj, typeStr):
 wxPy_isinstance = isinstance
 
 
-# To get wxDC methods compatible with the old 2.4 wxDC uncomment these
-# lines.  Note however that doing this will break any code that
-# expects the new-style methods.  (Is there a way to do this that does
-# not have that problem?  I suppose we could provide two versions of
-# the DC classes and just rename them here...)
-
-#wxDC.FloodFill = wxDC.FloodFillXY
-#wxDC.GetPixel = wxDC.GetPixelXY
-#wxDC.DrawLine = wxDC.DrawLineXY
-#wxDC.CrossHair = wxDC.CrossHairXY
-#wxDC.DrawArc = wxDC.DrawArcXY
-#wxDC.DrawCheckMark = wxDC.DrawCheckMarkXY
-#wxDC.DrawEllipticArc = wxDC.DrawEllipticArcXY
-#wxDC.DrawPoint = wxDC.DrawPointXY
-#wxDC.DrawRectangle = wxDC.DrawRectangleXY
-#wxDC.DrawRoundedRectangle = wxDC.DrawRoundedRectangleXY
-#wxDC.DrawCircle = wxDC.DrawCircleXY
-#wxDC.DrawEllipse = wxDC.DrawEllipseXY
-#wxDC.DrawIcon = wxDC.DrawIconXY
-#wxDC.DrawBitmap = wxDC.DrawBitmapXY
-#wxDC.DrawText = wxDC.DrawTextXY
-#wxDC.DrawRotatedText = wxDC.DrawRotatedTextXY
-#wxDC.Blit = wxDC.BlitXY
-#wxDC.SetClippingRegion = wxDC.SetClippingRegionXY 
+
+# The wx*DC_old classes have Draw* method signatures that are mostly
+# compatible with 2.4, so assign the new classes to wx*DC_new and make
+# the _old classes be the defaults with the normal names.
+
+# Too bad it doesn't currently work...
+
+wxDC_new = wxDC; wxDC = wxDC_old                 
+wxMemoryDC_new = wxMemoryDC; wxMemoryDC = wxMemoryDC_old           
+wxBufferedDC_new = wxBufferedDC; wxBufferedDC = wxBufferedDC_old         
+wxBufferedPaintDC_new = wxBufferedPaintDC; wxBufferedPaintDC = wxBufferedPaintDC_old    
+wxScreenDC_new = wxScreenDC; wxScreenDC = wxScreenDC_old           
+wxClientDC_new = wxClientDC; wxClientDC = wxClientDC_old           
+wxPaintDC_new = wxPaintDC; wxPaintDC = wxPaintDC_old            
+wxWindowDC_new = wxWindowDC; wxWindowDC = wxWindowDC_old           
+wxMirrorDC_new = wxMirrorDC; wxMirrorDC = wxMirrorDC_old           
+wxPostScriptDC_new = wxPostScriptDC; wxPostScriptDC = wxPostScriptDC_old       
+wxMetaFileDC_new = wxMetaFileDC; wxMetaFileDC = wxMetaFileDC_old         
+wxPrinterDC_new = wxPrinterDC; wxPrinterDC = wxPrinterDC_old