Various tweaks, docstring fixes, etc.

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

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

 
 
 
 
 
 


@@ -432,6 +436,11 @@ 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.
 
 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.
+