Take out AdjustPagebreak for now...

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

diff --git a/wxPython/docs/MigrationGuide.txt b/wxPython/docs/MigrationGuide.txt
index 504513b6d9c283e001c8374f2d0d2a0b51675494..9dd3ca2c10bade2c30d3559351a9a8ede70eca58 100644 (file)
--- a/wxPython/docs/MigrationGuide.txt
+++ b/wxPython/docs/MigrationGuide.txt
@@ -1,9 +1,9 @@
 ============================
 ============================

-wxPython 2.5 Migration Guide
+wxPython 2.6 Migration Guide

 ============================
 
 This document will help explain some of the major changes in wxPython
 ============================
 
 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 CHANGES_
 file like usual to see info about the not so major changes and other
 things that have been added to wxPython.
 your programs to 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.


@@ -339,8 +339,8 @@ Building, Extending and Embedding wxPython
 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
 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
-libraries in addition to the main wx lib.  
+aware that you now need to also build the stc, xrc, animate and gizmos
+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
 
 The wxPython.h and other header files are now in
 .../wxPython/include/wx/wxPython instead of in wxPython/src.  You


@@ -403,7 +403,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 keyword args with w.xSizer Add, Insert, or Prepend methods
+If you use keyword args with wx.Sizer 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.)
 
 then you will need to use the ``proportion`` name instead of
 ``option``.  (The ``proportion`` keyword was also allowed in 2.4.2.4.)
 


@@ -424,8 +424,11 @@ 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.  **[Changed in 2.5.2.x]**
 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.  **[Changed in 2.5.2.x]**

-AddWindow, AddSize, AddSpacer and etc. will now issue a
-DeprecationWarning. 
+AddWindow, AddSizer, AddSpacer and etc. will now issue a
+DeprecationWarning. **[Changed in 2.5.4.x]** 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.

 
 **[Changed in 2.5.2.x]** The Sizers have had some fundamental internal
 changes in the 2.5.2.x release intended to make them do more of the
 
 **[Changed in 2.5.2.x]** The Sizers have had some fundamental internal
 changes in the 2.5.2.x release intended to make them do more of the


@@ -441,14 +444,14 @@ First a bit about how things used to work:
       flag then when layout was calculated the item's ``GetBestSize``
       would be used to reset the minimal size that the sizer used.
 
       flag then when layout was calculated the item's ``GetBestSize``
       would be used to reset the minimal size that the sizer used.
 

-The main thrust of the new Sizer changes was to make behaviour like
+The main thrust of the new Sizer changes was to make behavior like

 ``wx.ADJUST_MINSIZE`` 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:
 
     * The ``wx.FIXED_MINSIZE`` flag was added to allow for the old
 ``wx.ADJUST_MINSIZE`` 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:
 
     * The ``wx.FIXED_MINSIZE`` flag was added to allow for the old

-      behaviour.  When this flag is used the size a window has when
+      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.
 
       added to the sizer will be treated as its minimal size and it
       will not be readjusted on each layout.
 


@@ -669,8 +672,6 @@ 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.
 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!)

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


@@ -690,19 +691,22 @@ OGL is dead! LONG LIVE OGL!
 
 **[Changed in 2.5.2.x]** 
 
 
 **[Changed in 2.5.2.x]** 
 

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

 
 There are only a few known compatibility issues at this time.  First
 
 There are only a few known compatibility issues at this time.  First

-is that the ogl.DrawnShape has not been reimplemented yet.  Next is the
-location of OGL.  The deprecated version is 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::
+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::

 
      import wx
      import wx.ogl as ogl
 
      import wx
      import wx.ogl as ogl


@@ -747,7 +751,7 @@ 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. ;-) In case you were
 erroneously using them in 2.4, here are the internal extension modules
 the "internal" 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:
+that no longer exist:

 
     * clip_dnd
     * cmndlgs
 
     * clip_dnd
     * cmndlgs


@@ -787,9 +791,111 @@ of the core module imported with wxPython.wx or the wx package.
 
 
 
 
 
 

+wx.TaskBarIcon
+--------------
+
+**[Changed in 2.5.3.x]** 
+
+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.
+
+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.
+
+**NOTE**:  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.
+
+
+
+Version Number Change
+---------------------
+
+**[Changed in 2.5.3.x]** 
+
+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 "unicode" in the `wx.PlatformInfo`
+tuple instead.  (This tuple of strings has been available since the
+first 2.5 version.) For example::
+
+     if "unicode" in wx.PlatformInfo:
+         # do whatever
+        ...
+
+
+
+
+Multi-Version Installs
+----------------------

 
 

-Other Stuff
------------
+**[Changed in 2.5.3.x]** 
+
+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.
+
+In addition to installing wxPython into a "versioned" subdirectory of
+site-packages, a file named `wx.pth` 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
+"import wx" will find the package in the subdirectory like it would
+have if it was still located directly in site-packages.  I say
+"optionally" 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 "import wx"
+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.
+
+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::
+
+      import wxversion
+      wxversion.select("2.4")
+      import wx
+
+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.  **NOTE:** There isn't actually a 2.4
+version of wxPython that supports this, but there will be.
+
+Please see this wiki page for more details, HowTo's and FAQ's:
+http://wiki.wxpython.org/index.cgi/MultiVersionInstalls
+
+
+
+
+Miscellaneous 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.


@@ -825,16 +931,6 @@ 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 (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
 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