]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/docs/MigrationGuide.html
fixed deadlock when calling wxPostEvent() from worker thread
[wxWidgets.git] / wxPython / docs / MigrationGuide.html
index 3f50b7f2c801f54540491399545d598527ae4334..3360160522f11ae43b83c36bbe01699947521492 100644 (file)
@@ -3,20 +3,20 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-<meta name="generator" content="Docutils 0.3.1: http://docutils.sourceforge.net/" />
-<title>wxPython 2.5 Migration Guide</title>
+<meta name="generator" content="Docutils 0.4.1: http://docutils.sourceforge.net/" />
+<title>wxPython 2.6 Migration Guide</title>
 <link rel="stylesheet" href="default.css" type="text/css" />
 </head>
 <body>
-<div class="document" id="wxpython-2-5-migration-guide">
-<h1 class="title">wxPython 2.5 Migration Guide</h1>
+<div class="document" id="wxpython-2-6-migration-guide">
+<h1 class="title">wxPython 2.6 Migration Guide</h1>
 <p>This document will help explain some of the major changes in wxPython
-2.5 since the 2.4 series and let you know what you need to do to adapt
+2.6 since the 2.4 series and let you know what you need to do to adapt
 your programs to those changes.  Be sure to also check in the <a class="reference" href="CHANGES.html">CHANGES</a>
 file like usual to see info about the not so major changes and other
 things that have been added to wxPython.</p>
-<div class="section" id="wxname-change">
-<h1><a name="wxname-change">wxName Change</a></h1>
+<div class="section">
+<h1><a id="wxname-change" name="wxname-change">wxName Change</a></h1>
 <p>The <strong>wxWindows</strong> project and library is now known as
 <strong>wxWidgets</strong>.  Please see <a class="reference" href="http://www.wxwidgets.org/name.htm">here</a> for more details.</p>
 <p>This won't really affect wxPython all that much, other than the fact
@@ -25,8 +25,8 @@ so mail list, CVS, and etc. addresses have also changed.  We're going
 to try and smooth the transition as much as possible, but I wanted you
 all to be aware of this change if you run into any issues.</p>
 </div>
