]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/docs/MigrationGuide.txt
Automatically disable wxDialupManager for wxMac and wxCocoa,
[wxWidgets.git] / wxPython / docs / MigrationGuide.txt
index 572324daced77067bbd6b9833b095d669c17b359..0ade0dcccfa1eb987b0c00605c529f522d8c4101 100644 (file)
@@ -403,7 +403,7 @@ Sizers
 ------
 
 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.)
 
@@ -441,14 +441,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.
 
-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
-      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.
 
@@ -669,8 +669,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.
-(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
@@ -786,6 +784,7 @@ 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.
 
 
+
 wx.TaskBarIcon
 --------------
 
@@ -821,9 +820,76 @@ 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
+----------------------
+
+**[Changed in 2.5.3.x]** 
 
-Other Stuff
------------
+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.