Tweaks to work around wxMac bugs

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

diff --git a/wxPython/docs/MigrationGuide.txt b/wxPython/docs/MigrationGuide.txt
index c9dfddbedb91efede84bcc4c20e33c7b33b383ba..9e33ef4c3979cbd16dbe62346c88ee8ed933b54e 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
 -------------


@@ -15,7 +17,7 @@ wxName Change
 The **wxWindows** project and library is now known as
 **wxWidgets**.  Please see here_ for more details.
 
 The **wxWindows** project and library is now known as
 **wxWidgets**.  Please see here_ for more details.
 

-.. _here: http://www.wxwindows.org/name.htm
+.. _here: http://www.wxwidgets.org/name.htm

 
 This won't really affect wxPython all that much, other than the fact
 that the wxwindows.org domain name will be changing to wxwidgets.org,
 
 This won't really affect wxPython all that much, other than the fact
 that the wxwindows.org domain name will be changing to wxwidgets.org,


@@ -60,26 +62,28 @@ customizations added that I hope to get folded back into the main SWIG
 distribution.)  This has some far reaching ramifications:
 
     All classes derive from object and so all are now "new-style
 distribution.)  This has some far reaching ramifications:
 
     All classes derive from object and so all are now "new-style

-    classes"
+    classes."  This also allows you to use mixin classes that are
+    new-style and to use properties, staticmethod, etc.

 
     Public data members of the C++ classes are wrapped as Python
 
     Public data members of the C++ classes are wrapped as Python

-    properties using property() instead of using __getattr__/__setattr__
-    like before.  Normally you shouldn't notice any difference, but if
-    you were previously doing something with __getattr__/__setattr__
-    in derived classes then you may have to adjust things.
-
-    Static C++ methods are wrapped using the staticmethod()
-    feature of Python and so are accessible as ClassName.MethodName
-    as expected.  They are still available as top level functions
+    properties using property() instead of using
+    __getattr__/__setattr__ hacks like before.  Normally you shouldn't
+    notice any difference, but if you were previously doing something
+    with __getattr__/__setattr__ in derived classes then you may have
+    to adjust things.
+
+    Static C++ methods are wrapped using the staticmethod() feature of
+    Python and so are accessible as ClassName.MethodName as expected.
+    They are still also available as top level functions named like

     ClassName_MethodName as before.
 
     The relationship between the wxFoo and wxFooPtr classes have
     changed for the better.  Specifically, all instances that you see
     ClassName_MethodName as before.
 
     The relationship between the wxFoo and wxFooPtr classes have
     changed for the better.  Specifically, all instances that you see

-    will be wxFoo even if they are created internally using wxFooPtr,
-    because wxFooPtr.__init__ will change the instance's __class__ as
+    will be wx.Foo even if they are created internally using wx.FooPtr,
+    because wx.FooPtr.__init__ will change the instance's __class__ as

     part of the initialization.  If you have any code that checks
     part of the initialization.  If you have any code that checks

-    class type using something like isinstance(obj, wxFooPtr) you will
-    need to change it to isinstance(obj, wxFoo).
+    class type using something like isinstance(obj, wx.FooPtr) you will
+    need to change it to isinstance(obj, wx.Foo).

 
     
 
 
     
 


@@ -89,7 +93,7 @@ Binding Events
 All of the EVT_* functions are now instances of the wx.PyEventBinder
 class.  They have a __call__ method so they can still be used as
 functions like before, but making them instances adds some
 All of the EVT_* functions are now instances of the wx.PyEventBinder
 class.  They have a __call__ method so they can still be used as
 functions like before, but making them instances adds some

-flexibility.
+flexibility that I expect to take advantave of in the future.

 
 wx.EvtHandler (the base class for wx.Window) now has a Bind method that
 makes binding events to windows a little easier.  Here is its
 
 wx.EvtHandler (the base class for wx.Window) now has a Bind method that
 makes binding events to windows a little easier.  Here is its