-<div class="section" id="module-initialization">
-<h1><a name="module-initialization">Module Initialization</a></h1>
+<div class="section">
+<h1><a id="module-initialization" name="module-initialization">Module Initialization</a></h1>
 <p>The import-startup-bootstrap process employed by wxPython was changed
 such that wxWidgets and the underlying gui toolkit are <strong>not</strong>
 initialized until the wx.App object is created (but before wx.App.OnInit
@@ -51,8 +51,8 @@ class constructors and also many toplevel functions and static methods
 will now check that a wx.App object has already been created and will
 raise a wx.PyNoAppError exception if not.</p>
 </div>
-<div class="section" id="swig-1-3">
-<h1><a name="swig-1-3">SWIG 1.3</a></h1>
+<div class="section">
+<h1><a id="swig-1-3" name="swig-1-3">SWIG 1.3</a></h1>
 <p>wxPython is now using SWIG 1.3.x from CVS (with several of my own
 customizations added that I hope to get folded back into the main SWIG
 distribution.)  This has some far reaching ramifications:</p>
@@ -79,8 +79,8 @@ class type using something like isinstance(obj, wx.FooPtr) you will
 need to change it to isinstance(obj, wx.Foo).</p>
 </blockquote>
 </div>
-<div class="section" id="binding-events">
-<h1><a name="binding-events">Binding Events</a></h1>
+<div class="section">
+<h1><a id="binding-events" name="binding-events">Binding Events</a></h1>
 <p>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
@@ -132,11 +132,11 @@ values:</p>
   item = menu.Append(-1, &quot;E&amp;xit&quot;, &quot;Terminate the App&quot;)
   self.Bind(wx.EVT_MENU, self.OnExit, item)
 
-2. 
+2.
   item = menu.Append(wx.ID_EXIT, &quot;E&amp;xit&quot;, &quot;Terminate the App&quot;)
   self.Bind(wx.EVT_MENU, self.OnExit, item)
 
-3. 
+3.
   menu.Append(wx.ID_EXIT, &quot;E&amp;xit&quot;, &quot;Terminate the App&quot;)
   self.Bind(wx.EVT_MENU, self.OnExit, id=wx.ID_EXIT)
 </pre>
@@ -167,8 +167,8 @@ def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
     &quot;&quot;&quot;
 </pre>
 </div>
-<div class="section" id="the-wx-namespace">
-<h1><a name="the-wx-namespace">The wx Namespace</a></h1>
+<div class="section">
+<h1><a id="the-wx-namespace" name="the-wx-namespace">The wx Namespace</a></h1>
 <p>The second phase of the wx Namespace Transition has begun.  That means
 that the real names of the classes and other symbols do not have the
 'wx' prefix and the modules are located in a Python package named
@@ -225,8 +225,8 @@ you rewrote the above sample using &quot;from wxPython.wx import * &quot;, the
 old wxNames, and the old style of event binding it will still work
 just fine.</p>
 </div>
-<div class="section" id="new-wx-dc-methods">
-<h1><a name="new-wx-dc-methods">New wx.DC Methods</a></h1>
+<div class="section">
+<h1><a id="new-wx-dc-methods" name="new-wx-dc-methods">New wx.DC Methods</a></h1>
 <p><strong>[Changed in 2.5.2.x]</strong> 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
@@ -240,7 +240,7 @@ FloodFill(self, x, y, colour, style = wx.FLOOD_SURFACE)
 FoodFillPoint(self, pt, colour, style = wx.FLOOD_SURFACE)
 
 GetPixel(self, x,y)
-GetPixelPoint(self, pt) 
+GetPixelPoint(self, pt)
 
 DrawLine(self, x1, y1, x2, y2)
 DrawLinePoint(self, pt1, pt2)
@@ -289,7 +289,7 @@ DrawRotatedTextPoint(self, text, pt, angle)
 
 bool Blit(self, xdest, ydest, width, height, sourceDC, xsrc, ysrc,
           rop = wx.COPY, useMask = False, xsrcMask = -1, ysrcMask = -1)
-BlitPointSize(self, destPt, sz, sourceDC, srcPt, rop = wx.COPY, 
+BlitPointSize(self, destPt, sz, sourceDC, srcPt, rop = wx.COPY,
               useMask = False, srcPtMask = wxDefaultPosition)
 
 
@@ -299,12 +299,12 @@ SetClippingRegionAsRegion(self, region)
 SetClippingRect(self, rect)
 </pre>
 </div>
-<div class="section" id="building-extending-and-embedding-wxpython">
-<h1><a name="building-extending-and-embedding-wxpython">Building, Extending and Embedding wxPython</a></h1>
+<div class="section">
+<h1><a id="building-extending-and-embedding-wxpython" name="building-extending-and-embedding-wxpython">Building, Extending and Embedding wxPython</a></h1>
 <p>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
+aware that you now need to also build the stc, xrc, animate and gizmos
 libraries in addition to the main wx lib.</p>
 <p>The wxPython.h and other header files are now in
 .../wxPython/include/wx/wxPython instead of in wxPython/src.  You
@@ -317,7 +317,7 @@ path should already be set properly.</p>
 <p>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
-<tt class="literal"><span class="pre">%import</span> <span class="pre">core.i</span></tt>, and possibly others if you need the definition of
+<tt class="docutils literal"><span class="pre">%import</span> <span class="pre">core.i</span></tt>, 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
@@ -326,7 +326,7 @@ headers in an i_files sibdirectory.  It should be enough to pass a
 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 <tt class="literal"><span class="pre">import</span> <span class="pre">wx.build.config</span></tt>.</p>
+scripts using <tt class="docutils literal"><span class="pre">import</span> <span class="pre">wx.build.config</span></tt>.</p>
 <p>You no longer need to call wxClassInfo::CleanUpClasses() and
 wxClassInfo::InitializeClasses() in your extensions or when embedding
 wxPython.</p>
@@ -339,8 +339,8 @@ 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.)</p>
 </div>
-<div class="section" id="two-or-three-phase-create">
-<h1><a name="two-or-three-phase-create">Two (or Three!) Phase Create</a></h1>
+<div class="section">
+<h1><a id="two-or-three-phase-create" name="two-or-three-phase-create">Two (or Three!) Phase Create</a></h1>
 <p>If you use the Precreate/Create method of instantiating a window, (for
 example, to set an extended style flag, or for XRC handlers) then
 there is now a new method named PostCreate to help with transplanting
@@ -355,12 +355,12 @@ class MyDialog(wx.Dialog):
         self.PostCreate(pre)
 </pre>
 </div>
-<div class="section" id="sizers">
-<h1><a name="sizers">Sizers</a></h1>
+<div class="section">
+<h1><a id="sizers" name="sizers">Sizers</a></h1>
 <p>The hack allowing the old &quot;option&quot; keyword parameter has been removed.
-If you use keyword args with w.xSizer Add, Insert, or Prepend methods
-then you will need to use the <tt class="literal"><span class="pre">proportion</span></tt> name instead of
-<tt class="literal"><span class="pre">option</span></tt>.  (The <tt class="literal"><span class="pre">proportion</span></tt> keyword was also allowed in 2.4.2.4.)</p>
+If you use keyword args with wx.Sizer Add, Insert, or Prepend methods
+then you will need to use the <tt class="docutils literal"><span class="pre">proportion</span></tt> name instead of
+<tt class="docutils literal"><span class="pre">option</span></tt>.  (The <tt class="docutils literal"><span class="pre">proportion</span></tt> keyword was also allowed in 2.4.2.4.)</p>
 <p>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 was optionally allowed in 2.4, but now it is required.  This
@@ -376,8 +376,11 @@ be used from XRC.</p>
 <p>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.  <strong>[Changed in 2.5.2.x]</strong>
-AddWindow, AddSize, AddSpacer and etc. will now issue a
-DeprecationWarning.</p>
+AddWindow, AddSizer, AddSpacer and etc. will now issue a
+DeprecationWarning. <strong>[Changed in 2.5.4.x]</strong> These methods have now
+been undeprecated at the request of Riaan Booysen, the Boa Constructor
+team lead.  They are now just simple compatibility aliases for Add,
+and etc.</p>
 <p><strong>[Changed in 2.5.2.x]</strong> The Sizers have had some fundamental internal
 changes in the 2.5.2.x release intended to make them do more of the
 &quot;Right Thing&quot; but also be as backwards compatible as possible.
@@ -388,41 +391,41 @@ First a bit about how things used to work:</p>
 to be its minimal size, and that size would always be used by
 default when calculating layout size and positions, and the
 sizer itself would keep track of that minimal size.</li>
-<li>If the window item was added with the <tt class="literal"><span class="pre">wx.ADJUST_MINSIZE</span></tt>
-flag then when layout was calculated the item's <tt class="literal"><span class="pre">GetBestSize</span></tt>
+<li>If the window item was added with the <tt class="docutils literal"><span class="pre">wx.ADJUST_MINSIZE</span></tt>
+flag then when layout was calculated the item's <tt class="docutils literal"><span class="pre">GetBestSize</span></tt>
 would be used to reset the minimal size that the sizer used.</li>
 </ul>
 </blockquote>
-<p>The main thrust of the new Sizer changes was to make behaviour like
-<tt class="literal"><span class="pre">wx.ADJUST_MINSIZE</span></tt> be the default, and also to push the tracking of
+<p>The main thrust of the new Sizer changes was to make behavior like
+<tt class="docutils literal"><span class="pre">wx.ADJUST_MINSIZE</span></tt> be the default, and also to push the tracking of
 the minimal size to the window itself (since it knows its own needs)
 instead of having the sizer take care of it.  Consequently these
 changes were made:</p>
 <blockquote>
 <ul class="simple">
-<li>The <tt class="literal"><span class="pre">wx.FIXED_MINSIZE</span></tt> flag was added to allow for the old
-behaviour.  When this flag is used the size a window has when
+<li>The <tt class="docutils literal"><span class="pre">wx.FIXED_MINSIZE</span></tt> flag was added to allow for the old
+behavior.  When this flag is used the size a window has when
 added to the sizer will be treated as its minimal size and it
 will not be readjusted on each layout.</li>
-<li>The min size stored in <tt class="literal"><span class="pre">wx.Window</span></tt> and settable with
-<tt class="literal"><span class="pre">SetSizeHints</span></tt> or <tt class="literal"><span class="pre">SetMinSize</span></tt> will by default be used by
+<li>The min size stored in <tt class="docutils literal"><span class="pre">wx.Window</span></tt> and settable with
+<tt class="docutils literal"><span class="pre">SetSizeHints</span></tt> or <tt class="docutils literal"><span class="pre">SetMinSize</span></tt> will by default be used by
 the sizer (if it was set) as the minimal size of the sizer item.
 If the min size was not set (or was only partially set) then the
 window's best size is fetched and it is used instead of (or
-blended with) the min size.  <tt class="literal"><span class="pre">wx.Window.GetBestFittingSize</span></tt>
+blended with) the min size.  <tt class="docutils literal"><span class="pre">wx.Window.GetBestFittingSize</span></tt>
 was added to facilitate getting the size to be used by the
 sizers.</li>
 <li>The best size of a window is cached so it doesn't need to
