Various tweaks, docstring fixes, etc.

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

diff --git a/wxPython/docs/MigrationGuide.txt b/wxPython/docs/MigrationGuide.txt
index 476c60252d3e983a740ce8de1265461b9a30de5b..3828d4dc728d4a96b058e483b41b672db4c12179 100644 (file)
--- a/wxPython/docs/MigrationGuide.txt
+++ b/wxPython/docs/MigrationGuide.txt
@@ -332,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)
 


@@ -347,13 +347,17 @@ 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..."
-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 plan on migrating to the new namespace and new DC Draw methods
-before that time.
+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.  Unfortunately there
+is one exception to this behaviour.  If a DC is returned from a
+function or method then an instance of the new class (with the new
+methods described above) will be returned instead of the compatibility
+class.  If/When the old wxPython.wx namespace is removed then these
+compatibility classes will be removed too so you should plan on
+migrating to the new namespace and new DC Draw methods before that
+time.

 
 
 
 
 
 


@@ -367,22 +371,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


@@ -427,11 +431,16 @@ 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
 2-integer sequence instead of separate width and height parameters.
 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
 2-integer sequence instead of separate width and height parameters.

+This allows for more consistency in how you add the various types of
+items to a sizer.  The first parameter defines the item (instead of
+the possibily first two, depending on if you are doing a spacer or
+not,) and that item can either be a window, a sizer or a spacer (which
+can be a sequence or a wx.Size.)

 
 The wx.GridBagSizer class (very similar to the RowColSizer in the
 library) has been added to C++ and wrapped for wxPython.  It can also
 
 The wx.GridBagSizer class (very similar to the RowColSizer in the
 library) has been added to C++ and wrapped for wxPython.  It can also


@@ -441,6 +450,16 @@ You should not use AddWindow, AddSizer, AddSpacer (and similar for
 Insert, Prepend, and etc.) methods any longer.  Just use Add and the
 wrappers will figure out what to do.
 
 Insert, Prepend, and etc.) methods any longer.  Just use Add and the
 wrappers will figure out what to do.
 

+**[Changed in 2.5.1.6]** wx.ADJUST_MINSIZE is now the default
+behaviour for window items in sizers.  This means that the item's
+GetAdjustedBestSize will be called when calculating layout and the
+return value from that will be used for the minimum size.  Added
+wx.FIXED_MINSIZE flag for when you would like the old behavior but you
+should only need it when your desired size is smaller than the item's
+GetBestSize.  When a window is added to a sizer it's initial size, if
+any, is set as the window's minimal size using SetSizeHints if there
+isn't already a minimal size.
+

 
 PlatformInfo
 ------------
 
 PlatformInfo
 ------------


@@ -600,6 +619,14 @@ Similarly, the wxSystemSettings backwards compatibiility aliases for
 GetSystemColour, GetSystemFont and GetSystemMetric have also gone into
 the bit-bucket.  Use GetColour, GetFont and GetMetric instead.
 
 GetSystemColour, GetSystemFont and GetSystemMetric have also gone into
 the bit-bucket.  Use GetColour, GetFont and GetMetric instead.
 

+Use the Python True/False constants instead of the true, TRUE, false,
+FALSE that used to be provided with wxPython.
+
+Use None instead of the ancient and should have been removed a long
+time ago wx.NULL alias.
+
+wx.TreeCtrl no longer needs to be passed the cookie variable as the
+2nd parameter.  It still returns it though, for use with GetNextChild.

 
 The wx.NO_FULL_REPAINT_ON_RESIZE style is now the default style for
 all windows.  The name still exists for compatibility, but it is set
 
 The wx.NO_FULL_REPAINT_ON_RESIZE style is now the default style for
 all windows.  The name still exists for compatibility, but it is set


@@ -648,3 +675,8 @@ 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.
 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.

+
+**[Changed in 2.5.1.6]**  The MaskedEditCtrl modules have been moved
+to their own sub-package, wx.lib.masked.  See the docstrings and demo
+for changes in capabilities, usage, etc.
+