From 6158f936ec6b3edfff2e0918ff44ea18e1ed7d2b Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Thu, 18 Dec 2003 19:08:13 +0000 Subject: [PATCH] Tweaked some sample code git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24915 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- wxPython/docs/MigrationGuide.html | 128 +++++++++++++++++++++++++----- wxPython/docs/MigrationGuide.txt | 4 +- 2 files changed, 111 insertions(+), 21 deletions(-) diff --git a/wxPython/docs/MigrationGuide.html b/wxPython/docs/MigrationGuide.html index c7333c44b9..b25cd127e8 100644 --- a/wxPython/docs/MigrationGuide.html +++ b/wxPython/docs/MigrationGuide.html @@ -1,8 +1,8 @@ - + - + wxPython 2.5 Migration Guide @@ -30,9 +30,9 @@ now be the GUI thread instead of the one that imports wxPython. Some potential problems are that the C++ side of the "stock-objects" (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.)

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

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

@@ -115,8 +115,8 @@ def EVT_MY_CUSTOM_EVENT(win, id, func):

Change it like so:

-myCustomEventType = wxNewEventType()
-EVT_MY_CUSTOM_EVENT = wxPyEventBinder(myCustomEventType, 1)
+myCustomEventType = wx.NewEventType()
+EVT_MY_CUSTOM_EVENT = wx.PyEventBinder(myCustomEventType, 1)

The second parameter is an integer in [0, 1, 2] that specifies the number of IDs that are needed to be passed to Connect.

@@ -136,8 +136,8 @@ wxWindow = wx.core.Window

Don't let the "core" 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.

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

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 +151,35 @@ uses the %rename directives that were generated in the first step.

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.

+

In summary, the wx package and names without the "wx" prefix are now +the official form of the wxPython classes. For example:

+
+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, "Do It", (10,10))
+        self.Bind(wx.EVT_BUTTON, self.JustDoIt, b)
+
+    def JustDoIt(self, evt):
+        print "It's done!"
+
+app = wx.PySimpleApp()
+f = MyFrame(None, "What's up?")
+f.Show()
+app.MainLoop()
+
+

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 "from wxPython.wx import *", the +old wxNames, and the old style of event binding it will still work +just fine.

+
+

System Message: WARNING/2 (MigrationGuide.txt, line 189); backlink

+Inline emphasis start-string without end-string.

New wx.DC Methods

@@ -166,9 +195,9 @@ SetSize(size) # Type A SetSizeWH(width, height) # Type B

For various reasons the new Type A methods in wx.DC were never added -and the existing Type B 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 Type B 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:

@@ -228,18 +257,25 @@ 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)
+
+SetClippingRegionXY SetClippingRegion(x, y, width, height)
+SetClippingRegion(point, size)
+SetClippingRect(rect)
+SetClippingRegionAsRegion(region);

If you have code that draws on a DC you will get errors because of these changes, but it should be easy to fix the code. You can either -change the name of the Type B 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:

+change the name of the Type B 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 +Type A method. For example, if you had this code before:

 dc.DrawRectangle(x, y, width, height)
-

You could just change it like this:

+

You could either continue to use the Type B method bu changing the +name to DrawRectabgleXY, or just change it to the new Type A by +adding some parentheses like this:

 dc.DrawRectangle((x, y), (width, height))
@@ -247,7 +283,7 @@ dc.DrawRectangle((x, y), (width, height)) 
 dc.DrawRectangle(p.x, p.y, s.width, s.height)
-

Then you can just change it like this:

+

Then you can just simplify it like this:

 dc.DrawRectangle(p, s)
@@ -269,6 +305,37 @@ these headers on Linux...]]

wxClassInfo::InitializeClasses() in your extensions or when embedding wxPython.

+
+

Two (or Three!) Phase Create

+

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:

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

Sizers

+

The hack allowing the old "option" keyword parameter has been +removed. If you use keyworkd args with wxSizer Add, Insert, or +Prepend then you will need to use the "proportion" name instead of +"option".

+

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.

+

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.

+

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.

+

Other Stuff

Instead of over a dozen separate extension modules linked together @@ -278,7 +345,30 @@ later into the main namespace via Python code.

Because of the above, the "internal" module names have changed, but you shouldn't have been using them anyway so it shouldn't bother you. ;-)

+

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.

+

wxPyDefaultPosition and wxPyDefaultSize are gone. Use the +wxDefaultPosition and wxDefaultSize objects instead.

+

Similarly, the wxSystemSettings backwards compatibiility aliases for +GetSystemColour, GetSystemFont and GetSystemMetric have also gone into +the bit-bucket. Use GetColour, GetFont and GetMetric instead.

+

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.

+

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.

+
+
+
+View document source. +Generated on: 2003-12-18 18:35 UTC. +Generated by Docutils from reStructuredText source.
diff --git a/wxPython/docs/MigrationGuide.txt b/wxPython/docs/MigrationGuide.txt index 73771d2485..431f57be55 100644 --- a/wxPython/docs/MigrationGuide.txt +++ b/wxPython/docs/MigrationGuide.txt @@ -124,8 +124,8 @@ function. If you used to have something like this:: Change it like so:: - myCustomEventType = wxNewEventType() - EVT_MY_CUSTOM_EVENT = wxPyEventBinder(myCustomEventType, 1) + myCustomEventType = wx.NewEventType() + EVT_MY_CUSTOM_EVENT = wx.PyEventBinder(myCustomEventType, 1) The second parameter is an integer in [0, 1, 2] that specifies the number of IDs that are needed to be passed to Connect. -- 2.45.2