-recaculated on every layout.  <tt class="literal"><span class="pre">wx.Window.InvalidateBestSize</span></tt>
+recaculated on every layout.  <tt class="docutils literal"><span class="pre">wx.Window.InvalidateBestSize</span></tt>
 was added and should be called (usually just internally in
 control methods) whenever something is done that would make the
 best size change.</li>
 <li>All wxControls were changed to set the minsize to what is passed
 to the constructor or Create method, and also to set the real
 size of the control to the blending of the min size and best
-size.  <tt class="literal"><span class="pre">wx.Window.SetBestFittingSize</span></tt> was added to help with
+size.  <tt class="docutils literal"><span class="pre">wx.Window.SetBestFittingSize</span></tt> was added to help with
 this, although most controls don't need to call it directly
-because it is called indirectly via the <tt class="literal"><span class="pre">SetInitialSize</span></tt>
+because it is called indirectly via the <tt class="docutils literal"><span class="pre">SetInitialSize</span></tt>
 called in the base classes.</li>
 </ul>
 </blockquote>
@@ -438,40 +441,40 @@ but now the sizer will use the default size as the minimum rather than
 the size set later.  It is an easy fix though, just move the
 specification of the size to the constructor (assuming that SomeWidget
 will set its minsize there like the rest of the controls do) or call