@@ -150,8 +154,8 @@ values::
      
 If you create your own custom event types and EVT_* functions, and you
 want to be able to use them with the Bind method above then you should
      
 If you create your own custom event types and EVT_* functions, and you
 want to be able to use them with the Bind method above then you should

-change your EVT_* to be an instance of wxPyEventBinder instead of a
-function.  If you used to have something like this::
+change your EVT_* to be an instance of wx.PyEventBinder instead of a
+function.  For example, if you used to have something like this::

 
     myCustomEventType = wxNewEventType()
     def EVT_MY_CUSTOM_EVENT(win, id, func):
 
     myCustomEventType = wxNewEventType()
     def EVT_MY_CUSTOM_EVENT(win, id, func):


@@ -166,6 +170,15 @@ Change it like so::
 The second parameter is an integer in [0, 1, 2] that specifies the
 number of IDs that are needed to be passed to Connect.
 
 The second parameter is an integer in [0, 1, 2] that specifies the
 number of IDs that are needed to be passed to Connect.
 

+**[Changed in 2.5.1.6]** There is also an Unbind method added to
+wx.EvtHandler that can be used to disconenct event handlers.  It looks
+like this::
+
+    def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
+        """
+        Disconencts the event handler binding for event from self.
+        Returns True if successful.
+        """

 
 
 
 
 
 


@@ -182,12 +195,13 @@ Instead of dynamically changing the names at module load time like in
 2.4, the compatibility modules are generated at build time and contain
 assignment statements like this::
 
 2.4, the compatibility modules are generated at build time and contain
 assignment statements like this::
 

-    wxWindow = wx.core.Window
+    wxWindow = wx._core.Window

 
 

-Don't let the "core" in the name bother you.  That and some other
+Don't let the "_core" in the name bother you.  That and some other

 modules are implementation details, and everything that was in the
 wxPython.wx module before will still be in the wx package namespace
 modules are implementation details, and everything that was in the
 wxPython.wx module before will still be in the wx package namespace

-after this change.  So from your code you would use it as wx.Window.
+after this change.  So from your code you would use it as wx.Window or
+wxWindow if you import from the wxPython.wx module.

 
 A few notes about how all of this was accomplished might be
 interesting...  SWIG is now run twice for each module that it is
 
 A few notes about how all of this was accomplished might be
 interesting...  SWIG is now run twice for each module that it is


@@ -237,121 +251,79 @@ just fine.
 New wx.DC Methods
 -----------------
 
 New wx.DC Methods
 -----------------
 

