Added __nonzero__ for wxTraskBarIcon

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

diff --git a/wxPython/docs/MigrationGuide.html b/wxPython/docs/MigrationGuide.html
index b25cd127e80c6572efbf6bcd35641a716dd63f80..d994425d470515494c0f487dc16c0c95dfc7b402 100644 (file)
--- a/wxPython/docs/MigrationGuide.html
+++ b/wxPython/docs/MigrationGuide.html
@@ -15,6 +15,16 @@
 those changes.  Be sure to also check in the CHANGES.txt file like
 usual to see info about the not so major changes and other things that
 have been added to wxPython.</p>
 those changes.  Be sure to also check in the CHANGES.txt 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
+<strong>wxWidgets</strong>.  Please see <a class="reference" href="http://lists.wxwidgets.org/cgi-bin/ezmlm-cgi?13:mss:3:200402:eebaopdhchfoagmnideo">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
+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>
 <p>The import-startup-bootstrap process employed by wxPython was changed
 <div class="section" id="module-initialization">
 <h1><a name="module-initialization">Module Initialization</a></h1>
 <p>The import-startup-bootstrap process employed by wxPython was changed


@@ -31,7 +41,7 @@ potential problems are that the C++ side of the &quot;stock-objects&quot;
 (wx.BLUE_PEN, wx.TheColourDatabase, etc.) are not initialized until
 the wx.App object is created, so you should not use them until after
 you have created your wx.App object.  If you do then an exception will
 (wx.BLUE_PEN, wx.TheColourDatabase, etc.) are not initialized until
 the wx.App object is created, so you should not use them until after
 you have created your wx.App object.  If you do then an exception will