-<tt class="literal"><span class="pre">SetMinSize</span></tt> instead of <tt class="literal"><span class="pre">SetSize</span></tt>.</p>
+<tt class="docutils literal"><span class="pre">SetMinSize</span></tt> instead of <tt class="docutils literal"><span class="pre">SetSize</span></tt>.</p>
 <p>In order to fit well with this new scheme of things, all wxControls or
 custom controls should do the following things.  (Depending on how
 they are used you may also want to do the same thing for non-control
 custom windows.)</p>
 <blockquote>
 <ul>
-<li><p class="first">Either override or inherit a meaningful <tt class="literal"><span class="pre">DoGetBestSize</span></tt> method
+<li><p class="first">Either override or inherit a meaningful <tt class="docutils literal"><span class="pre">DoGetBestSize</span></tt> method
 that calculates whatever size is &quot;best&quot; for the control.  Once
 that size is calculated then there should normally be a call to
-<tt class="literal"><span class="pre">CacheBestSize</span></tt> to save it for later use, unless for some
+<tt class="docutils literal"><span class="pre">CacheBestSize</span></tt> to save it for later use, unless for some
 reason you want the best size to be recalculated on every
 layout.</p>
-<p>Note: In order to successfully override <tt class="literal"><span class="pre">DoGetBestSize</span></tt> in
-Python the class needs to be derived from <tt class="literal"><span class="pre">wx.PyWindow</span></tt>,
-<tt class="literal"><span class="pre">wx.PyControl</span></tt>, or etc.  If your class instead derives from
+<p>Note: In order to successfully override <tt class="docutils literal"><span class="pre">DoGetBestSize</span></tt> in
+Python the class needs to be derived from <tt class="docutils literal"><span class="pre">wx.PyWindow</span></tt>,
+<tt class="docutils literal"><span class="pre">wx.PyControl</span></tt>, or etc.  If your class instead derives from
 one of the standard wx classes then just be sure that the min
 size gets explicitly set to what would have been the best size
 and things should work properly in almost all situations.</p>
 </li>
 <li><p class="first">Any method that changes the attributes of the control such that
