]> git.saurik.com Git - wxWidgets.git/blame_incremental - utils/wxPython/README.txt
fixed somebody's poorly done StreamSize-->GetSize transition
[wxWidgets.git] / utils / wxPython / README.txt
... / ...
CommitLineData
1wxPython README
2---------------
3
4Welcome to the wonderful world of wxPython!
5
6Once you have installed the wxPython extension module, you can try it
7out by going to the [install dir]\wxPython\demo directory and typing:
8
9 python demo.py
10
11There are also some other sample files there for you to play with and
12learn from.
13
14If you selected to install the documentation then point your browser
15to [install dir]\wxPython\docs\index.htm and you will then be looking
16at the docs for wxWindows. For the most part you can use the C++ docs
17as most classes and methods are used identically. Where there are
18differences they are documented with a "wxPython Note."
19
20On Win32 systems the binary self-installer creates a program group on
21the Start Menu that contains a link to running the demo and a link to
22the help file. To help you save disk space I'm now using Microsoft's
23HTML Help format. If your system doesn't know what to do with the help
24file, you can install the HTML Help Viewer as part of IE 4+, NT
25Service Pack 4+, or the HTML Workshop at
26
27http://msdn.microsoft.com/workshop/author/htmlhelp/download.asp.
28
29
30
31Getting Help
32------------
33
34Since wxPython is a blending of multiple technologies, help comes from
35multiple sources. See the http://alldunn.com/wxPython for details on
36various sources of help, but probably the best source is the
37wxPython-users mail list. You can view the archive or subscribe by
38going to
39
40 http://starship.python.net/mailman/listinfo/wxpython-users
41
42Or you can send mail directly to the list using this address:
43
44 wxpython-users@starship.python.net
45
46----------------------------------------------------------------------
47
48What's new in 2.1b2
49--------------------
50
51Added the missing wxWindow.GetUpdateRegion() method.
52
53Made a new change in SWIG (update your patches everybody) that
54provides a fix for global shadow objects that get an exception in
55their __del__ when their extension module has already been deleted.
56It was only a 1 line change in .../SWIG/Modules/pycpp.cxx at about
57line 496 if you want to do it by hand.
58
59It is now possible to run through MainLoop more than once in any one
60process. The cleanup that used to happen as MainLoop completed (and
61prevented it from running again) has been delayed until the wxc module
62is being unloaded by Python.
63
64I fixed a bunch of stuff in the C++ version of wxGrid so it wouldn't
65make wxPython look bad.
66
67wxWindow.PopupMenu() now takes a wxPoint instead of x,y. Added
68wxWindow.PopupMenuXY to be consistent with some other methods.
69
70Added wxGrid.SetEditInPlace and wxGrid.GetEditInPlace.
71
72You can now provide your own app.MainLoop method. See
73wxPython/demo/demoMainLoop.py for an example and some explaination.
74
75Got the in-place-edit for the wxTreeCtrl fixed and added some demo
76code to show how to use it.
77
78Put the wxIcon constructor back in for GTK as it now has one that
79matches MSW's.
80
81Added wxGrid.GetCells
82
83Added wxSystemSettings static methods as functions with names like
84wxSystemSettings_GetSystemColour.
85
86Removed wxPyMenu since using menu callbacks have been depreciated in
87wxWindows. Use wxMenu and events instead.
88
89Added alternate wxBitmap constructor (for MSW only) as
90 wxBitmapFromData(data, type, width, height, depth = 1)
91
92Added a helper function named wxPyTypeCast that can convert shadow
93objects of one type into shadow objects of another type. (Like doing
94a down-cast.) See the implementation in wx.py for some docs.
95
96Fixed wxImage GetData and SetData to properly use String objects for
97data transfer.
98
99Added access methods to wxGridEvent.
100
101New Makefile/Setup files supporting multiple dynamic extension modules
102for unix systems.
103
104Fixes for the wxGLCanvas demo to work around a strange bug in gtk.
105
106SWIG support routines now compiled separately instead of being bundled
107in wx.cpp.
108
109
110
111
112What's new in 2.1b1
113--------------------
114Fixed wxComboBox.SetSelection so that it actually sets the selected
115item. (Actually just removed it from wxPython and let it default to
116wxChoice.SetSelection which was already doing the right thing.)
117
118Added the Printing Framework.
119
120Switched back to using the wxWindows DLL for the pre-built Win32
121version. The problem was needing to reinitialize static class info
122data after loading each extension module.
123
124Lots of little tweaks and additions to reflect changes to various
125wxWindows classes.
126
127Fixed a bug with attaching objects to tree items. Actually was a
128symptom of a larger problem with not obtaining the interpreter lock
129when doing any Py_DECREFs.
130
131wxSizer and friends. Sizers are layout tools that manage a colection
132of windows and sizers. Different types of sizers apply different
133types of layout algorithms. You saw it here first! These classes are
134not even in the wxWindows C++ library yet!
135
136
137
138What's new in 2.0b9
139-------------------
140Bug fix for ListCtrl in test4.py (Was a missing file... DSM!)
141
142Bug fix for occassional GPF on Win32 systems upon termination of a
143wxPython application.
144
145Added wxListBox.GetSelections returning selections as a Tuple.
146
147Added a wxTreeItemData that is able to hold any Python object and be
148associated with items in a wxTreeCtrl. Added test pytree.py to show
149this feature off.
150
151Added wxSafeYield function.
152
153OpenGL Canvas can be optionally compiled in to wxPython.
154
155Awesome new Demo Framework for showing off wxPython and for learning
156how it all works.
157
158The pre-built Win32 version is no longer distributing the wxWindows
159DLL. It is statically linked with the wxWindows library instead.
160
161Added a couple missing items from the docs.
162
163Added wxImage, wxImageHandler, wxPNGHandler, wxJPEGHandler,
164wxGIFHandler and wxBMPHandler.
165
166Added new methods to wxTextCtrl.
167
168Fixed some problems with how SWIG was wrapping some wxTreeCtrl
169methods.
170
171
172
173What's new in 2.0b8
174-------------------
175Support for using Python threads in wxPython apps.
176
177Several missing methods from various classes.
178
179Various bug fixes.
180
181
182
183What's new in 2.0b7
184-------------------
185Added DLG_PNT and DLG_SZE convienience methods to wxWindow class.
186
187Added missing constructor and other methods for wxMenuItem.
188
189
190
191What's new in 2.0b6
192-------------------
193Just a quickie update to fix the self-installer to be compatible with
194Python 1.5.2b2's Registry settings.
195
196
197What's new in 2.0b5
198-------------------
199Well obviously the numbering scheme has changed. I did this to
200reflect the fact that this truly is the second major revision of
201wxPython, (well the third actually if you count the one I did for
202wxWindows 1.68 and then threw away...) and also that it is associated
203with the 2.0 version of wxWindows.
204
205I have finally started documenting wxPython. There are several pages
206in the wxWindows documentation tree specifically about wxPython, and I
207have added notes within the class references about where and how wxPython
208diverges from wxWindows.
209
210Added wxWindow_FromHWND(hWnd) for wxMSW to construct a wxWindow from a
211window handle. If you can get the window handle into the python code,
212it should just work... More news on this later.
213
214Added wxImageList, wxToolTip.
215
216Re-enabled wxConfig.DeleteAll() since it is reportedly fixed for the
217wxRegConfig class.
218
219As usual, some bug fixes, tweaks, etc.
220
221
222
223What's new in 0.5.3
224-------------------
225Added wxSashWindow, wxSashEvent, wxLayoutAlgorithm, etc.
226
227Various cleanup, tweaks, minor additions, etc. to maintain
228compatibility with the current wxWindows.
229
230
231
232What's new in 0.5.0
233-------------------
234Changed the import semantics from "from wxPython import *" to "from
235wxPython.wx import *" This is for people who are worried about
236namespace pollution, they can use "from wxPython import wx" and then
237prefix all the wxPython identifiers with "wx."
238
239Added wxTaskbarIcon for wxMSW.
240
241Made the events work for wxGrid.
242
243Added wxConfig.
244
245Added wxMiniFrame for wxGTK.
246
247Changed many of the args and return values that were pointers to gdi
248objects to references to reflect changes in the wxWindows API.
249
250Other assorted fixes and additions.
251
252
253
254
255What's new in 0.4.2
256-------------------
257
258wxPython on wxGTK works!!! Both dynamic and static on Linux and
259static on Solaris have been tested. Many thanks go to Harm
260<H.v.d.Heijden@phys.tue.nl> for his astute detective work on tracking
261down a nasty DECREF bug. Okay so I have to confess that it was just a
262DSM (Dumb Stupid Mistake) on my part but it was nasty none the less
263because the behavior was so different on different platforms.
264
265The dynamicly loaded module on Solaris is still segfaulting, so it
266must have been a different issue all along...
267
268
269
270What's New in 0.4
271-----------------
272
2731. Worked on wxGTK compatibility. It is partially working. On a
274Solaris/Sparc box wxPython is working but only when it is statically
275linked with the Python interpreter. When built as a dyamically loaded
276extension module, things start acting weirdly and it soon seg-faults.
277And on Linux both the statically linked and the dynamically linked
278version segfault shortly after starting up.
279
2802. Added Toolbar, StatusBar and SplitterWindow classes.
281
2823. Varioius bug fixes, enhancements, etc.
283
284----------------------------------------------------------------------
285
286
287
288Build Instructions
289------------------
290I used SWIG (http://www.swig.org) to create the source code for the
291extension module. This enabled me to only have to deal with a small
292amount of code and only have to bother with the exceptional issues.
293SWIG takes care of the rest and generates all the repetative code for
294me. You don't need SWIG to build the extension module as all the
295generated C++ code is included under the src directory.
296
297I added a few minor features to SWIG to control some of the code
298generation. If you want to playaround with this the patches are in
299wxPython/SWIG.patches and they should be applied to the 1.1p5 version
300of SWIG. These new patches are documented at
301http://starship.skyport.net/crew/robind/#swig, and they should also
302end up in the 1.2 version of SWIG.
303
304wxPython is organized as a Python package. This means that the
305directory containing the results of the build process should be a
306subdirectory of a directory on the PYTHONPATH. (And preferably should
307be named wxPython.) You can control where the build process will dump
308wxPython by setting the TARGETDIR makefile variable. The default is
309$(WXWIN)/utils/wxPython, where this README.txt is located. If you
310leave it here then you should add $(WXWIN)/utils to your PYTHONPATH.
311However, you may prefer to use something that is already on your
312PYTHONPATH, such as the site-packages directory on Unix systems.
313
314
315Win32
316-----
317
3181. Build wxWindows with wxUSE_RESOURCE_LOADING_IN_MSW set to 1 in
319include/wx/msw/setup.h so icons can be loaded dynamically. While
320there, make sure wxUSE_OWNER_DRAWN is also set to 1.
321
3222. Change into the $(WXWIN)/utils/wxPython/src directory.
323
3243. Edit makefile.vc and specify where your python installation is at.
325You may also want to fiddle with the TARGETDIR variable as described
326above.
327
3284. Run nmake -f makefile.vc
329
3305. If it builds successfully, congratulations! Move on to the next
331step. If not then you can try mailing me for help. Also, I will
332always have a pre-built win32 version of this extension module at
333http://alldunn.com/wxPython/.
334
3356. Change to the $(WXWIN)/utils/wxPython/demo directory.
336
3377. Try executing the demo program. For example:
338
339 python demo.py
340
341To run it without requiring a console, you can use the pythonw.exe
342version of Python either from the command line or from a shortcut.
343
344
345
346Unix
347----
3480. I configure wxWindows like this, YMMV:
349
350./configure --with-gtk --disable-shared --enable-threads --disable-unicode
351
3521. Change into the $(WXWIN)/utils/wxPython/src directory.
353
3542. Edit Setup.in and ensure that the flags, directories, and toolkit
355options are correct. See the above commentary about TARGETDIR. There
356are a few sample Setup.in.[platform] files provided.
357
3583. Run this command to generate a makefile:
359
360 make -f Makefile.pre.in boot
361
3624. Run these commands to build and then install the wxPython extension
363module:
364
365 make
366 make install
367
368
3695. Change to the $(WXWIN)/utils/wxPython/demo directory.
370
3716. Try executing the demo program. For example:
372
373 python demo.py
374
375----------------
376Robin Dunn
377robin@alldunn.com
378
379
380