]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/docs/MigrationGuide.html
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fixed OOR typo
[wxWidgets.git] / wxPython / docs / MigrationGuide.html
diff --git a/wxPython/docs/MigrationGuide.html b/wxPython/docs/MigrationGuide.html
index c7333c44b9c45d40590d9676e8248ce13f835d2b..0c01a56e5d86e29412bde865ba6ff841999a709d 100644 (file)
--- a/wxPython/docs/MigrationGuide.html
+++ b/wxPython/docs/MigrationGuide.html
@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<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>
 <link rel="stylesheet" href="default.css" type="text/css" />
 <meta name="generator" content="Docutils 0.3.1: http://docutils.sourceforge.net/" />
 <title>wxPython 2.5 Migration Guide</title>
 <link rel="stylesheet" href="default.css" type="text/css" />
@@ -15,10 +15,20 @@
 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://www.wxwindows.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
+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
-such that wxWindows and the underlying gui toolkit are <strong>not</strong>
+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
 is called.)  This was required because of some changes that were made
 to the C++ wxApp class.</p>
 initialized until the wx.App object is created (but before wx.App.OnInit
 is called.)  This was required because of some changes that were made
 to the C++ wxApp class.</p>
@@ -30,9 +40,9 @@ now be the GUI thread instead of the one that imports wxPython.  Some
 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
 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.  (In fact, until I find a better
-solution trying to use one of the stock objects before the app is
-created will probably result in a crash.)</p>
+you have created your wx.App object.  If you do then an exception will
+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
 Windows where most anything was possible before.)</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
 Windows where most anything was possible before.)</p>
@@ -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
@@ -115,8 +145,8 @@ def EVT_MY_CUSTOM_EVENT(win, id, func):
 </pre>
 <p>Change it like so:</p>
 <pre class="literal-block">
 </pre>
 <p>Change it like so:</p>
 <pre class="literal-block">
-myCustomEventType = wxNewEventType()
-EVT_MY_CUSTOM_EVENT = wxPyEventBinder(myCustomEventType, 1)
+myCustomEventType = wx.NewEventType()
+EVT_MY_CUSTOM_EVENT = wx.PyEventBinder(myCustomEventType, 1)
 </pre>
 <p>The second parameter is an integer in [0, 1, 2] that specifies the
 number of IDs that are needed to be passed to Connect.</p>
 </pre>
 <p>The second parameter is an integer in [0, 1, 2] that specifies the
 number of IDs that are needed to be passed to Connect.</p>
@@ -136,8 +166,8 @@ wxWindow = wx.core.Window
 </pre>
 <p>Don't let the &quot;core&quot; in the name bother you.  That and some other
 modules are implementation details, and everything that was in the
 </pre>
 <p>Don't let the &quot;core&quot; in the name bother you.  That and some other
 modules are implementation details, and everything that was in the
-wxPython.wx before will still be in the wx package namespace after
-this change.  So from your code you would use it as wx.Window.</p>
+wxPython.wx module before will still be in the wx package namespace
+after this change.  So from your code you would use it as wx.Window.</p>
 <p>A few notes about how all of this was accomplished might be
 interesting...  SWIG is now run twice for each module that it is
 generating code for.  The first time it outputs an XML representaion
 <p>A few notes about how all of this was accomplished might be
 interesting...  SWIG is now run twice for each module that it is
 generating code for.  The first time it outputs an XML representaion
@@ -151,6 +181,32 @@ uses the %rename directives that were generated in the first step.</p>
 <p>Not every name is handled correctly (but the bulk of them are) and so
 some work has to be done by hand, especially for the reverse-renamers.
 So expect a few flaws here and there until everything gets sorted out.</p>
 <p>Not every name is handled correctly (but the bulk of them are) and so
 some work has to be done by hand, especially for the reverse-renamers.
 So expect a few flaws here and there until everything gets sorted out.</p>