-the best size will change should call <tt class="literal"><span class="pre">InvalidateBestSize</span></tt> so
+the best size will change should call <tt class="docutils literal"><span class="pre">InvalidateBestSize</span></tt> so
 it will be recalculated the next time it is needed.</p>
 </li>
 <li><p class="first">The control's constructor and/or Create method should ensure
 that the minsize is set to the size passed in, and that the
 control is sized to a blending of the min size and best size.
-This can be done by calling <tt class="literal"><span class="pre">SetBestFittingSize</span></tt>.</p>
+This can be done by calling <tt class="docutils literal"><span class="pre">SetBestFittingSize</span></tt>.</p>
 </li>
 </ul>
 </blockquote>
 </div>
-<div class="section" id="platforminfo">
-<h1><a name="platforminfo">PlatformInfo</a></h1>
+<div class="section">
+<h1><a id="platforminfo" name="platforminfo">PlatformInfo</a></h1>
 <p>Added wx.PlatformInfo which is a tuple containing strings that
 describe the platform and build options of wxPython.  This lets you
 know more about the build than just the __WXPORT__ value that
@@ -492,8 +495,8 @@ way.  If there are any other platform/toolkit/build flags that make
 sense to add to this tuple please let me know.</p>
 <p>BTW, wx.Platform will probably be deprecated in the future.</p>
 </div>
-<div class="section" id="activex">
-<h1><a name="activex">ActiveX</a></h1>
+<div class="section">
+<h1><a id="activex" name="activex">ActiveX</a></h1>
 <p>Lindsay Mathieson's newest <a class="reference" href="http://members.optusnet.com.au/~blackpaw1/wxactivex.html">wxActiveX</a> class has been wrapped into a new
 extension module called wx.activex.  It is very generic and dynamic
 and should allow hosting of arbitray ActiveX controls within your
@@ -582,7 +585,7 @@ new window from being opened by the IE web browser control you can do
 this in the handler for the iewin.EVT_NewWindow2 event:</p>
 <pre class="literal-block">
 def OnNewWindow2(self, evt):
-    evt.Cancel = True   
+    evt.Cancel = True
 </pre>
 <p>So how do you know what methods, events and properties that an ActiveX
 control supports?  There is a funciton in wx.activex named GetAXInfo
@@ -593,8 +596,8 @@ output appended as a comment to the modules produced by the
 genaxmodule tool.  Beyond that you'll need to consult the docs
 provided by the makers of the ActiveX control that you are using.</p>
 </div>
-<div class="section" id="png-images">
-<h1><a name="png-images">PNG Images</a></h1>
+<div class="section">
+<h1><a id="png-images" name="png-images">PNG Images</a></h1>
 <p>Prior to 2.5 the PNG image handler would convert all alpha channel
 information to a mask when the image was loaded.  Pixels that were
 more than halfway transparent would be made fully transparent by the
@@ -603,9 +606,7 @@ mask and the rest would be made fully opaque.</p>
 channel and will now only create a mask when all the pixels in the
 image are either fully transparent or fully opaque.  In addition, the
 wx.DC.DrawBitmap and wx.DC.Blit methods are able to correctly blend
-the pixels in the image with partially transparent alpha values.
-(Currently only on MSW and Mac, if anybody knows how to do it for GTK
-then please submit a patch!)</p>
+the pixels in the image with partially transparent alpha values.</p>
 <p>If you are using a PNG with an alpha channel but you need to have a
 wx.Mask like you automatically got in 2.4 then you can do one of the
 following:</p>
@@ -618,17 +619,20 @@ fully transparent.</li>
 </ul>
 </blockquote>
 </div>
-<div class="section" id="ogl-is-dead-long-live-ogl">
-<h1><a name="ogl-is-dead-long-live-ogl">OGL is dead! LONG LIVE OGL!</a></h1>
+<div class="section">
+<h1><a id="ogl-is-dead-long-live-ogl" name="ogl-is-dead-long-live-ogl">OGL is dead! LONG LIVE OGL!</a></h1>
 <p><strong>[Changed in 2.5.2.x]</strong></p>