-Many of the Draw methods of wx.DC have alternate forms in C++ that take
-wxPoint or wxSize parameters (let's call these *Type A*) instead of
-the individual x, y, width, height, etc. parameters (and we'll call
-these *Type B*).  In the rest of the library I normally made the *Type
-A* forms of the methods be the default method with the "normal" name,
-and had renamed the *Type B* forms of the methods to some similar
-name.  For example in wx.Window we have these Python methods::
-
-    SetSize(size)               # Type A
-    SetSizeWH(width, height)    # Type B
-
+**[Changed in 2.5.1.6]** In wxPython 2.5.1.5 there was a new
+implementation of the wx.DC Draw and other methods that broke
+backwards compatibility in the name of consistency.  That change has
+been reverted and the wx.DC Draw methods with 2.4 compatible
+signatures have been restored.  In addition a new set of methods have
+been added that take wx.Point and/or wx.Size parameters instead of
+separate integer parameters.  The Draw and etc. methods now available
+are::

 
 

-For various reasons the new *Type A* methods in wx.DC were never added
-and the existing *Type B* methods were never renamed.  Now that lots
-of other things are also changing in wxPython it has been decided that
-it is a good time to also do the method renaming in wx.DC too in order
-to be consistent with the rest of the library.  The methods in wx.DC
-that are affected are listed here::

 
 

-    FloodFillXY(x, y, colour, style = wx.FLOOD_SURFACE)
-    FloodFill(point, colour,  style = wx.FLOOD_SURFACE)
+    FloodFill(x, y, colour, style = wx.FLOOD_SURFACE)
+    FoodFillPoint(pt, colour, style = wx.FLOOD_SURFACE)

 
 

-    GetPixelXY(x, y)
-    GetPixel(point)
-
-    DrawLineXY(x1, y1, x2, y2)
-    DrawLine(point1, point2)
+    GetPixel(x,y)
+    GetPixelPoint(pt) 
+    
+    DrawLine(x1, y1, x2, y2)
+    DrawLinePoint(pt1, pt2)

 
 

-    CrossHairXY(x, y)
-    CrossHair(point)
+    CrossHair(x, y)
+    CrossHairPoint(pt)

 
 

-    DrawArcXY(x1, y1, x2, y2, xc, yc)
-    DrawArc(point1, point2, center)
+    DrawArc(x1, y1, x2, y2, xc, yc)
+    DrawArcPoint(pt1, pt2, centre)

 
 

-    DrawCheckMarkXY(x, y, width, height)
-    DrawCheckMark(rect)
+    DrawCheckMark(x, y, width, height)
+    DrawCheckMarkRect(rect)

 
 

-    DrawEllipticArcXY(x, y, w, h, start_angle, end_angle)
-    DrawEllipticArc(point, size, start_angle, end_angle)
+    DrawEllipticArc(x, y, w, h, sa, ea)
+    DrawEllipticArcPointSize(pt, sz, sa, ea)

 
 

-    DrawPointXY(x, y)
-    DrawPoint(point)
+    DrawPoint(x, y)
+    DrawPointPoint(pt)

 
 

-    DrawRectangleXY(x, y, width, height)
-    DrawRectangle(point, size)
+    DrawRectangle(x, y, width, height)

     DrawRectangleRect(rect)
     DrawRectangleRect(rect)

+    DrawRectanglePointSize(pt, sz)

 
 

-    DrawRoundedRectangleXY(x, y, width, height, radius)
-    DrawRoundedRectangle(point, size, radius)
-    DrawRoundedRectangleRect(rect, radius)
+    DrawRoundedRectangle(x, y, width, height, radius)
+    DrawRoundedRectangleRect(r, radius)
+    DrawRoundedRectanglePointSize(pt, sz, radius)

 
 

-    DrawCircleXY(x, y, radius)
-    DrawCircle(point, radius)
+    DrawCircle(x, y, radius)
+    DrawCirclePoint(pt, radius)

 
 

-    DrawEllipseXY(x, y, width, height)
-    DrawEllipse(point, size)
+    DrawEllipse(x, y, width, height)

     DrawEllipseRect(rect)
     DrawEllipseRect(rect)

+    DrawEllipsePointSize(pt, sz)

 
 

-    DrawIconXY(icon, x, y)
-    DrawIcon(icon, point)
-
-    DrawBitmapXY(bmp, x, y, useMask = FALSE)
-    DrawBitmap(bmp, point, useMask = FALSE)
-
-    DrawTextXY(text, x, y)
-    DrawText(text, point)
+    DrawIcon(icon, x, y)
+    DrawIconPoint(icon, pt)

 
 

-    DrawRotatedTextXY(text, x, y, angle)
-    DrawRotatedText(text, point, angle)
+    DrawBitmap(bmp, x, y, useMask = False)
+    DrawBitmapPoint(bmp, pt, useMask = False)

 
 

-    
-    BlitXY(xdest, ydest, width, height, sourceDC, xsrc, ysrc,
-           rop = wxCOPY, useMask = FALSE, xsrcMask = -1, ysrcMask = -1)
-    Blit(destPt, size, sourceDC, srcPt,
-         rop = wxCOPY, useMask = FALSE, srcPtMask = wx.DefaultPosition)
-
-    SetClippingRegionXY(x, y, width, height)
-    SetClippingRegion(point, size)
-    SetClippingRect(rect)
-    SetClippingRegionAsRegion(region);
-
-       
-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::
+    DrawText(text, x, y)
+    DrawTextPoint(text, pt)

 
 

-    dc.DrawRectangle(x, y, width, height)
+    DrawRotatedText(text, x, y, angle)
+    DrawRotatedTextPoint(text, pt, angle)

 
 

-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
-adding some parentheses like this::
+    bool Blit(xdest, ydest, width, height, sourceDC, xsrc, ysrc,
+              rop = wx.COPY, useMask = False, xsrcMask = -1, ysrcMask = -1)
+    BlitPointSize(destPt, sz, sourceDC, srcPt, rop = wx.COPY, 
+                  useMask = False, srcPtMask = wxDefaultPosition)

 
 

-    dc.DrawRectangle((x, y), (width, height))

 
 

-Or if you were already using a point and size::
-
-    dc.DrawRectangle(p.x, p.y, s.width, s.height)
-
-Then you can just simplify it like this::
+    SetClippingRegion(x, y, width, height)
+    SetClippingRegionPointSize(pt, sz)
+    SetClippingRegionAsRegion(region)
+    SetClippingRect(rect)

 
 

-    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.

 
 
 
 
 
 


@@ -362,19 +334,44 @@ wxPython's setup.py script now expects to use existing libraries for
 the contribs (gizmos, stc, xrc, etc.) rather than building local
 copies of them.  If you build your own copies of wxPython please be
 aware that you now need to also build the ogl, stc, xrc, and gizmos
 the contribs (gizmos, stc, xrc, etc.) rather than building local
 copies of them.  If you build your own copies of wxPython please be
 aware that you now need to also build the ogl, stc, xrc, and gizmos

-libraries in addition to the main wx lib.  [[TODO: update the
-BUILD.*.txt files too!]]
+libraries in addition to the main wx lib.  

 
 The wxPython.h and other header files are now in
 
 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 to your list of include paths.  [[TODO:  Install
-these headers on Linux...]]
+.../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
+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
+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
+so 3rd party modules that wish to use the same setup/configuration
+code can do so simply by importing this module from their own setup.py
+scripts using ``import wx.build.config``. 

 
 You no longer need to call wxClassInfo::CleanUpClasses() and
 wxClassInfo::InitializeClasses() in your extensions or when embedding
 wxPython. 
 
 
 You no longer need to call wxClassInfo::CleanUpClasses() and
 wxClassInfo::InitializeClasses() in your extensions or when embedding
 wxPython. 
 

+The usage of wxPyBeginAllowThreads and wxPyEndAllowThreads has changed
+slightly.  wxPyBeginAllowThreads now returns a boolean value that must
+be passed to the coresponding wxPyEndAllowThreads function call.  This
+is to help do the RightThing when calls to these two functions are
+nested, or if calls to external code in other extension modules that
+are wrapped in the standard Py_(BEGIN|END)_ALLOW_THERADS may result in
+wx event handlers being called (such as during the call to
+os.startfile.)

 
 
 
 
 
 


@@ -400,19 +397,44 @@ 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 wxSizer Add, Insert, or Prepend methods
-then you will need to use the "proportion" name instead of "option".
+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``.  (The ``proportion`` keyword was also allowed in 2.4.2.4.)

 
 

-When adding a spacer to a sizer you now need to use a wxSize or a
+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.
 2-integer sequence instead of separate width and height parameters.

-
-The wxGridBagSizer class (very similar to the RowColSizer in the
+This was optionally allowed in 2.4, but now it is required.  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.)  Removing the option for separate width
+and height parameters greatly simplified the wrapper code.
+
+The wx.GridBagSizer class (very similar to the RowColSizer in the

 library) has been added to C++ and wrapped for wxPython.  It can also
 be used from XRC.
 
 You should not use AddWindow, AddSizer, AddSpacer (and similar for
 Insert, Prepend, and etc.) methods any longer.  Just use Add and the
 library) has been added to C++ and wrapped for wxPython.  It can also
 be used from XRC.
 
 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.
