]> git.saurik.com Git - wxWidgets.git/blob - utils/wxPython/README.txt
Updates to VC++ project files
[wxWidgets.git] / utils / wxPython / README.txt
1 wxPython README
2 ---------------
3
4 Welcome to the wonderful world of wxPython!
5
6 Once you have installed the wxPython extension module, you can try it
7 out by going to the [install dir]\wxPython\demo directory and typing:
8
9 python demo.py
10
11 There are also some other sample files there for you to play with and
12 learn from.
13
14 If you selected to install the documentation then point your browser
15 to [install dir]\wxPython\docs\index.htm and you will then be looking
16 at the docs for wxWindows. For the most part you can use the C++ docs
17 as most classes and methods are used identically. Where there are
18 differences they are documented with a "wxPython Note."
19
20 On Win32 systems the binary self-installer creates a program group on
21 the Start Menu that contains a link to running the demo and a link to
22 the help file. To help you save disk space I'm now using Microsoft's
23 HTML Help format. If your system doesn't know what to do with the help
24 file, you can install the HTML Help Viewer as part of IE 4+, NT
25 Service Pack 4+, or the HTML Workshop at
26
27 http://msdn.microsoft.com/workshop/author/htmlhelp/download.asp.
28
29
30
31 Getting Help
32 ------------
33
34 Since wxPython is a blending of multiple technologies, help comes from
35 multiple sources. See the http://alldunn.com/wxPython for details on
36 various sources of help, but probably the best source is the
37 wxPython-users mail list. You can view the archive or subscribe by
38 going to
39
40 http://starship.python.net/mailman/listinfo/wxpython-users
41
42 Or you can send mail directly to the list using this address:
43
44 wxpython-users@starship.python.net
45
46 ----------------------------------------------------------------------
47
48
49 What's new in 2.1.4
50 --------------------
51
52 Much more support for event-less callbacks and add-on modules.
53
54 Created add-on module with wxOGL classes.
55
56 Added wxWindow.GetChildren(). Be careful of this. It returns a *copy*
57 of the list of the window's children. While you are using the list if
58 anything changes in the real list (a child is deleted, etc.) then the
59 list you are holding will suddenly have window references to garbage
60 memory and your app will likely crash. But if you are careful it works
61 great!
62
63 Added a bunch of new and missing methods to wxTreeCrtl. The
64 SortChildren method is now supported, but currently only for the
65 default sort order.
66
67 Added typemaps for wxSize, wxPoint, wxRealPoint, and wxRect that allow
68 either the actual objects or Python sequence values to be used. For
69 example, the following are equivallent:
70
71 win = wxWindow(parent, size = wxSize(100, 100))
72 win = wxWindow(parent, size = (100, 100))
73
74 Super-charged the wxHtml module. You can now create your own tag
75 handlers and also have access to the parser and cell classes. There
76 is a tag handler in the library at wxPython.lib.wxpTag that
77 understands the WXP tag and is able to place wxPython windows on HTML
78 pages. See the demo for an example.
79
80 A bunch of the methods of wxMenuBar were previously ifdef'd out for
81 wxGTK. Added them back in since the methods exist now.
82
83 Wrapped the wxHtmlHelpController and related classes.
84
85 Wrapped the C++ versions of wxSizer and firends. The Python-only
86 versions are still in the library, but depreciated. (You will get a
87 warning message if you try to use them, but the warning can be
88 disabled.) The usage of the C++ versions is slightly different, and
89 the functionality of wxBorderSizer is now part of wxBoxSizer. I have
90 added a few methods to wxSizer to try and make the transition as
91 smooth as possible, I combined all Add methods into a single method
92 that handles all cases, added an AddMany method, etc. One step I did
93 not take was to make the default value of flag in the Add method be
94 wxGROW. This would have made it more backward compatible, but less
95 portable to and from wxWin C++ code. Please see the docs and demo for
96 further details.
97
98 Added wxPyEvent and wxPyCommandEvent classes, derived from wxEvent and
99 wxCommandEvent. Each of them has SetPyData and GetPyData methods that
100 accept or return a single Python object. You can use these classes
101 directly or derive from them to create your own types of event objects
102 that can pass through the wxWindows event system without loosing their
103 Python parts (as long as they are stored with SetPyData.) Stay tuned
104 for more info and examples in future releases.
105
106 Added wxPython.lib.grids as an example of how to derive a new sizer
107 from the C++ sizers. In this module you will find wxGridSizer and
108 wxFlexGridSizer. wxGridSizer arrainges its items in a grid in which
109 all the widths and heights are the same. wxFlexgridSizer allows
110 different widths and heights, and you can also specify rows and/or
111 columns that are growable. See the demo for a couple examples for how
112 to use them.
113
114 Added the wxValidator class, and created a class named wxPyValidator
115 that should be used for the base class of any Python validators. See
116 the demo for an example. Please not that you MUST implement a Clone
117 method in your validator classes because of the way some things work
118 in the underlying C++ library. I did not add wxTextValidator because
119 of some issues of how it transfers data to and from a wxString, which
120 in wxPython is automatically translated to and from Python strings, so
121 there would never be a concrete wxString that would hang around long
122 enough for the validator to do its job. On the other hand, it should
123 be real easy to duplicate the functionality of wxTextValidator in a
124 pure Python class derived from wxPyValidator.
125
126 I've finally added a feature that has been on my list for close to two
127 years! Ever wondered what that zero is for when you create your app
128 object? Well now you can leave it out or explicitly set it to a true
129 value. This value now controls what is to be done with sys.stdout and
130 sys.stderr. A false value leaves them alone, and a true value sets
131 them to an instance of wxPyOnDemandOutputWindow. (On windows the
132 default is true, on other platforms the default is false.) This class
133 creates a frame containing a wxTextCtrl as soon as anything is written
134 to sys.stdout or sys.stderr. If you close the window it will come
135 back again the next time something is written. (You can call
136 app.RestoreStdio to turn this off.) If you would rather that the stdio be
137 redirected to a file, you can provide a second parameter to your app
138 object's constructor that is a filename. If you want to use your own
139 class instead of wxPyOnDemandOutputWindow you can either implement
140 RedirectStdio() in you app class or change the value of
141 wxApp.outputWindowClass like this:
142
143 class MyApp(wxApp):
144 outputWindowClass = MyClass
145
146 def OnInit(self):
147 frame = MyFrame()
148 self.SetTopWindow(frame)
149 return true
150
151 Please see the implementation of wxPyOnDemandOutputWindow and wxApp in
152 wx.py for more details. A few words of caution: if you are running
153 your app in a debugger, changing sys.stdout and sys.stderr is likely
154 to really screw things up.
155
156
157
158 What's new in 2.1b3
159 --------------------
160
161 This release is syncronized with release 2.1 snapshot 9 of wxWindows.
162
163 Switched to using SWIG from CVS (see http://swig.cs.uchicago.edu/cvs.html)
164 for some of the new features and such. Also they have encorporated my
165 patches so there is really no reason to stick with the current (very
166 old) release... This version of SWIG gives the following new
167 features:
168
169 1. Keyword arguments. You no longer have to specify all the
170 parameters with defaults to a method just to specify a
171 non-default value on the end. You can now do this instead:
172
173 win = wxWindow(parent, -1, style = mystyle)
174
175 2. There is now an an equivalence between Python's None and C++'s
176 NULL. This means that any methods that might return NULL will
177 now return None and you can use none where wxWindows might be
178 expecting NULL. This makes things much more snake-ish.
179
180
181 There is a new build system based on a new Python program instead of
182 raw makefiles. Now wxPython builds are virtually the same on MSW or
183 Unix systems. See the end of this file for new build instructions and
184 see distrib/build.py for more details.
185
186 wxDC.Bilt now includes the useMask parameter, and has been split into
187 two different versions. wxDC.BlitXY is like what was there before and
188 takes raw coordinants and sizes, and the new wxDC.Blit is for the new
189 interface using wxPoints and a wxSize.
190
191
192
193
194
195 What's new in 2.1b2
196 --------------------
197
198 Added the missing wxWindow.GetUpdateRegion() method.
199
200 Made a new change in SWIG (update your patches everybody) that
201 provides a fix for global shadow objects that get an exception in
202 their __del__ when their extension module has already been deleted.
203 It was only a 1 line change in .../SWIG/Modules/pycpp.cxx at about
204 line 496 if you want to do it by hand.
205
206 It is now possible to run through MainLoop more than once in any one
207 process. The cleanup that used to happen as MainLoop completed (and
208 prevented it from running again) has been delayed until the wxc module
209 is being unloaded by Python.
210
211 I fixed a bunch of stuff in the C++ version of wxGrid so it wouldn't
212 make wxPython look bad.
213
214 wxWindow.PopupMenu() now takes a wxPoint instead of x,y. Added
215 wxWindow.PopupMenuXY to be consistent with some other methods.
216
217 Added wxGrid.SetEditInPlace and wxGrid.GetEditInPlace.
218
219 You can now provide your own app.MainLoop method. See
220 wxPython/demo/demoMainLoop.py for an example and some explaination.
221
222 Got the in-place-edit for the wxTreeCtrl fixed and added some demo
223 code to show how to use it.
224
225 Put the wxIcon constructor back in for GTK as it now has one that
226 matches MSW's.
227
228 Added wxGrid.GetCells
229
230 Added wxSystemSettings static methods as functions with names like
231 wxSystemSettings_GetSystemColour.
232
233 Removed wxPyMenu since using menu callbacks have been depreciated in
234 wxWindows. Use wxMenu and events instead.
235
236 Added alternate wxBitmap constructor (for MSW only) as
237 wxBitmapFromData(data, type, width, height, depth = 1)
238
239 Added a helper function named wxPyTypeCast that can convert shadow
240 objects of one type into shadow objects of another type. (Like doing
241 a down-cast.) See the implementation in wx.py for some docs.
242
243 Fixed wxImage GetData and SetData to properly use String objects for
244 data transfer.
245
246 Added access methods to wxGridEvent.
247
248 New Makefile/Setup files supporting multiple dynamic extension modules
249 for unix systems.
250
251 Fixes for the wxGLCanvas demo to work around a strange bug in gtk.
252
253 SWIG support routines now compiled separately instead of being bundled
254 in wx.cpp.
255
256
257
258
259
260 What's new in 2.1b1
261 --------------------
262 Fixed wxComboBox.SetSelection so that it actually sets the selected
263 item. (Actually just removed it from wxPython and let it default to
264 wxChoice.SetSelection which was already doing the right thing.)
265
266 Added the Printing Framework.
267
268 Switched back to using the wxWindows DLL for the pre-built Win32
269 version. The problem was needing to reinitialize static class info
270 data after loading each extension module.
271
272 Lots of little tweaks and additions to reflect changes to various
273 wxWindows classes.
274
275 Fixed a bug with attaching objects to tree items. Actually was a
276 symptom of a larger problem with not obtaining the interpreter lock
277 when doing any Py_DECREFs.
278
279 wxSizer and friends. Sizers are layout tools that manage a colection
280 of windows and sizers. Different types of sizers apply different
281 types of layout algorithms. You saw it here first! These classes are
282 not even in the wxWindows C++ library yet!
283
284
285
286 What's new in 2.0b9
287 -------------------
288 Bug fix for ListCtrl in test4.py (Was a missing file... DSM!)
289
290 Bug fix for occassional GPF on Win32 systems upon termination of a
291 wxPython application.
292
293 Added wxListBox.GetSelections returning selections as a Tuple.
294
295 Added a wxTreeItemData that is able to hold any Python object and be
296 associated with items in a wxTreeCtrl. Added test pytree.py to show
297 this feature off.
298
299 Added wxSafeYield function.
300
301 OpenGL Canvas can be optionally compiled in to wxPython.
302
303 Awesome new Demo Framework for showing off wxPython and for learning
304 how it all works.
305
306 The pre-built Win32 version is no longer distributing the wxWindows
307 DLL. It is statically linked with the wxWindows library instead.
308
309 Added a couple missing items from the docs.
310
311 Added wxImage, wxImageHandler, wxPNGHandler, wxJPEGHandler,
312 wxGIFHandler and wxBMPHandler.
313
314 Added new methods to wxTextCtrl.
315
316 Fixed some problems with how SWIG was wrapping some wxTreeCtrl
317 methods.
318
319
320
321 What's new in 2.0b8
322 -------------------
323 Support for using Python threads in wxPython apps.
324
325 Several missing methods from various classes.
326
327 Various bug fixes.
328
329
330
331 What's new in 2.0b7
332 -------------------
333 Added DLG_PNT and DLG_SZE convienience methods to wxWindow class.
334
335 Added missing constructor and other methods for wxMenuItem.
336
337
338
339 What's new in 2.0b6
340 -------------------
341 Just a quickie update to fix the self-installer to be compatible with
342 Python 1.5.2b2's Registry settings.
343
344
345 What's new in 2.0b5
346 -------------------
347 Well obviously the numbering scheme has changed. I did this to
348 reflect the fact that this truly is the second major revision of
349 wxPython, (well the third actually if you count the one I did for
350 wxWindows 1.68 and then threw away...) and also that it is associated
351 with the 2.0 version of wxWindows.
352
353 I have finally started documenting wxPython. There are several pages
354 in the wxWindows documentation tree specifically about wxPython, and I
355 have added notes within the class references about where and how wxPython
356 diverges from wxWindows.
357
358 Added wxWindow_FromHWND(hWnd) for wxMSW to construct a wxWindow from a
359 window handle. If you can get the window handle into the python code,
360 it should just work... More news on this later.
361
362 Added wxImageList, wxToolTip.
363
364 Re-enabled wxConfig.DeleteAll() since it is reportedly fixed for the
365 wxRegConfig class.
366
367 As usual, some bug fixes, tweaks, etc.
368
369
370
371 What's new in 0.5.3
372 -------------------
373 Added wxSashWindow, wxSashEvent, wxLayoutAlgorithm, etc.
374
375 Various cleanup, tweaks, minor additions, etc. to maintain
376 compatibility with the current wxWindows.
377
378
379
380 What's new in 0.5.0
381 -------------------
382 Changed the import semantics from "from wxPython import *" to "from
383 wxPython.wx import *" This is for people who are worried about
384 namespace pollution, they can use "from wxPython import wx" and then
385 prefix all the wxPython identifiers with "wx."
386
387 Added wxTaskbarIcon for wxMSW.
388
389 Made the events work for wxGrid.
390
391 Added wxConfig.
392
393 Added wxMiniFrame for wxGTK.
394
395 Changed many of the args and return values that were pointers to gdi
396 objects to references to reflect changes in the wxWindows API.
397
398 Other assorted fixes and additions.
399
400
401
402
403 What's new in 0.4.2
404 -------------------
405
406 wxPython on wxGTK works!!! Both dynamic and static on Linux and
407 static on Solaris have been tested. Many thanks go to Harm
408 <H.v.d.Heijden@phys.tue.nl> for his astute detective work on tracking
409 down a nasty DECREF bug. Okay so I have to confess that it was just a
410 DSM (Dumb Stupid Mistake) on my part but it was nasty none the less
411 because the behavior was so different on different platforms.
412
413 The dynamicly loaded module on Solaris is still segfaulting, so it
414 must have been a different issue all along...
415
416
417
418 What's New in 0.4
419 -----------------
420
421 1. Worked on wxGTK compatibility. It is partially working. On a
422 Solaris/Sparc box wxPython is working but only when it is statically
423 linked with the Python interpreter. When built as a dyamically loaded
424 extension module, things start acting weirdly and it soon seg-faults.
425 And on Linux both the statically linked and the dynamically linked
426 version segfault shortly after starting up.
427
428 2. Added Toolbar, StatusBar and SplitterWindow classes.
429
430 3. Varioius bug fixes, enhancements, etc.
431
432 ----------------------------------------------------------------------
433
434
435
436 Build Instructions
437 ------------------
438 I used SWIG (http://www.swig.org) to create the source code for the
439 extension module. This enabled me to only have to deal with a small
440 amount of code and only have to bother with the exceptional issues.
441 SWIG takes care of the rest and generates all the repetative code for
442 me. You don't need SWIG to build the extension module as all the
443 generated C++ code is included under the src directory.
444
445 I added a few minor features to SWIG to control some of the code
446 generation. If you want to play around with this you will need to get
447 a recent version of SWIG from their CVS or from a daily build. See
448 http://www.swig.org/ for details.
449
450 wxPython is organized as a Python package. This means that the
451 directory containing the results of the build process should be a
452 subdirectory of a directory on the PYTHONPATH. (And preferably should
453 be named wxPython.) You can control where the build process will dump
454 wxPython by setting the TARGETDIR variable for the build utility, (see
455 below.)
456
457
458 1. Build wxWindows as described in its BuildCVS.txt file. For *nix
459 systems I run configure with these flags:
460
461 --with-gtk
462 --with-libjpeg
463 --without-odbc
464 --enable-unicode=no
465 --enable-threads=yes
466 --enable-socket=yes
467 --enable-static=no
468 --enable-shared=yes
469 --disable-std_iostreams
470
471 You can use whatever flags you want, but I know these work.
472
473 For Win32 systems I use Visual C++ 6.0, but 5.0 should work. The
474 build utility currently does not support any other win32 compilers.
475
476 2. At this point you may want to make an alias or symlink, script,
477 batch file, whatever on the PATH that invokes
478 $(WXWIN)/utils/wxPython/distrib/build.py to help simplify matters
479 somewhat. For example, on my win32 system I have a file named
480 build.bat in a directory on the PATH that contains:
481
482 python $(WXWIN)/utils/wxPython/distrib/build.py %1 %2 %3 %4 %5 %6
483
484
485 3. Change into the $(WXWIN)/utils/wxPython/src directory.
486
487 4. Type "build -b" to build wxPython and "build -i" to install it.
488
489 The build.py script actually generates a Makefile based on what it
490 finds on your system and information found in the build.cfg file.
491 If you have troubles building or you want it built or installed in
492 a different way, take a look at the docstring in build.py. You may
493 be able to override configuration options in a file named
494 build.local.
495
496 5. To build and install the add-on modules, change to the appropriate
497 directory under $(WXWIN)/utils/wxPython/modules and run the build
498 utility again.
499
500 6. Change to the $(WXWIN)/utils/wxPython/demo directory.
501
502 7. Try executing the demo program. For example:
503
504 python demo.py
505
506 To run it without requiring a console on win32, you can use the
507 pythonw.exe version of Python either from the command line or from a
508 shortcut.
509
510
511
512 ----------------
513 Robin Dunn
514 robin@alldunn.com
515
516
517
518
519
520
521