-<p>The wx.ogl module has been deprecated in favor of the new Python port
-of the OGL library located at wx.lib.ogl contributed by Pierre Hjälm.
-This will hopefully greatly extend the life of OGL within wxPython by
-making it more easily maintainable and less prone to getting rusty as
-there seems to be less and less interest in maintaining the C++
-version.</p>
+<p>The wx.ogl module was deprecated in version 2.5.2 in favor of the new
+Python port of the OGL library located at wx.lib.ogl contributed by
+Pierre Hjälm.  Starting in version 2.5.5 the old ogl is no longer
+being built in the distributed binaries, however the source code is
+still in the source tree so people can built it themselves if desired.</p>
+<p>The reason this changes was done was to greatly extend the life of OGL
+within wxPython by making it more easily maintainable and less prone
+to getting rusty as there seems to be less and less interest in
+maintaining the C++ version.</p>
 <p>There are only a few known compatibility issues at this time.  First
-is the location of OGL.  The deprecated version is located in the
+is the location of OGL.  The old version was located in the
 wx.ogl module, and the new version is in the wx.lib.ogl package.  So
 this just means that to start using the new version you need to adjust
 your imports.  So if your code currently has something like this:</p>
@@ -660,11 +664,11 @@ class MyDividedShape(ogl.DividedShape):
     ...
     def OnSizingEndDragLeft(self, pt, x, y, keys, attch):
         ogl.DividedShape.OnSizingEndDragLeft(self, pt, x, y, keys, attch)
-        ...    
+        ...
 </pre>
 </div>
-<div class="section" id="obsolete-modules">
-<h1><a name="obsolete-modules">Obsolete Modules</a></h1>
+<div class="section">
+<h1><a id="obsolete-modules" name="obsolete-modules">Obsolete Modules</a></h1>
 <p>Instead of over a dozen separate extension modules linked together
 into a single extension module, the &quot;core&quot; module is now just a few
 extensions that are linked independently, and then merged together
@@ -673,7 +677,7 @@ later into the main namespace via Python code.</p>
 the &quot;internal&quot; module names have changed, but you shouldn't have been
 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:</p>
+that no longer exist:</p>
 <blockquote>
 <ul class="simple">
 <li>clip_dnd</li>
@@ -714,8 +718,93 @@ the objects in these modules only via the wx or wxPython.wx packages:</p>
 <p>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.</p>
 </div>