-be raised telling you that the C++ object has not bene initialized
+be raised telling you that the C++ object has not been initialized

 yet.</p>
 <p>Also, you will probably not be able to do any kind of GUI or bitmap
 operation unless you first have created an app object, (even on
 yet.</p>
 <p>Also, you will probably not be able to do any kind of GUI or bitmap
 operation unless you first have created an app object, (even on


@@ -100,10 +110,30 @@ def Bind(self, event, handler, source=None, id=wxID_ANY, id2=wxID_ANY):
 <pre class="literal-block">
 self.Bind(wx.EVT_SIZE,   self.OnSize)
 self.Bind(wx.EVT_BUTTON, self.OnButtonClick, theButton)
 <pre class="literal-block">
 self.Bind(wx.EVT_SIZE,   self.OnSize)
 self.Bind(wx.EVT_BUTTON, self.OnButtonClick, theButton)

-self.Bind(wx.EVT_MENU,   self.OnExit, id=ID_EXIT)
+self.Bind(wx.EVT_MENU,   self.OnExit, id=wx.ID_EXIT)
+</pre>
+<p>The wx.Menu methods that add items to a wx.Menu have been modified
+such that they return a reference to the wx.MenuItem that was created.
+Additionally menu items and toolbar items have been modified to
+automatically generate a new ID if -1 is given, similar to using -1
+with window classess.  This means that you can create menu or toolbar
+items and event bindings without having to predefine a unique menu ID,
+although you still can use IDs just like before if you want.  For
+example, these are all equivallent other than their specific ID
+values:</p>
+<pre class="literal-block">
+1.
+  item = menu.Append(-1, &quot;E&amp;xit&quot;, &quot;Terminate the App&quot;)
+  self.Bind(wx.EVT_MENU, self.OnExit, item)
+
+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. 
+  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>
 </pre>

-<p>I hope to be able to remove the need for using IDs even for menu
-events too...</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


@@ -174,12 +204,9 @@ app.MainLoop()
 <p>You shouldn't need to migrate all your modules over to use the new
 package and names right away as there are modules in place that try to
 provide as much backwards compatibility of the names as possible.  If
 <p>You shouldn't need to migrate all your modules over to use the new
 package and names right away as there are modules in place that try to
 provide as much backwards compatibility of the names as possible.  If

-you rewrote the above sample using &quot;from wxPython.wx import <a href="#id1" name="id2"><span class="problematic" id="id2">*</span></a>&quot;, the
+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>
 old wxNames, and the old style of event binding it will still work
 just fine.</p>

-<div class="system-message" id="id1">
-<p class="system-message-title">System Message: <a name="id1">WARNING/2</a> (<tt>MigrationGuide.txt</tt>, line 189); <em><a href="#id2">backlink</a></em></p>
-Inline emphasis start-string without end-string.</div>

 </div>
 <div class="section" id="new-wx-dc-methods">
 <h1><a name="new-wx-dc-methods">New wx.DC Methods</a></h1>
 </div>
 <div class="section" id="new-wx-dc-methods">
 <h1><a name="new-wx-dc-methods">New wx.DC Methods</a></h1>


@@ -258,18 +285,19 @@ BlitXY(xdest, ydest, width, height, sourceDC, xsrc, ysrc,
 Blit(destPt, size, sourceDC, srcPt,
      rop = wxCOPY, useMask = FALSE, srcPtMask = wx.DefaultPosition)
 
 Blit(destPt, size, sourceDC, srcPt,
      rop = wxCOPY, useMask = FALSE, srcPtMask = wx.DefaultPosition)
 

-SetClippingRegionXY SetClippingRegion(x, y, width, height)
+SetClippingRegionXY(x, y, width, height)

 SetClippingRegion(point, size)
 SetClippingRect(rect)
 SetClippingRegionAsRegion(region);
 </pre>
 SetClippingRegion(point, size)
 SetClippingRect(rect)
 SetClippingRegionAsRegion(region);
 </pre>

-<p>If you have code that draws on a DC you <strong>will</strong> get errors because of
-these changes, but it should be easy to fix the code.  You can either
-change the name of the <em>Type B</em> 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
-<em>Type A</em> method.  For example, if you had this code before:</p>
+<p>If you have code that draws on a DC and you are using the new wx
+namespace then you <strong>will</strong> get errors because of these changes, but
+it should be easy to fix the code.  You can either change the name of
+the <em>Type B</em> 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 <em>Type A</em>
+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>


@@ -287,6 +315,14 @@ dc.DrawRectangle(p.x, p.y, s.width, s.height)
 <pre class="literal-block">
 dc.DrawRectangle(p, s)
 </pre>
 <pre class="literal-block">
 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;
+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.</p>

 </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>
 <div class="section" id="building-extending-and-embedding-wxpython">
 <h1><a name="building-extending-and-embedding-wxpython">Building, Extending and Embedding wxPython</a></h1>


@@ -323,10 +359,9 @@ class MyDialog(wx.Dialog):
 </div>
 <div class="section" id="sizers">
 <h1><a name="sizers">Sizers</a></h1>
 </div>
 <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 then you will need to use the &quot;proportion&quot; name instead of
-&quot;option&quot;.</p>
+<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
 2-integer sequence instead of separate width and height parameters.</p>
 <p>The wxGridBagSizer class (very similar to the RowColSizer in the
 <p>When adding a spacer to a sizer you now need to use a wxSize or a
 2-integer sequence instead of separate width and height parameters.</p>
 <p>The wxGridBagSizer class (very similar to the RowColSizer in the


@@ -342,12 +377,11 @@ wrappers will figure out what to do.</p>
 into a single extension module, the &quot;core&quot; module is now just a few
 extensions that are linked independently, and then merged together
 later into the main namespace via Python code.</p>
 into a single extension module, the &quot;core&quot; module is now just a few
 extensions that are linked independently, and then merged together
 later into the main namespace via Python code.</p>

-<p>Because of the above, the &quot;internal&quot; module names have changed, but
-you shouldn't have been using them anyway so it shouldn't bother
-you. ;-)</p>
-<p>The wxPython.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>
+<p>Because of the above and also because of the way the new SWIG works,
+the &quot;internal&quot; module names have changed, but you shouldn't have been
+using them anyway so it shouldn't bother you. ;-)</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>

 <p>wxPyDefaultPosition and wxPyDefaultSize are gone.  Use the
 wxDefaultPosition and wxDefaultSize objects instead.</p>
 <p>Similarly, the wxSystemSettings backwards compatibiility aliases for
 <p>wxPyDefaultPosition and wxPyDefaultSize are gone.  Use the
 wxDefaultPosition and wxDefaultSize objects instead.</p>
 <p>Similarly, the wxSystemSettings backwards compatibiility aliases for


@@ -362,13 +396,15 @@ refreshed.</p>
 <p>wxPyTypeCast has been removed.  Since we've had the OOR (Original
 Object Return) for a couple years now there should be no need to use
 wxPyTypeCast at all.</p>
 <p>wxPyTypeCast has been removed.  Since we've had the OOR (Original
 Object Return) for a couple years now there should be no need to use
 wxPyTypeCast at all.</p>

+<p>If you use the old wxPython package and wxPython.wx namespace then
+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>

 </div>
 </div>
 <hr class="footer" />
 <div class="footer">
 </div>
 </div>
 <hr class="footer" />
 <div class="footer">

-<a class="reference" href="MigrationGuide.txt">View document source</a>.
-Generated on: 2003-12-18 18:35 UTC.
-Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
+Generated on: 2004-02-27 23:30 UTC.

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