reSWIGged

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

diff --git a/wxPython/docs/MigrationGuide.html b/wxPython/docs/MigrationGuide.html
index c2e13cbea716bc85a28ab4dcdc034ed2c1c4ac4e..db71c5bcf70a6f3bca573ff51a292a2aed526de8 100644 (file)
--- a/wxPython/docs/MigrationGuide.html
+++ b/wxPython/docs/MigrationGuide.html
@@ -12,13 +12,13 @@
 <h1 class="title">wxPython 2.5 Migration Guide</h1>
 <p>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
 <h1 class="title">wxPython 2.5 Migration Guide</h1>
 <p>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 <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>
 <p>The <strong>wxWindows</strong> project and library is now known as
 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>
 <p>The <strong>wxWindows</strong> project and library is now known as

-<strong>wxWidgets</strong>.  Please see <a class="reference" href="http://www.wxwindows.org/name.htm">here</a> for more details.</p>
+<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
 that the wxwindows.org domain name will be changing to wxwidgets.org,
 so mail list, CVS, and etc. addresses will be changing.  We're going
 <p>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,
 so mail list, CVS, and etc. addresses will be changing.  We're going


@@ -78,7 +78,7 @@ need to change it to isinstance(obj, wxFoo).</p>
 <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
 <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

-flexibility.</p>
+flexibility that I expect to take advantave of in the future.</p>

 <p>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
 definition and docstring:</p>
 <p>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
 definition and docstring:</p>


@@ -137,7 +137,7 @@ values:</p>
 <p>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
 <p>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:</p>
+function.  For example, if you used to have something like this:</p>

 <pre class="literal-block">
 myCustomEventType = wxNewEventType()
 def EVT_MY_CUSTOM_EVENT(win, id, func):
 <pre class="literal-block">
 myCustomEventType = wxNewEventType()
 def EVT_MY_CUSTOM_EVENT(win, id, func):


@@ -301,13 +301,13 @@ method.  For example, if you had this code before:</p>
 <pre class="literal-block">
 dc.DrawRectangle(x, y, width, height)
 </pre>
 <pre class="literal-block">
 dc.DrawRectangle(x, y, width, height)
 </pre>

-<p>You could either continue to use the <em>Type B</em> method bu changing the
-name to DrawRectabgleXY, or just change it to the new <em>Type A</em> by
+<p>You could either continue to use the <em>Type B</em> method by changing the
+name to DrawRectangleXY, or just change it to the new <em>Type A</em> by

 adding some parentheses like this:</p>
 <pre class="literal-block">
 dc.DrawRectangle((x, y), (width, height))
 </pre>
 adding some parentheses like this:</p>
 <pre class="literal-block">
 dc.DrawRectangle((x, y), (width, height))
 </pre>

-<p>Or if you were already using a point and size:</p>
+<p>Or if you were already using a point and size like this:</p>

 <pre class="literal-block">
 dc.DrawRectangle(p.x, p.y, s.width, s.height)
 </pre>
 <pre class="literal-block">
 dc.DrawRectangle(p.x, p.y, s.width, s.height)
 </pre>


@@ -316,7 +316,7 @@ dc.DrawRectangle(p.x, p.y, s.width, s.height)
 dc.DrawRectangle(p, s)
 </pre>
 <p>Now before you start yelling and screaming at me for breaking all your
 dc.DrawRectangle(p, s)
 </pre>
 <p>Now before you start yelling and screaming at me for breaking all your

-code, take note that I said above &quot;...using the new wx namespace...&quot;
+code, take note that up above I said, &quot;...using the new wx namespace...&quot;

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


@@ -330,16 +330,39 @@ before that time.</p>
 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!]]</p>
+libraries in addition to the main wx lib.</p>

 <p>The wxPython.h and other header files are now in
 <p>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 &quot;wx/wxPython/wxPython.h&quot; path and add
-.../wxPython/include to your list of include paths.  [[TODO:  Install
-these headers on Linux...]]</p>
+.../wxPython/include/wx/wxPython instead of in wxPython/src.  You
+should include it via the &quot;wx/wxPython/wxPython.h&quot; 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.</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
+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.</p>
+<p>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 <tt class="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>
 <p>You no longer need to call wxClassInfo::CleanUpClasses() and
 wxClassInfo::InitializeClasses() in your extensions or when embedding
 wxPython.</p>

+<p>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.)</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>
 <div class="section" id="two-or-three-phase-create">
 <h1><a name="two-or-three-phase-create">Two (or Three!) Phase Create</a></h1>


@@ -360,11 +383,11 @@ class MyDialog(wx.Dialog):
 <div class="section" id="sizers">
 <h1><a name="sizers">Sizers</a></h1>
 <p>The hack allowing the old &quot;option&quot; keyword parameter has been removed.
 <div class="section" id="sizers">
 <h1><a name="sizers">Sizers</a></h1>
 <p>The hack allowing the old &quot;option&quot; keyword parameter has been removed.

-If you use keyworkd args with wxSizer Add, Insert, or Prepend methods
-then you will need to use the &quot;proportion&quot; name instead of &quot;option&quot;.</p>
-<p>When adding a spacer to a sizer you now need to use a wxSize or a
+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>.</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.</p>
 2-integer sequence instead of separate width and height parameters.</p>

-<p>The wxGridBagSizer class (very similar to the RowColSizer in the
+<p>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.</p>
 <p>You should not use AddWindow, AddSizer, AddSpacer (and similar for
 library) has been added to C++ and wrapped for wxPython.  It can also
 be used from XRC.</p>
 <p>You should not use AddWindow, AddSizer, AddSpacer (and similar for


@@ -485,7 +508,7 @@ this in the handler for the iewin.EVT_NewWindow2 event:</p>
 def OnNewWindow2(self, evt):
     evt.Cancel = True   
 </pre>
 def OnNewWindow2(self, evt):
     evt.Cancel = True   
 </pre>

-<p>So how do you know what methods, events and properties that am ActiveX
+<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
 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


@@ -532,25 +555,27 @@ 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>
 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>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 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.)</p>
-<p>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.</p>
-</div>
+<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
+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.DrawLineXY 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.</p>

 </div>
 </div>

-<hr class="footer" />
-<div class="footer">
-Generated on: 2004-03-26 21:09 UTC.

 </div>
 </body>
 </html>
 </div>
 </body>
 </html>