+wrappers will figure out what to do.  **[Changed in 2.5.1.6]**
+AddWindow, AddSize, AddSpacer and etc. will now issue a
+DeprecationWarning. 
+
+**[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
+GetMinSize and/or GetBestSize will be called when calculating layout
+and the return value from that will be used for the minimum size.  The
+wx.FIXED_MINSIZE flag was added that will cause the sizer to *not*
+call window methods to determine the new best size, instead the
+minsize that the window had when added to the sizer (or the size the
+window was created with) will always be used.  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.  If you
+would like the sizer to use something other than the window's initial
+size as the minimum then you can give it a new minimum by calling its
+SetSizeHints method.
+

 
 
 PlatformInfo
 
 
 PlatformInfo


@@ -480,7 +502,7 @@ class with real methods and properties that do the Right Thing to
 reflect those calls to the real ActiveX control.  There is also a
 script/tool module named genaxmodule that given a CLSID or progID and
 a class name, will generate the module for you.  There are a few
 reflect those calls to the real ActiveX control.  There is also a
 script/tool module named genaxmodule that given a CLSID or progID and
 a class name, will generate the module for you.  There are a few

-examples of the output of this tool in the wx.lib package.  See
+examples of the output of this tool in the wx.lib package, see

 iewin.py, pdfwin.py and flashwin.py.
 
 Currently the genaxmodule tool will tweak some of the names it
 iewin.py, pdfwin.py and flashwin.py.
 
 Currently the genaxmodule tool will tweak some of the names it


@@ -501,7 +523,7 @@ method as required, but MSDN says it is optional.
 It is intended that this new wx.activex module will replace both the
 older version of Lindsay's code available in iewin.IEHtmlWindow, and
 also the wx.lib.activexwraper module.  Probably the biggest
 It is intended that this new wx.activex module will replace both the
 older version of Lindsay's code available in iewin.IEHtmlWindow, and
 also the wx.lib.activexwraper module.  Probably the biggest

-differences you'l ecounted in migrating activexwrapper-based code
+differences you'll ecounter in migrating activexwrapper-based code

 (besides events working better without causing deadlocks) is that
 events are no longer caught by overriding methods in your derived
 class.  Instead ActiveXWindow uses the wx event system and you bind
 (besides events working better without causing deadlocks) is that
 events are no longer caught by overriding methods in your derived
 class.  Instead ActiveXWindow uses the wx event system and you bind


@@ -525,16 +547,22 @@ attributes of the event object passed to the handler.  (Can you say
 'event' any more times in a single sentence? ;-) ) For example the
 StatusTextChange event will also send the text that should be put into
 the status line as an event parameter named "Text" and you can access
 'event' any more times in a single sentence? ;-) ) For example the
 StatusTextChange event will also send the text that should be put into
 the status line as an event parameter named "Text" and you can access

