1 CHANGES.txt for wxPython
3 ----------------------------------------------------------------------
8 Various tweaks, fixes, missing methods, etc.
15 Added wxLog and friends.
17 Added wxFrame.ShowFullScreen for MSW.
19 Added PyShellWindow to the wxPython.lib package.
26 Added an attribute named labelDelta to the generic buttons that
27 specifies how far to offset the label when the button is in the
30 Added wxTipProvider and friends. See the demo for an example.
32 wxGrid can now change the cell highlight colour.
36 Fixed printing on wxGTK.
38 Added wxDateTime, wxTimeSpan, and wxDateSpan to wxPython.utils.
42 WARNING: A while back I asked what should be done about the Magic
43 Method Names. (Methods that are automatically turned into event
44 handlers by virtue of their name.) The consensus was that it is more
45 confusing to have them than to try and expand them to have greater
46 coverage. I am finally getting around to removing the code that
47 generates the event binding. This means that if you are using any of
48 the following method names without a EVT_* call that you need to
49 modify your code to add the EVT_* to hook the event to the method.
71 Fixed wxTreeCtrl.HitTest to return both the tree item as well as the
72 flags that clairify where the click was in relation to the item.
74 Fixed thread state problem in wxTreeCtrl.GetBoundingBox and
77 Fixed some problems in OGL. Also wxShape.SetClientData and
78 .GetClientData can now deal with Python objects.
80 Added wxListCtrl.SortItems and changed the demo to show how to use it.
82 Plugged a memory leak.
84 Wrapped the new wxGrid and friends. The old wxGrid class is no longer
85 available. There are some incompatibilities, and unfortunately the
86 new classes are not documented yet, (however the methods are more
87 consistent with each other now so you may be able to guess pretty
90 Updated filebrowsebutton.py and calendar.py with changes from their
91 authors. There is now a FileBrowseButtonWithHistory class (what a
92 mouthful!) and wxCalendar has printing support.
94 Added ActiveXWrapper to the library, and some good demos of it too.
95 It works great for embedding a COM (a.k.a OCX, a.k.a ActiveX) control
96 in a window and calling its methods. It actually creates a new class
97 on the fly that derives from wxWindow, the COM CoClass and others
98 needed to make it all work. The resulting class can be instantiated
99 just like wxWindow, used in sizers, etc. It also responds to all COM
100 method calls, properties, etc., and if the class or a mix-in has
101 matching method names, then the COM events will be propogated back to
104 Created a typemap that allows a string to be used for parameters
105 expecting a wxColour type. The string is either a colour name as
106 defined in the wxColourDatabase, or a colour spec of the form
107 "#RRGGBB". See the wxStyledTextCtrl demo for an example.
109 I almost forgot to mention the wxStyledTextCtrl! Yes, the
110 wxStyledTextCtrl is finally in wxPython!! (And the crowd goes
111 wild...) There's no documentaTion yet (the crowd boos and hisses...)
112 but I've included a very readable source file in the
113 wxPython/demo/data directory, a couple fairly good examples, and you
114 can also refer to the Scintilla documentaion at
115 http://www.scintilla.org/ScintillaDoc.html to help fill in the gaps
116 until the docs are done. (The croud murmers contentedly as the tool
117 provider smiles convincingly and removes his flame-proof suit.)
124 Skipped a version number to match what has been released for wxGTK.
126 Updated wxMVCTree and added a demo for it, also fixed layout on GTK
127 and some flicker problems.
129 Added a wrapper class for the Visualization ToolKit (or VTK) in the
130 wxPython.lib.vtk module. (http://www.kitware.com/)
132 Fixed wxTreeCtrl.SetItemImage and GetItemImage to recognise the new
135 Added wxPython.lib.spashscreen from Mike Fletcher.
137 Added wxPython.lib.filebrowsebutton also from Mike Fletcher.
139 Renamed wxTreeCtrl.GetParent to GetItemParent to avoid a name clash
140 with wxWindow.GetParent.
142 Added wxIntersectRect to compute the intersection of two wxRect's.
143 It is used like this:
145 intersect = wxIntersectRect(rect1, rect2)
147 If r1 and r2 don't intersect then None is returned, otherwise the
148 rectangle representing the intersection is returned.
150 Some bug fixes for Clipboard and Drag-n-Drop.
152 Rotated text!!! WooHoo! (See wxDC.DrawRotatedText())
154 Added a set of Generic Buttons to the library. These are simple
155 window classes that look and act like native buttons, but you can have
156 a bit more control over them. The bezel width can be set in addition
157 to colours, fonts, etc. There is a ToggleButton as well as Bitmap
158 versions too. They should also serve as a good example of how to
159 create your own classes derived from wxControl.
161 The C++ wxToolBar classes have been redone, and so have the wxPython
162 wrappers. There have been slight modifications to some of the methods
163 but shouldn't impact anybody too much. I took the opportunity to add
164 support for setting user data on each toolbar tool. The new AddTool
165 methods look like this:
169 pushedBitmap = wxNullBitmap,
172 shortHelpString = "",
175 def AddSimpleTool(ID,
177 shortHelpString = "",
182 There are also coresponding InsertTool and InsertSimpleTool methods
183 that additionally take an integer position as the first parameter.
185 Added a wrapper for the new PCX and TIFF ImageHandlers.
187 wxRect now simulates attributes named left, right, top and bottom.
189 Removed all non wx stuff from the glcanvas module since DA's PyOpenGL
190 is better and compatible with the wxGLCanvas. You can get it at
191 http://starship.python.net:9673/crew/da/Code/PyOpenGL.
193 Added some missing EVT_ functions.
195 Added Dirk Holtwic's editor classes to the wxPython.lib.editor
198 Changed all the "LIST" parameter names to "choices" to match the docs.
200 More fixes for the wxFloatBar, and it now works on wxGTK even better
201 than wxMSW! (The feat is accomplished by using the wxTB_DOCKABLE
202 style flag instead of trying to float it ourselves.)
209 Skipped a few version numbers so wxMSW, wxGTK and wxPython are all
212 wxImage.SetData now makes a copy of the image data before giving it to
213 wxImage. I mistakenly thought that wxImage would copy the data
216 Fixed wxMSW's notebook so the pages get their size set as they are
217 being added. This should remove the need for our
218 wxNotebook.ResizeChildren hack.
220 wxPanels now support AutoLayout, and wxNotebooks and wxSplitterWindows
221 no longer tell their children to Layout() themselves. This will
222 probably only effect you if you have a wxWindow with AutoLayout inside
223 a notebook or splitter. If so, either change it to a wxPanel or add
224 an EVT_SIZE handler that calls Layout().
226 Fixed deadlock problem that happened when using threads.
228 Added new HTML printing classes.
230 Added wxWindow.GetHandle
232 Apparently wxMouseEvent.Position has been depreciated in wxWindows as
233 it is no longer available by default. You can use GetPositionTuple
234 (returning a tuple with x,y) instead, or GetPosition (returning a
237 Added wxPostEvent function that allows events to be posted and then
238 processed later. This is a thread-safe way to interact with the GUI
239 thread from other threads.
241 Added Clipboard and Drag-and-Drop classes.
243 Added wxFontEnumerator.
245 Many updates to wxMenu, wxMenuBar.
247 wxPyEvent and wxPyCommandEvent derived classes now give you the actual
248 Python object in the event handler instead of a new shadow.
250 Added a Calendar widget from Lorne White to the library.
252 Made some fixes to the wxFloatbar. It still has some troubles on
255 Added an MVC tree control from Bryn Keller to the library.
262 This is a quick bug-fix release to take care of a few nasties that
263 crept in at the last minute before 2.1.4 was called done. No new
271 This release is NOT syncronized with a snapshot release of wxGTK or
272 wxMSW. For MSW this isn't much of a problem since you can get the
273 binaries from the web site. For other platforms you'll have to build
274 wxGTK from CVS. (See http://web.ukonline.co.uk/julian.smart/wxwin/cvs.htm)
275 To get the same set of sources from CVS that I used, checkout using
278 Now back to what's new...
280 Much more support for event-less callbacks and add-on modules.
282 Created add-on module with wxOGL classes.
284 Added wxWindow.GetChildren(). Be careful of this. It returns a *copy*
285 of the list of the window's children. While you are using the list if
286 anything changes in the real list (a child is deleted, etc.) then the
287 list you are holding will suddenly have window references to garbage
288 memory and your app will likely crash. But if you are careful it works
291 Added a bunch of new and missing methods to wxTreeCrtl. The
292 SortChildren method is now supported, but currently only for the
295 Added typemaps for wxSize, wxPoint, wxRealPoint, and wxRect that allow
296 either the actual objects or Python sequence values to be used. For
297 example, the following are equivallent:
299 win = wxWindow(parent, size = wxSize(100, 100))
300 win = wxWindow(parent, size = (100, 100))
302 Super-charged the wxHtml module. You can now create your own tag
303 handlers and also have access to the parser and cell classes. There
304 is a tag handler in the library at wxPython.lib.wxpTag that
305 understands the WXP tag and is able to place wxPython windows on HTML
306 pages. See the demo for an example.
308 A bunch of the methods of wxMenuBar were previously ifdef'd out for
309 wxGTK. Added them back in since the methods exist now.
311 Wrapped the wxHtmlHelpController and related classes.
313 Wrapped the C++ versions of wxSizer and friends. The Python-only
314 versions are still in the library, but depreciated. (You will get a
315 warning message if you try to use them, but the warning can be
316 disabled.) The usage of the C++ versions is slightly different, and
317 the functionality of wxBorderSizer is now part of wxBoxSizer. I have
318 added a few methods to wxSizer to try and make the transition as
319 smooth as possible, I combined all Add methods into a single method
320 that handles all cases, added an AddMany method, etc. One step I did
321 not take was to make the default value of flag in the Add method be
322 wxGROW. This would have made it more backward compatible, but less
323 portable to and from wxWin C++ code. Please see the docs and demo for
326 Added wxPyEvent and wxPyCommandEvent classes, derived from wxEvent and
327 wxCommandEvent. Each of them has SetPyData and GetPyData methods that
328 accept or return a single Python object. You can use these classes
329 directly or derive from them to create your own types of event objects
330 that can pass through the wxWindows event system without loosing their
331 Python parts (as long as they are stored with SetPyData.) Stay tuned
332 for more info and examples in future releases.
334 Added wxPython.lib.grids as an example of how to derive a new sizer
335 from the C++ sizers. In this module you will find wxGridSizer and
336 wxFlexGridSizer. wxGridSizer arrainges its items in a grid in which
337 all the widths and heights are the same. wxFlexgridSizer allows
338 different widths and heights, and you can also specify rows and/or
339 columns that are growable. See the demo for a couple examples for how
342 Added the wxValidator class, and created a class named wxPyValidator
343 that should be used for the base class of any Python validators. See
344 the demo for an example. Please note that you MUST implement a Clone
345 method in your validator classes because of the way some things work
346 in the underlying C++ library. I did not add wxTextValidator because
347 of some issues of how it transfers data to and from a wxString, which
348 in wxPython is automatically translated to and from Python strings, so
349 there would never be a concrete wxString that would hang around long
350 enough for the validator to do its job. On the other hand, it should
351 be real easy to duplicate the functionality of wxTextValidator in a
352 pure Python class derived from wxPyValidator.
354 I've finally added a feature that has been on my list for close to two
355 years! Ever wondered what that zero is for when you create your app
356 object? Well now you can leave it out or explicitly set it to a true
357 value. This value now controls what is to be done with sys.stdout and
358 sys.stderr. A false value leaves them alone, and a true value sets
359 them to an instance of wxPyOnDemandOutputWindow. (On windows the
360 default is true, on unix platforms the default is false.) This class
361 creates a frame containing a wxTextCtrl as soon as anything is written
362 to sys.stdout or sys.stderr. If you close the window it will come
363 back again the next time something is written. (You can call
364 app.RestoreStdio to turn this off.) If you would rather that the stdio be
365 redirected to a file, you can provide a second parameter to your app
366 object's constructor that is a filename. If you want to use your own
367 class instead of wxPyOnDemandOutputWindow you can either implement
368 RedirectStdio() in you app class or change the value of
369 wxApp.outputWindowClass like this:
372 outputWindowClass = MyClass
376 self.SetTopWindow(frame)
379 Please see the implementation of wxPyOnDemandOutputWindow and wxApp in
380 wx.py for more details. A few words of caution: if you are running
381 your app in a debugger, changing sys.stdout and sys.stderr is likely
382 to really screw things up.
384 Added wxCaret. Unfortunately it's author has still not documented it
385 in the wxWindows docs...
387 Some new 3rd party contributions in wxPython.lib. PyShell, in
388 shell.py is an interesting implementaion of an interactive Python
389 shell in wxWindows. floatbar.py has a class derived from wxToolBar
390 that can sense mouse drags and then reparent itself into another
391 frame. Moving the new frame close to where it came from puts the tool
392 bar back into the original parent. (Unfortunately there is currently
393 a bug in wxGTK's wxFrame.SetToolBar so the FloatBar has some
402 This release is syncronized with release 2.1 snapshot 9 of wxWindows.
404 Switched to using SWIG from CVS (see http://swig.cs.uchicago.edu/cvs.html)
405 for some of the new features and such. Also they have encorporated my
406 patches so there is really no reason to stick with the current (very
407 old) release... This version of SWIG gives the following new
410 1. Keyword arguments. You no longer have to specify all the
411 parameters with defaults to a method just to specify a
412 non-default value on the end. You can now do this instead:
414 win = wxWindow(parent, -1, style = mystyle)
416 2. There is now an an equivalence between Python's None and C++'s
417 NULL. This means that any methods that might return NULL will
418 now return None and you can use none where wxWindows might be
419 expecting NULL. This makes things much more snake-ish.
422 There is a new build system based on a new Python program instead of
423 raw makefiles. Now wxPython builds are virtually the same on MSW or
424 Unix systems. See the end of this file for new build instructions and
425 see distrib/build.py for more details.
427 wxDC.Bilt now includes the useMask parameter, and has been split into
428 two different versions. wxDC.BlitXY is like what was there before and
429 takes raw coordinants and sizes, and the new wxDC.Blit is for the new
430 interface using wxPoints and a wxSize.
439 Added the missing wxWindow.GetUpdateRegion() method.
441 Made a new change in SWIG (update your patches everybody) that
442 provides a fix for global shadow objects that get an exception in
443 their __del__ when their extension module has already been deleted.
444 It was only a 1 line change in .../SWIG/Modules/pycpp.cxx at about
445 line 496 if you want to do it by hand.
447 It is now possible to run through MainLoop more than once in any one
448 process. The cleanup that used to happen as MainLoop completed (and
449 prevented it from running again) has been delayed until the wxc module
450 is being unloaded by Python.
452 I fixed a bunch of stuff in the C++ version of wxGrid so it wouldn't
453 make wxPython look bad.
455 wxWindow.PopupMenu() now takes a wxPoint instead of x,y. Added
456 wxWindow.PopupMenuXY to be consistent with some other methods.
458 Added wxGrid.SetEditInPlace and wxGrid.GetEditInPlace.
460 You can now provide your own app.MainLoop method. See
461 wxPython/demo/demoMainLoop.py for an example and some explaination.
463 Got the in-place-edit for the wxTreeCtrl fixed and added some demo
464 code to show how to use it.
466 Put the wxIcon constructor back in for GTK as it now has one that
469 Added wxGrid.GetCells
471 Added wxSystemSettings static methods as functions with names like
472 wxSystemSettings_GetSystemColour.
474 Removed wxPyMenu since using menu callbacks have been depreciated in
475 wxWindows. Use wxMenu and events instead.
477 Added alternate wxBitmap constructor (for MSW only) as
478 wxBitmapFromData(data, type, width, height, depth = 1)
480 Added a helper function named wxPyTypeCast that can convert shadow
481 objects of one type into shadow objects of another type. (Like doing
482 a down-cast.) See the implementation in wx.py for some docs.
484 Fixed wxImage GetData and SetData to properly use String objects for
487 Added access methods to wxGridEvent.
489 New Makefile/Setup files supporting multiple dynamic extension modules
492 Fixes for the wxGLCanvas demo to work around a strange bug in gtk.
494 SWIG support routines now compiled separately instead of being bundled
503 Fixed wxComboBox.SetSelection so that it actually sets the selected
504 item. (Actually just removed it from wxPython and let it default to
505 wxChoice.SetSelection which was already doing the right thing.)
507 Added the Printing Framework.
509 Switched back to using the wxWindows DLL for the pre-built Win32
510 version. The problem was needing to reinitialize static class info
511 data after loading each extension module.
513 Lots of little tweaks and additions to reflect changes to various
516 Fixed a bug with attaching objects to tree items. Actually was a
517 symptom of a larger problem with not obtaining the interpreter lock
518 when doing any Py_DECREFs.
520 wxSizer and friends. Sizers are layout tools that manage a colection
521 of windows and sizers. Different types of sizers apply different
522 types of layout algorithms. You saw it here first! These classes are
523 not even in the wxWindows C++ library yet!
529 Bug fix for ListCtrl in test4.py (Was a missing file... DSM!)
531 Bug fix for occassional GPF on Win32 systems upon termination of a
532 wxPython application.
534 Added wxListBox.GetSelections returning selections as a Tuple.
536 Added a wxTreeItemData that is able to hold any Python object and be
537 associated with items in a wxTreeCtrl. Added test pytree.py to show
540 Added wxSafeYield function.
542 OpenGL Canvas can be optionally compiled in to wxPython.
544 Awesome new Demo Framework for showing off wxPython and for learning
547 The pre-built Win32 version is no longer distributing the wxWindows
548 DLL. It is statically linked with the wxWindows library instead.
550 Added a couple missing items from the docs.
552 Added wxImage, wxImageHandler, wxPNGHandler, wxJPEGHandler,
553 wxGIFHandler and wxBMPHandler.
555 Added new methods to wxTextCtrl.
557 Fixed some problems with how SWIG was wrapping some wxTreeCtrl
564 Support for using Python threads in wxPython apps.
566 Several missing methods from various classes.
574 Added DLG_PNT and DLG_SZE convienience methods to wxWindow class.
576 Added missing constructor and other methods for wxMenuItem.
582 Just a quickie update to fix the self-installer to be compatible with
583 Python 1.5.2b2's Registry settings.
588 Well obviously the numbering scheme has changed. I did this to
589 reflect the fact that this truly is the second major revision of
590 wxPython, (well the third actually if you count the one I did for
591 wxWindows 1.68 and then threw away...) and also that it is associated
592 with the 2.0 version of wxWindows.
594 I have finally started documenting wxPython. There are several pages
595 in the wxWindows documentation tree specifically about wxPython, and I
596 have added notes within the class references about where and how wxPython
597 diverges from wxWindows.
599 Added wxWindow_FromHWND(hWnd) for wxMSW to construct a wxWindow from a
600 window handle. If you can get the window handle into the python code,
601 it should just work... More news on this later.
603 Added wxImageList, wxToolTip.
605 Re-enabled wxConfig.DeleteAll() since it is reportedly fixed for the
608 As usual, some bug fixes, tweaks, etc.
614 Added wxSashWindow, wxSashEvent, wxLayoutAlgorithm, etc.
616 Various cleanup, tweaks, minor additions, etc. to maintain
617 compatibility with the current wxWindows.
623 Changed the import semantics from "from wxPython import *" to "from
624 wxPython.wx import *" This is for people who are worried about
625 namespace pollution, they can use "from wxPython import wx" and then
626 prefix all the wxPython identifiers with "wx."
628 Added wxTaskbarIcon for wxMSW.
630 Made the events work for wxGrid.
634 Added wxMiniFrame for wxGTK.
636 Changed many of the args and return values that were pointers to gdi
637 objects to references to reflect changes in the wxWindows API.
639 Other assorted fixes and additions.
647 wxPython on wxGTK works!!! Both dynamic and static on Linux and
648 static on Solaris have been tested. Many thanks go to Harm
649 <H.v.d.Heijden@phys.tue.nl> for his astute detective work on tracking
650 down a nasty DECREF bug. Okay so I have to confess that it was just a
651 DSM (Dumb Stupid Mistake) on my part but it was nasty none the less
652 because the behavior was so different on different platforms.
654 The dynamicly loaded module on Solaris is still segfaulting, so it
655 must have been a different issue all along...
662 1. Worked on wxGTK compatibility. It is partially working. On a
663 Solaris/Sparc box wxPython is working but only when it is statically
664 linked with the Python interpreter. When built as a dyamically loaded
665 extension module, things start acting weirdly and it soon seg-faults.
666 And on Linux both the statically linked and the dynamically linked
667 version segfault shortly after starting up.
669 2. Added Toolbar, StatusBar and SplitterWindow classes.
671 3. Varioius bug fixes, enhancements, etc.
673 ----------------------------------------------------------------------