]> git.saurik.com Git - wxWidgets.git/blame - wxPython/docs/CHANGES.txt
docstring fixes
[wxWidgets.git] / wxPython / docs / CHANGES.txt
CommitLineData
73adcb01 1Recent Changes for wxPython
8eda5e35 2=====================================================================
6d75ea8f 3
ca8071ca 4
c6b65b76 52.5.4.0
ca8071ca
RD
6-------
7
3c1705d9 8wx.Sizer Add, Insert, and Prepend functions now return a reference to the
6b9f434e
RD
9wx.SizerItem that was added to the sizer, and the wx.SizerItem has a
10GetRect accessor to give the position of the item on the parent window.
7aada1e0
RD
11
12Added wx.Sizer.GetItem method which returns the wx.SizerItem for the given
13wx.Window, wx.Sizer or position index.
14
15wxMSW: wx.RadioButtons in the same group no longer have to be
16consecutive (there may be intervening controls). Without this fix, an
17out-of-sync assert is generated when clicking on a radio button and
18then calling GetValue().
19
b3b61cda 20Some XRC changes:
66b50a8f
RD
21 - Added 'icon' property to wxFrame and wxDialog
22 - No longer ignores menu bitmaps on non-MSW platforms
23 - Notebook page bitmaps are now supported
9828eeb4 24 - added system colours and fonts support (based on patch #1038207)
7aada1e0
RD
25
26wxMSW: fix for [ 1052989 ] TextCtrl.SetBackgroundColour(wx.NullColour)
27bug.
28
29Added wx.PasswordEntryDialog analagous to wx.TextEntryDialog, allows
30detecting entering an empty string vs. cancel unlike the
31wx.GetPasswordFromUser dialog function.
32
ca8071ca
RD
33OGL patch from Shane Holloway:
34
35 Two simple problems found in the new python ogl code. First is
b3b61cda 36 the patch for _canvas.py. Essentially::
ca8071ca
RD
37
38 dx = abs(dc.LogicalToDeviceX(x - self._firstDragX))
39 dy = abs(dc.LogicalToDeviceY(y - self._firstDragY))
40
41 was incorrect because (x,y) and (self._firstDragX,
42 self._firstDragY) are both already in Logical coordinates.
43 Therefore the difference between the two is also in logical
44 coordinates, and the conversion call is an error. This bug
45 surfaces when you have OGL on a scrollwin, and you are far from
46 the origin of the canvas.
47
48 The second change in _composit.py basically removes the assumption
49 that the child is in both self._children and self._divisions.
50 Causes many problems when it's not. ;)
51
22685693
RD
52Fixed GetSaveData and SetSaveData in wx.lib.multisash to not depend on
53the default way that class objectss are converted to strings.
ca8071ca 54
3c1705d9 55Fixed problem in StyledTextCtrl.Set[HV]ScrollBar that could leave the
7aada1e0
RD
56internal scrollbar visible.
57
58Added wx.StandardPaths which provides methods for determining standard
59system paths for each platform.
60
9828eeb4
RD
61wxMSW: The window background is now only erased by default if the
62background colour or background mode has been changed. This better
63allows the default system themed behaviour to show through for
64uncustomized windows. Explicit support added for using the correct
65theme texture for wx.Notebook pages and their children.
66
67wx.Image: Added support for alpha channels in interpolated and
68non-interpolated image rotation. Added ConvertAlphaToMask helper
69method for turning shades of grey into shades of alpha and a colour.
70
71wxGTK2: Reimplemented DoDrawRotatedText() by way of a rotation of an
72alpha blended text bitmap. It would be better if Pango could draw
73directly into an wxImage (as FreeType can,) but that is for later...
74
3c1705d9
RD
75Added wrappers and a demo for the wx.MediaCtrl class, which can play
76various forms of audio/video media using native codecs install on the
77system. So far it is only implemented for Windows and OSX.
850ab20b
RD
78
79wxGTK: Patch applied for Freeze()/Thaw() for wxTextCtrtl.
80
81Added "gravity" for splitter window (patch 1046105). Gravity is a
82floating-point factor between 0.0 and 1.0 which controls position of
83sash while resizing the wx.SplitterWindow. The gravity specifies
84how much the left/top window will grow while resizing.
85
86wxMSW: wx.Slider's C++ implementation rewritten to be more
87maintainable and hopefully less buggy. The position of the labels has
88also been changed in order to better comply with Microsoft's examples
89of how to use the control.
9828eeb4 90
94fd5e4d
RD
91wxMSW: Fix wx.TreeCtrl to end label editing if the control loses
92focus (a slightly modified patch 1084592.)
93
94Added wx.EXEC_NODISABLE flag for wx.Execute, which will prevent all
95the app's windows being disabled while a synchronous child process is
96running.
97
98wxMSW: Much work to correct painting (or leaving transparent) of
99control backgrounds, properly using background themes on XP, etc.
100
101Fixed a circular reference problem with wx.Timer. It will now
102completely cleanup after itself when the last reference to the timer
103is removed. If you were previously using timer.Destroy() to cleanup
104your timers it will no longer work. Instead you should hold a
105reference to the timer and then del the reference when you are
106finished with the timer.
7aada1e0 107
3c1705d9
RD
108Updated to 1.3.24 of SWIG. All of my big patches have been applied to
109the main SWIG source tree, but unfortunatly there were also some bugs
110added that affected the wxPython build and a few details in my
111original patch were changed/removed, so we are still not free of
112patches. A new patch for SWIG is located in the wxPython/SWIG
113directory of the wxPython source tree. SWIG 1.3.24 plus this patch
114should be used by anyone who is making custom modifications to
b3b61cda 115wxPython's .i files, or building their own extension modules or
3c1705d9
RD
116etc. that need to interact with the wxPython swigged types. For the
117morbidly curious, here are a few more details:
118
119 * Since it is now possible easily and simply share the SWIG type
120 tables across modules I reverted to always using the stock SWIG
121 runtime instead of my slightly hacked up version of it exported
122 via the wxPython C API.
123
54e72b1a 124 * The %name directive is now deprecated so I replaced most uses of
3c1705d9
RD
125 it with a custom %Rename macro that uses %rename internally.
126 These will evetually need to be replaced with a DocDecl macro
aeee37c3 127 when docstrings are added for those items.
3c1705d9
RD
128
129 * The "this" attribute of all SWIGged classes is no longer a
130 string containing a "swigified pointer", but rather a custom
131 built-in type that holds the real C pointer to the object and
132 the type info. It can be converted to a string like the old
133 value using str() or to the long integer value of the pointer
134 using long().
135
669e06d7
RD
136Added SetDefaultPyEncoding and GetDefaultPyEncoding functions which
137will set/get the encoding used by wxPython to convert string or
138unicode objects to/from wxString objects. Previously the default
139Python encoding was always used, but unless the user had tweaked their
140sitecustomize.py file it is always "ascii", which would result in
141errors if the strings contained character codes >= 128.
142SetDefaultPyEncoding will now allow you to control which encoding will
143be used to do those conversions. The default encoding is set to the
144value of `locale.getdefaultlocale()[1]` when wxPython is first
145imported. Please see http://www.alanwood.net/demos/charsetdiffs.html
9283228f
RD
146for information on the differences between the common latin/roman
147encodings.
148
149Added wxStdDialogButtonSizer, which is a a special sizer that knows
150how to order and position standard buttons in order to conform to the
151current platform's standards. You simply need to add each `wx.Button`
152to the sizer, and be sure to create the buttons using the standard
153ID's. Then call `Finalize` and the sizer will take care of the rest.
669e06d7 154
d31aa173
RD
155wxMSW Toolbar: pass correct tool id (and not always -1) to the
156EVT_TOOL_RCLICKED handler
157
b76160ef 158wxGTK: Applied patch for combo box SELECTED events (no longer get
d31aa173
RD
159lots of surplus events)
160
161wxGTK: Applied patch for proper menu highlight colour detection in
162wx.SystemSettings.
3c1705d9 163
aeee37c3
RD
164wxGTK: Commited scrollbar patch #1093339 which sends lineup, linedown
165events based on intercepting the mouse down events.
166
167wxGTK: Applied patch #1102789 which solved conflicts between wxWidgets
168and GTK+'s context menu code.
169
170wxGTK: Applied patch #1100327 for correct feedback from DND actions
171(not all actions are allowed).
172
b3b61cda 173Fixed memory leak in wxGrid::UpdateAttr[Rows][Or][Cols] (patch 1104355)
aeee37c3
RD
174
175For efficiency reasons, text controls no longer set the string for
176each text updated event, but rather query for the string value only
177when GetString is called from an event handler.
178
179Added wx.SL_INVERSE style which will cause wx.Slider to invert the min
c6b65b76 180and max ends of the slider.
aeee37c3 181
e6bd0b8b
RD
182Several patches applied, such as #1111174, #1110252 and others, that
183make the generic wx.TreeCtrl (used on wxGTK and wxMac) be more
184conistent with the wxMSW native wx.TreeCtrl.
185
e6bd0b8b
RD
186XRCed:
187 * Edit->Locate command (Ctrl-L) for quick selection of items.
188 Works with event-handling controls (buttons, text fields) but
189 not with labels/sizers.
190 * Some improvements: relative paths for files supplied as command-
191 line argument work correctly, notebook panels are highlighted
192 better.
193
194wxMac: Fixed a long-standing issue where wxSlider controls with a
195hardcoded size would misplace their labels behind the slider control.
196
197wx.HtmlListBox fixed so calling RefreshLine(s) will cause the data for
b3b61cda
RD
198that line to be refetched from the overridden methods in the derived
199class.
e6bd0b8b
RD
200
201The default DoGetBestSize now includes the difference (if any) between
b3b61cda
RD
202the client size and total size of the window, (such as the size of
203borders.) Code that sets the client size using the best size, or that
204added extra space to sizers to compensate for this bug may need to be
205changed.
206
207Can suppress themed notebook pages with the wxNB_NOPAGETHEME style or
208setting system option msw.notebook.themed-background to 0.
209
210wxSyledTextCtrl updated to use Scintilla 1.62.
211
212Can now set the msw.window.no-clip-children system option to 1 to
213eliminate weird refresh behaviour (delays between a window being
214erased and repainted, giving a ghostly gradual-redraw effect). May be
215a temporary 'fix' until properly fixed before 2.6.
e6bd0b8b 216
b3b61cda 217wxMac: CoreGraphics [[WRITE MORE HERE]]
e6bd0b8b 218
b3b61cda
RD
219wxMac: Toolbar is now more native looking with borderless toolbar
220buttons.
e6bd0b8b 221
b3b61cda 222Added wx.DatePickerCtrl.
aeee37c3 223
7aada1e0 224
ca8071ca
RD
225
226
0dece789 2272.5.3.1
4f5ff1b2
RD
228-------
229
230wxMac focus and border refreshes corrected.
231
232Updated internal PNG library.
233
234wxMac fix for metal appearance on wx.ToolBar.
235
236wx.grid.Grid fix allowing DoGetBestSize to be called before CreateGrid
237(which means that a min size doesn't need to be specified.)
238
239wxMac fix for not sending a native click to a control if it is not
240enabled (does an enable itself)
241
31b46829
RD
242Added wx.lib.ogl.DrawnShape, and fixed various little bugs in the new
243OGL.
4f5ff1b2
RD
244
245Added support to XRC and XRCed for the 3-state checkbox flags and also
246for wx.ToggleButton. Updated the generic window styles supported by
247XRCed.
248
249It is now possible to create "stock" buttons. Basically this means
71e60f70
RD
250that you only have to provide one of the stock IDs (and either an
251empty label or a label that matches the stock label) when creating the
252button and wxWidgets will choose the stock label to go with it
253automatically. Additionally on the platforms that have a native
254concept of a stock button (currently only GTK2) then the native stock
255button will be used. For example, the following will result in a
e6bd0b8b
RD
256button with "Cancel" as the label and if run on wxGTK2 then there will
257also be an image of a red X::
4f5ff1b2
RD
258
259 b = wx.Button(parent, wx.ID_CANCEL)
260
261
262Added wx.lib.ticker.Ticker class from Chris Mellon.
263
71e60f70
RD
264Fix some incorrect clipping regions in wxSTC on wxGTK.
265
266Added wrapper for wx.grid.Grid.GetOrCreateCellAttr.
267
11908acc
RD
268Removed my copy of distutils from the wxPython source tree. Now that
269I am no longer doing builds on Python 2.1 the newest distutils is no
270longer needed. (There is still one small bug in Python 2.2 distutils
271on win32, but it is easily worked around.) This sovles the problem of
272incorrect builds on some systems where the system installed distutils
273has been patched to behave slightly differently, for example SuSE on
274x86_64 or Chandler's build.
275
da72c540
RD
276Updated to SWIG 1.3.22 (plus my patch.) See wxPython/SWIG/README.txt
277in the source tree if you need to use SWIG when building your own copy
278of wxPython, or other extension modules that need to integrate with
279the wxPython modules.
280
6afcb800
RD
281Added wx.Frame.RequestUserAttention which, if the platform suports it,
282will do something (such as flash the task bar item) to suggest to the
283user that they should look at that window.
284
31b46829
RD
285"Fixed" wx.grid.Grid.SetDefaultEditor and SetDefaultRenderer by making
286them register the editor or renderer for the "string" data type.
287
288Added depth param to wx.Image.ConvertToBitmap.
289
290Extended the wx.calendar.CalendarCtrl class with methods that get/set
291a Python datetime or date object. (These will only work with Python
2922.3+) The methods are PySetDate, PyGetDate, PySetLowerDateLimit,
293PySetUpperDateLimit, PySetDateRange, PyGetLowerDateLimit, and
5f13b2ca
RD
294PyGetUpperDateLimit. Also, CalendarEvent was extended with PySetDate
295and PyGetDate methods.
31b46829 296
6c3f6fe9
RD
297wxMSW: SetBackgroundColour on a wx.Choice or a wx.ComboBox will now
298also set the colour of the dropdown.
299
8dca2f3d
RD
300wxMac: MessageDialog now supports wx.NO_DEFAULT style
301
302wxMSW: added AssociateHandle and DissociateHandle to wx.Window
303
304wxMac: fix for toolbar tooltips
305
306wx.Sizer.Show (and Hide) now take an optional parameter specifying if
307the item to be shown should be searched for recursivly in subsizers,
308and return a boolean value indicating if the item was found.
309
96d49f0e
RD
310wxMSW: fixed MaximizeEvent generation in wx.Frame
311
312wxMSW: fixed sending duplicate EVT_COMBOBOX events
313
314Smoother time estimation updates in wx.ProgressDialog (patch 992813)
315
316Made wx.Listbook events more consistent with wx.Notebook ones (patch
3171001271)
318
319Fixed rounding errors in variable status bar panes widths computation
320(patch 1030021)
321
322Added possibility to specify printer bin (patch 910272)
323
324wxMSW: fixed wx.ListCtrl's SetWindowStyleFlag() to not remove
325WS_VISIBLE; also refresh the control automatically (closes bug
3261019440)
327
328Added wx.Choicebook, yet another notebook-like control.
329
330wxMSW: Make radiobutton tab behaviour the same on MSW as in standard
331MSW app, i.e. tab into the activated, not necessarily the first radio
332button.
333
334Added limited support for wxEventLoop (you can't derive from a
335wx.PyEventLoop version yet...) Updated and moved the sample showing
336how to replace the MainLoop to samples/mainloop/mainloop.py.
8dca2f3d 337
38b97c15
RD
338The C++ xrc lib has been moved out of contrib and into the core, so it
339is always built by default. wxPython's build has also changed
340accordingly and will build the xrc module as part of the core set of
341modules built by default. If you were axplicitly using BUILD_XRC then
342it will no longer be recognized as a build option, otherwise you
343should notice no difference.
344
c0e1f6b6
RD
345wxMac: Fixed radio toolbar buttons to correctly untoggle the others
346when a new one is selected.
347
348wxMac: Fixed GetLineLength and GetLineText for MLTE text controls
349
350wxMac: wx.TaskBarIcon is implemented by allowing you to change the
351app's icon on the Dock and also specifying a menu that should be
352merged with the normal dock popup menu. See the MigrationGuide for
353more details and a warning.
354
355Added wx.TopLevelWindow.IsActive() which tells you if the frame or
356dialog is or containts the active window with the keyboard focus.
357
358Added ability to create a font based on pixel size rather than point
359size via the FontFromPixelSize constructor.
360
361Updated the Scintilla used by StyledTextCtrl to version 1.61
362
363Improved image HitTest for TreeListCtrl.
364
365Added wx.App.IsMainLoopRunning.
366
367wxGTK: Make wxComboBox spit out a bit fewer surplus events when
368holding down the mouse button.
369
370wxGTK: Enable key based navigation through notebook tabs as in the
371native control with Left and right keys. Support for vetoing.
372
f54a36bb
RD
373FloatCanvas updates from Chris Barker
374
375PyPlot updates from Gordon Williams:
376 - Added bar graph demo
377 - Modified line end shape from round to square.
b31cbeb9
RD
378 - Removed FloatDCWrapper for conversion to ints and ints in
379 arguments
380 - Imported modules given leading underscore to name.
381 - Added Cursor Line Tracking and User Point Labels.
382 - Demo for Cursor Line Tracking and Point Labels.
383 - Size of plot preview frame adjusted to show page better.
384 - Added helper functions PositionUserToScreen and
385 PositionScreenToUser in PlotCanvas.
386 - Added functions GetClosestPoints (all curves) and GetClosestPoint
387 (only closest curve) can be in either user coords or screen
388 coords.
f54a36bb 389
f54a36bb
RD
390MaskedEdit updates from Will Sadkin:
391 - Added '*' mask char that means "all ansii chars" (ords 32-255)
392 - Added proper unicode support to masked controls and wx.tools.dbg
393 - Fixed two reported missing import bugs introduced by package
394 creation
395 - Converted masked package doc strings to reST format for better
396 epydoc support
397 - lots of doc string improvements and function hiding to better
398 reflect package's public contents.
399
15513a80
RD
400Restructured the installer packages slightly to help facilitate having
401multiple versions of wxPython installed at the same time. See the
402Migrarion Guide for more information.
403
404Applied patch from Pim Van Heuven that modifies 4 files:
405 - wxPython/demo/ListCtrl_edit.py (new demo)
406 - wxPython/demo/Main.py (include new demo in demo app)
407 - wxPython/wx/lib/mixins/listctrl.py (several improvements to
408 TextEditMixin)
409 - wxPython/wx/lib/wxpTag.py (some small fixes)
38b97c15 410
f6f1e19f
RD
411Added (thanks to Kevin Ollivier!) wrappers for wx.WebKitCtrl for the
412OSX build. Other platforms will raise an exception if you try to use
413it.
414
85245f48
RD
415wxPython on OSX can now be built in Unicode mode, can support multiple
416version installs, and comes with an uninstaller script.
417
418
4f5ff1b2
RD
419
420
3801d366
RD
421
4222.5.2.8
423-------
424
b5f2d1f3
RD
425Predominantly a bug-fix release.
426
427 * Fixed fatal error due to improper wrapping of wx.FSFile.
428
429 * Fixed return type of EditableListBox.GetListCtrl
430
431 * Give generic tree and list controls a DoGetBestSize so they play
432 nicer with sizers when there is no minimal size.
433
434 * Some tweaks in the demo and samples to correct layout, some
435 flicker problems, and namespace use.
436
437 * Add wx.Image.ConvertAlphaToMask
438
439 * Minor corrections in wx.lib.dialogs
440
441 * wx.FileHistory constructor now accepts the documented 2nd
442 parameter.
443
444 * Corrections for exceptions in the new ogl
445
446 * Fixed XRCed to not use reparenting of windows to implement caching
447 of property panels, since Reparent on wxMac is not implemented.
448
449 * Add support for wxTAB_TRAVERSAL to the XRC handler for
450 wxScrolledWindow.
451
452 * Add support for all wxListBox styles to the XRC handler for
453 wxCheckListBox.
454
455 * Fix for wx.Listbook.DeleteAllPages to really delete everything.
456
457 * wxGTK2 now supports alpha blended bitmap drawing
458
9c618512
RD
459 * Made wx.grid.Grid play nicer with sizers.
460
b5f2d1f3 461 * etc.
3801d366
RD
462
463
464
465
e155ca47 4662.5.2.7
95fed4d8
RD
467-------
468
469wx.ADJUST_MINSIZE is now the default behaviour for window items in
ffcb969e
RD
470sizers. This means that the item's GetMinSize and/or GetBestSize will
471be called when calculating layout and the return value from that will
cb8f28ba
RD
472be used for the minimum size used by the sizer. The wx.FIXED_MINSIZE
473flag was added that will cause the sizer to use the old behaviour in
474that it will *not* call the window's methods to determine the new best
475size, instead the minsize that the window had when added to the sizer
da2c7672
RD
476(or the size the window was created with) will always be used. Please
477see the Sizers section in the Migration Guide for more details.
cb8f28ba 478
c878ceea
RD
479Added new MaskedEditControl code from Will Sadkin. The modules are
480now locaed in their own sub-package, wx.lib.masked. Demos updated.
481
d7403ad2
RD
482The changes that implemented the incompatible wx.DC methods in 2.5.1.5
483have been reverted. The wx.DC methods are now compatible with the 2.4
484implemetation. In addition a set of renamed methods have been added
485that take wx.Point and/or wx.Size objects instead of individual
486parameters.
487
5841276a
RD
488Added wx.lib.mixins.listctrl.TextEditMixin, a mixin class that allows
489all columns of a wx.ListCtrl in report mode to be edited.
ba938c3d 490
165e6ca3
RD
491Deprecated the wx.iewin module.
492
493Deprecated the wx.Sizer.AddWindow, AddSizer, AddSpacer methods as well
494as their Insert* and Prepend* counterparts.
495
969d9b6f
RD
496Added a generic StaticBitmap class in wx.lib.statbmp for the same
497reasons that stattext was created, so it could be mouse sensitive on
498all platforms like normal windows. Also updated stattext.py and
499buttons.py to handle attribute (font & colour) defaults and
500inheritance the new way. If you have custom controls of your own you
501should review stattxt.py or one of the others to see how it is to be
502done.
165e6ca3 503
a3150741
RD
504wx.InitAllImageHandlers is now an empty function that does nothing but
505exist for backwards compatibility. The C++ version is now called
506automatically when wxPython is initialized. Since all the handlers
507are included in the wxWidgets shared library anyway, this imposes only
508a very small amount of overhead and removes several unneccessary
509problems.
510
d1e05453 511Replaced wx/lib/pubsub.py with a version that uses weak references to
89c876de
RD
512track the subscribers, plus other fixes/additions. Thanks go to
513Oliver Schoenborn and Robb Shecter.
d1e05453 514
89c876de
RD
515wxGTK now uses gtk_init_check so wxPython can raise an exception if
516there is no DISPLAY available or other initializaion problem.
517
518wx.GetKeyState now has an implementation for wxGTK and is able to
519detect the up/down or toggle state of modifier and toggle keys.
520
521The LC_NUMERIC locale is now reset back to "C" (compatibility) when
522running on wxGTK to work around the fact that GTK requires the locale
523to be set to the system settings but Python depends on LC_NUMERIC
524remaining compatible with "C".
a3150741 525
28eab81f
RD
526Switched gizmos.TreeListCtrl to the newer version of the code from the
527wxCode project.
528
f847103a
RD
529OGL is dead! LONG LIVE OGL! (Oops, sorry. A bit of my dramatic side
530leaked out there...) The wx.ogl module has been deprecated in favor
531of the new Python port of the OGL library located at wx.lib.ogl
532