-it your handlers as an attribute of the evnt object like this::
+it your handlers as an attribute of the event object like this::

 
     def UpdateStatusText(self, evt):
         self.SetStatusText(evt.Text)
 
 
     def UpdateStatusText(self, evt):
         self.SetStatusText(evt.Text)
 

-These event object attributes should be considered read-only since
-support for output parameters on the events is not yet implemented.
-But that could/should change in the future.
+Usually these event object attributes should be considered read-only,
+but some will be defined by the TypeInfo as output parameters.  In
+those cases if you modify the event object's attribute then that value
+will be returned to the ActiveX control.  For example, to prevent a
+new window from being opened by the IE web browser control you can do
+this in the handler for the iewin.EVT_NewWindow2 event::
+
+    def OnNewWindow2(self, evt):
+        evt.Cancel = True   

 
 

-So how do you know what methods, events and properties that am ActiveX
+So how do you know what methods, events and properties that an ActiveX

 control supports?  There is a funciton in wx.activex named GetAXInfo
 that returns a printable summary of the TypeInfo from the ActiveX
 instance passed in.  You can use this as an example of how to browse
 control supports?  There is a funciton in wx.activex named GetAXInfo
 that returns a printable summary of the TypeInfo from the ActiveX
 instance passed in.  You can use this as an example of how to browse


@@ -545,8 +573,8 @@ provided by the makers of the ActiveX control that you are using.
 
 
 
 
 
 

