Check for errors after unicode conversions

[wxWidgets.git] / wxPython / docs / MigrationGuide.txt

diff --git a/wxPython/docs/MigrationGuide.txt b/wxPython/docs/MigrationGuide.txt
index e5e2c59617447acd4fcfe8aaf6ef153c6dabe815..eea0562cc088584f4ffff54ef750a107eee7d5dc 100644 (file)
--- a/wxPython/docs/MigrationGuide.txt
+++ b/wxPython/docs/MigrationGuide.txt
@@ -4,10 +4,12 @@ wxPython 2.5 Migration Guide
 
 This document will help explain some of the major changes in wxPython
 2.5 and let you know what you need to do to adapt your programs to
 
 This document will help explain some of the major changes in wxPython
 2.5 and let you know what you need to do to adapt your programs to

-those changes.  Be sure to also check in the CHANGES.txt file like
+those changes.  Be sure to also check in the CHANGES_ file like

 usual to see info about the not so major changes and other things that
 have been added to wxPython.
 
 usual to see info about the not so major changes and other things that
 have been added to wxPython.
 

+.. _CHANGES: CHANGES.html
+

 
 wxName Change
 -------------
 
 wxName Change
 -------------


@@ -330,13 +332,13 @@ method.  For example, if you had this code before::
 
     dc.DrawRectangle(x, y, width, height)
 
 
     dc.DrawRectangle(x, y, width, height)
 

-You could either continue to use the *Type B* method bu changing the
-name to DrawRectabgleXY, or just change it to the new *Type A* by
+You could either continue to use the *Type B* method by changing the
+name to DrawRectangleXY, or just change it to the new *Type A* by

 adding some parentheses like this::
 
     dc.DrawRectangle((x, y), (width, height))
 
 adding some parentheses like this::
 
     dc.DrawRectangle((x, y), (width, height))
 

-Or if you were already using a point and size::
+Or if you were already using a point and size like this::

 
     dc.DrawRectangle(p.x, p.y, s.width, s.height)
 
 
     dc.DrawRectangle(p.x, p.y, s.width, s.height)
 


@@ -345,7 +347,7 @@ 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
     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..."
+code, take note that up above I said, "...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
 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


@@ -365,22 +367,22 @@ aware that you now need to also build the ogl, stc, xrc, and gizmos
 libraries in addition to the main wx lib.  
 
 The wxPython.h and other header files are now in
 libraries in addition to the main wx lib.  
 
 The wxPython.h and other header files are now in

-.../wxPython/include/wx/wxPython instead of in wxPython/src.  You should
-include it via the "wx/wxPython/wxPython.h" path and add
+.../wxPython/include/wx/wxPython instead of in wxPython/src.  You
+should include it via the "wx/wxPython/wxPython.h" path and add

 .../wxPython/include to your list of include paths.  On OSX and
 unix-like systems the wxPython headers are installed to the same place
 .../wxPython/include to your list of include paths.  On OSX and
 unix-like systems the wxPython headers are installed to the same place

-that the wxWidgets headers are installed, so if you building wxPython
-compatible extensions on those platforms then your include path shoudl
-already be set properly.
+that the wxWidgets headers are installed, so if you are building
+wxPython compatible extensions on those platforms then your include
+path should already be set properly.

 
 If you are also using SWIG for your extension then you'll need to
 adapt how the wxPython .i files are imported into your .i files.  See
 the wxPython sources for examples.  Your modules will need to at least
 ``%import core.i``, and possibly others if you need the definition of
 
 If you are also using SWIG for your extension then you'll need to
 adapt how the wxPython .i files are imported into your .i files.  See
 the wxPython sources for examples.  Your modules will need to at least
 ``%import core.i``, and possibly others if you need the definition of

-other classes.  Since you will need them to build your modules, the
-main wxPython .i files are also installed with the wxPython headers in
-an i_files sibdirectory.  It should be enough to pass a -I/pathname on
-the command line for it to find the files.
+other classes.  Since you will need them to build your modules using
+SWIG, the main wxPython .i files are also installed with the wxPython
+headers in an i_files sibdirectory.  It should be enough to pass a
+-I/pathname on the command line for SWIG to find the files.

 
 The bulk of wxPython's setup.py has been moved to another module,
 wx/build/config.py.  This module will be installed as part of wxPython
 
 The bulk of wxPython's setup.py has been moved to another module,
 wx/build/config.py.  This module will be installed as part of wxPython


@@ -425,7 +427,7 @@ Sizers
 ------
 
 The hack allowing the old "option" keyword parameter has been removed.
 ------
 
 The hack allowing the old "option" keyword parameter has been removed.

-If you use keyworkd args with w.xSizer Add, Insert, or Prepend methods
+If you use keyword args with w.xSizer Add, Insert, or Prepend methods

 then you will need to use the ``proportion`` name instead of ``option``.
 
 When adding a spacer to a sizer you now need to use a wx.Size or a
 then you will need to use the ``proportion`` name instead of ``option``.
 
 When adding a spacer to a sizer you now need to use a wx.Size or a


@@ -626,3 +628,23 @@ enough if your main frame object holds the only reference to the
 wx.TaskBarIcon, then when the frame is closed Python reference
 counting takes care of the rest.
 
 wx.TaskBarIcon, then when the frame is closed Python reference
 counting takes care of the rest.
 

+Before Python 2.3 it was possible to pass a floating point object as a
+parameter to a function that expected an integer, and the
+PyArg_ParseTuple family of functions would automatically convert to
+integer by truncating the fractional portion of the number.  With
+Python 2.3 that behavior was deprecated and a deprecation warning is
+raised when you pass a floating point value, (for example, calling
+wx.DC.DrawLineXY with floats for the position and size,) and lots of
+developers using wxPython had to scramble to change their code to call
+int() before calling wxPython methods.  Recent changes in SWIG have
+moved the conversion out of PyArg_ParseTuple to custom code that SWIG
+generates.  Since the default conversion fragment was a little too
+strict and didn't generate a very meaningful exception when it failed,
+I decided to use a custom fragment instead, and it turned out that
+it's very easy to allow floats to be converted again just like they
+used to be.   So, in a nutshell, any numeric type that can be
+converted to an integer is now legal to be passed to SWIG wrapped
+functions in wxPython for parameters that are expecting an integer.
+If the object is not already an integer then it will be asked to
+convert itself to one.  A similar conversion fragment is in place for
+parameters that expect floating point values.