-<div class="section" id="other-stuff">
-<h1><a name="other-stuff">Other Stuff</a></h1>
+<div class="section">
+<h1><a id="wx-taskbaricon" name="wx-taskbaricon">wx.TaskBarIcon</a></h1>
+<p><strong>[Changed in 2.5.3.x]</strong></p>
+<p>wx.TaskbarIcon now works on all three platforms, although for wxGTK it
+depends on support from the Window Manager.  On OS X the icon replaces
+the application's icon on the dock and when you right click on it the
+app's default popup menu is merged with the wx.TaskBarIcon's menu.
+Because of how it is implemented on the Mac using the Dock most of the
+TaskBarIcon events will _not_ be emitted on that platform, but since
+98% of the time you simply want to display an icon and have a popup
+menu it shouldn't be much of a problem.  You can still use the other
+events on the other platforms, you'll just want to be sure that you
+can do everything you want via the menu too.</p>
+<p>Since popping up a menu is the most common thing to do with a
+TaskBarIcon the class has some new built in functionality to
+facilitate that.  To use the TaskBarIcon in this new way, simply
+derive a new class from TaskBarIcon and implement a CreatePopupMenu
+method that creates and returns the menu.  That's all there is to it,
+besides binding event handlers for the menu items of course.  Take a
+look at the DemoTaskBarIcon class in the demo/Main.py module for an
+example.</p>
+<p><strong>NOTE</strong>:  Unfortunately due to being able to support virtualizing
+CreatePopupMenu the C++ TaskBarIcon instance now holds a reference to
+the Python instance, and so you will need to explicitly Destroy() your
+TaskBarIcon instance when you are done with it.  (Like you do with
+wx.Dialogs.)  If you don't destroy it then wxWidgets will assume that
+you want the app to keep running with just the icon in the task bar
+and the MainLoop will not exit.</p>
+</div>
+<div class="section">
+<h1><a id="version-number-change" name="version-number-change">Version Number Change</a></h1>
+<p><strong>[Changed in 2.5.3.x]</strong></p>
+<p>Starting with 2.5.3.0 the Unicode versions of wxPython will no longer
+have a 'u' appended to the fourth component of the version number.
+Please check for the presence of &quot;unicode&quot; in the <cite>wx.PlatformInfo</cite>
+tuple instead.  (This tuple of strings has been available since the
+first 2.5 version.) For example:</p>
+<pre class="literal-block">
+if &quot;unicode&quot; in wx.PlatformInfo:
+    # do whatever
+    ...
+</pre>
+</div>
+<div class="section">
+<h1><a id="multi-version-installs" name="multi-version-installs">Multi-Version Installs</a></h1>
+<p><strong>[Changed in 2.5.3.x]</strong></p>
+<p>Starting with 2.5.3.0 the wx and wxPython package directories will be
+installed in a subdirectory of the site-packages directory, instead of
+directly in site-packages.  This is done to help facilitate having
+multiple versions of wxPython installed side-by-side.  Why would you
+want to do this?  One possible scenario is you have an app that
+requires wxPython 2.4 but you want to use the newest 2.5 to do your
+own development with.  Or perhaps you want to be able to test your app
+with several different versions of wxPython to ensure compatibility.
+Before everyone panics, rest asured that if you only install one
+version of wxPython then you should notice no difference in how things
+work.</p>
+<p>In addition to installing wxPython into a &quot;versioned&quot; subdirectory of
+site-packages, a file named <cite>wx.pth</cite> is optionally installed that will
+contain the name of the versioned subdirectory.  This will cause that
+subdirectory to be automatically added to the sys.path and so doing an
+&quot;import wx&quot; will find the package in the subdirectory like it would
+have if it was still located directly in site-packages.  I say
+&quot;optionally&quot; above because that is how you can control which install
+of wxPython is the default one.  Which ever version installs the
+wx.pth file will be the one that is imported with a plain &quot;import wx&quot;
+statement.  Of course you can always manipulate that by editing the
+wx.pth file, or by setting PYTHONPATH in the environment, or by the
+method described in the next paragraph.</p>
+<p>Finally, a new module named wxversion.py is installed to the
+site-packages directory.  It can be used to manipulate the sys.path at
+runtime so your applications can select which version of wxPython they
+would like to to have imported.  You use it like this:</p>
+<pre class="literal-block">
+import wxversion
+wxversion.select(&quot;2.4&quot;)
+import wx
+</pre>
+<p>Then even though a 2.5 version of wxPython may be the default the
+application that does the above the first time that wx is imported
+will actually get a 2.4 version.  <strong>NOTE:</strong> There isn't actually a 2.4
+version of wxPython that supports this, but there will be.</p>
+<p>Please see this wiki page for more details, HowTo's and FAQ's:
+<a class="reference" href="http://wiki.wxpython.org/index.cgi/MultiVersionInstalls">http://wiki.wxpython.org/index.cgi/MultiVersionInstalls</a></p>
+</div>
+<div class="section">
+<h1><a id="miscellaneous-stuff" name="miscellaneous-stuff">Miscellaneous Stuff</a></h1>
 <p>wxPyDefaultPosition and wxPyDefaultSize are gone.  Use the
 wxDefaultPosition and wxDefaultSize objects instead.</p>
 <p>Similarly, the wxSystemSettings backwards compatibiility aliases for
@@ -741,15 +830,6 @@ wxPyTypeCast at all.</p>
 there are compatibility aliases for much of the above items.</p>
 <p>The wxWave class has been renamed to wxSound, and now has a slightly
 different API.</p>
-<p>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.</p>
 <p>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
@@ -777,6 +857,22 @@ for changes in capabilities, usage, etc.</p>
 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.</p>
+<p><strong>[Changed in 2.5.2.x]</strong> In wx.TextCtrls that have the
+wx.TE_PROCESS_TAB style the TAB key will be treated like an ordinary
+character and will not cause any tab traversal navigation at all.  If
+you use this style but would still like to have the normal tab
+traversal take place then you should send your own
+wx.NavigationKeyEvent from the wx.EVT_KEY_DOWN handler.  There is a
+new Navigate method in the wx.Window class to help send the event and
+it is used something like this:</p>
+<pre class="literal-block">
+flags = wx.NavigationKeyEvent.IsForward
+if event.ShiftDown():
+    flags = wx.NavigationKeyEvent.IsBackward
+if event.ControlDown():
+    flags |= wx.NavigationKeyEvent.WinChange
+self.Navigate(flags)
+</pre>
 </div>
 </div>
 </body>