-Other Stuff
------------
+Obsolete Modules
+----------------

 
 Instead of over a dozen separate extension modules linked together
 into a single extension module, the "core" module is now just a few
 
 Instead of over a dozen separate extension modules linked together
 into a single extension module, the "core" module is now just a few


@@ -555,11 +583,52 @@ later into the main namespace via Python code.
 
 Because of the above and also because of the way the new SWIG works,
 the "internal" module names have changed, but you shouldn't have been
 
 Because of the above and also because of the way the new SWIG works,
 the "internal" module names have changed, but you shouldn't have been

-using them anyway so it shouldn't bother you. ;-)
+using them anyway so it shouldn't bother you. ;-) In case you were
+erroneously using them in 2.4, here are the internal extension modules
+no longer exist:
+
+    * clip_dnd
+    * cmndlgs
+    * controls
+    * controls2
+    * events
+    * filesys
+    * fonts
+    * frames
+    * gdi
+    * image
+    * mdi
+    * misc
+    * misc2
+    * printfw
+    * sizers
+    * stattool
+    * streams
+    * utils
+    * windows
+    * windows2
+    * windows3
+
+They have been replaced by the following, but please remember that
+these are just "implementation details" and you should really be using
+the objects in these modules only via the wx or wxPython.wx packages:
+
+    * _core
+    * _gdi
+    * _windows
+    * _controls
+    * _misc
+

 
 The help module no longer exists and the classes therein are now part
 of the core module imported with wxPython.wx or the wx package.
 
 
 The help module no longer exists and the classes therein are now part
 of the core module imported with wxPython.wx or the wx package.
 

+
+
+
+Other Stuff
+-----------
+

 wxPyDefaultPosition and wxPyDefaultSize are gone.  Use the
 wxDefaultPosition and wxDefaultSize objects instead.
 
 wxPyDefaultPosition and wxPyDefaultSize are gone.  Use the
 wxDefaultPosition and wxDefaultSize objects instead.
 


@@ -567,6 +636,15 @@ 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.GetFirstChild 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


@@ -585,22 +663,42 @@ there are compatibility aliases for much of the above items.
 The wxWave class has been renamed to wxSound, and now has a slightly
 different API.
 
 The wxWave class has been renamed to wxSound, and now has a slightly
 different API.
 

-wx.TaskbarIcon works on wxGTK-based platforms now, however you have to
-manage it a little bit more than you did before.  Basically, the app
-will treat it like a top-level frame in that if the wx.TaskBarIcon
-still exists when all the frames are closed then the app will still
-not exit.  You need to ensure that the wx.TaskBarIcon is destroyed
-when your last Frame is closed.  For wxPython apps it is usually
-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.
-
-If you are embedding wxPython in a C++ app, or are writing wxPython
-compatible extensions modules, then the usage of wxPyBeginAllowThreads
-and wxPyEndAllowThreads has changed slightly.  wxPyBeginAllowThreads
-now returns a boolean value that must be passed to the coresponding
-wxPyEndAllowThreads function call.  This is to help do the RightThing
-when calls to these two functions are nested, or if calls to external
-code that are wrapped in the standard Py_(BEGIN|END)_ALLOW_THERADS may
-result in wx event handlers being called (such as os.startfile.)
-
+wx.TaskbarIcon works on wxGTK-based platforms (for some window
+managers,) however you have to manage it a little bit more than you
+did before.  Basically, the app will treat it like a top-level frame
+in that if the wx.TaskBarIcon still exists when all the frames are
+closed then the app will still not exit.  You need to ensure that the
+wx.TaskBarIcon is destroyed when your last Frame is closed.  For
+wxPython apps it is usually 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.
+
+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.DrawLine 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.
+
+**[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.
+
+**[Changed in 2.5.1.6]** wx.MaskColour constructor has been deprecated
+and will raise a DeprecationWarning if used.  The main wx.Mask
+constructor has been modified to be compatible with wx.MaskColour so
+you should use it instead.