+<p>In summary, the wx package and names without the &quot;wx&quot; prefix are now
+the official form of the wxPython classes.  For example:</p>
+<pre class="literal-block">
+import wx
+
+class MyFrame(wx.Frame):
+    def __init__(self, parent, title):
+        wx.Frame.__init__(self, parent, -1, title)
+        p = wx.Panel(self, -1)
+        b = wx.Button(p, -1, &quot;Do It&quot;, (10,10))
+        self.Bind(wx.EVT_BUTTON, self.JustDoIt, b)
+
+    def JustDoIt(self, evt):
+        print &quot;It's done!&quot;
+
+app = wx.PySimpleApp()
+f = MyFrame(None, &quot;What's up?&quot;)
+f.Show()
+app.MainLoop()
+</pre>
+<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 * &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>
 <div class="section" id="new-wx-dc-methods">
 <h1><a name="new-wx-dc-methods">New wx.DC Methods</a></h1>
@@ -166,9 +222,9 @@ SetSize(size)               # Type A
 SetSizeWH(width, height)    # Type B
 </pre>
 <p>For various reasons the new <em>Type A</em> methods in wx.DC were never added
 SetSizeWH(width, height)    # Type B
 </pre>
 <p>For various reasons the new <em>Type A</em> methods in wx.DC were never added
-and the existing <em>Type B</em> methods renamed.  Now that lots of other
-things are also changing in wxPython that it has been decided that it
-is a good time to also do the method renaming in wx.DC too, in order
+and the existing <em>Type B</em> methods were never renamed.  Now that lots
+of other things are also changing in wxPython it has been decided that
+it is a good time to also do the method renaming in wx.DC too in order
 to be consistent with the rest of the library.  The methods in wx.DC
 that are affected are listed here:</p>
 <pre class="literal-block">
 to be consistent with the rest of the library.  The methods in wx.DC
 that are affected are listed here:</p>
 <pre class="literal-block">
@@ -228,18 +284,26 @@ BlitXY(xdest, ydest, width, height, sourceDC, xsrc, ysrc,
        rop = wxCOPY, useMask = FALSE, xsrcMask = -1, ysrcMask = -1)
 Blit(destPt, size, sourceDC, srcPt,
      rop = wxCOPY, useMask = FALSE, srcPtMask = wx.DefaultPosition)
        rop = wxCOPY, useMask = FALSE, xsrcMask = -1, ysrcMask = -1)
 Blit(destPt, size, sourceDC, srcPt,
      rop = wxCOPY, useMask = FALSE, srcPtMask = wx.DefaultPosition)
+
+SetClippingRegionXY(x, y, width, height)
+SetClippingRegion(point, size)
+SetClippingRect(rect)
+SetClippingRegionAsRegion(region);
 </pre>
 </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 as 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.  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>
-<p>You could just change it like this:</p>
+<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
+adding some parentheses like this:</p>
 <pre class="literal-block">
 dc.DrawRectangle((x, y), (width, height))
 </pre>
 <pre class="literal-block">
 dc.DrawRectangle((x, y), (width, height))
 </pre>
@@ -247,10 +311,18 @@ dc.DrawRectangle((x, y), (width, height))
 <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>
-<p>Then you can just change it like this:</p>
+<p>Then you can just simplify it like this:</p>
 <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>
@@ -269,16 +341,99 @@ these headers on Linux...]]</p>
 wxClassInfo::InitializeClasses() in your extensions or when embedding
 wxPython.</p>
 </div>
 wxClassInfo::InitializeClasses() in your extensions or when embedding
 wxPython.</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>
+<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
+the brain of the prewindow instance into the derived window instance.
+For example:</p>
+<pre class="literal-block">
+class MyDialog(wx.Dialog):
+    def __init__(self, parent, ID, title, pos, size, style):
+        pre = wx.PreDialog()
+        pre.SetExtraStyle(wx.DIALOG_EX_CONTEXTHELP)
+        pre.Create(parent, ID, title, pos, size, style)
+        self.PostCreate(pre)
+</pre>
+</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 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
+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
+Insert, Prepend, and etc.) methods any longer.  Just use Add and the
+wrappers will figure out what to do.</p>
+</div>
+<div class="section" id="platforminfo">
+<h1><a 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
+wx.Platform contains, such as if it is a GTK2 build.  For example,
+instead of:</p>
+<pre class="literal-block">
+if wx.Platform == &quot;__WXGTK__&quot;:
+    ...
+</pre>
+<p>you should do this:</p>
+<pre class="literal-block">
+if &quot;__WXGTK__&quot; in wx.PlatformInfo:
+     ...
+</pre>
+<p>and you can specifically check for a wxGTK2 build by looking for
+&quot;gtk2&quot; in wx.PlatformInfo.  Unicode builds are also detectable this
+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="other-stuff">
 <h1><a name="other-stuff">Other Stuff</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
 later into the main namespace via Python code.</p>
 <div class="section" id="other-stuff">
 <h1><a name="other-stuff">Other Stuff</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
 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>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
+GetSystemColour, GetSystemFont and GetSystemMetric have also gone into
+the bit-bucket.  Use GetColour, GetFont and GetMetric instead.</p>
+<p>The wx.NO_FULL_REPAINT_ON_RESIZE style is now the default style for
+all windows.  The name still exists for compatibility, but it is set
+to zero.  If you want to disable the setting (so it matches the old
+default) then you need to use the new wx.FULL_REPAINT_ON_RESIZE style
+flag otherwise only the freshly exposed areas of the window will be
+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>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>
+<p>Instead of a very small 20x20 the default window size is now a more
+reasonable size, (currently 400x250 but that may change...)  If you
+don't specify a size, and the window/control class does not have any
+definition of it's own &quot;best size&quot; (most controls do) then the new
+default will be used.  If you have code that accidentally depends on
+the smaller size then things will look a bit odd.  To work around this
+just give those windows an explicit size when created.</p>
+</div>
 </div>
 </div>
+<hr class="footer" />
+<div class="footer">
+Generated on: 2004-03-12 19:55 UTC.
 </div>
 </body>
 </html>
 </div>
 </body>
 </html>
wxWidgets (Impactor)