]>
Commit | Line | Data |
---|---|---|
1 | ------------------------------------------------------------------------------- | |
2 | wxWidgets Change Log | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | INCOMPATIBLE CHANGES SINCE 2.8.x | |
6 | ================================ | |
7 | ||
8 | ||
9 | Notice that these changes are described in more details in | |
10 | the "Changes Since wxWidgets 2.8" section of the manual, | |
11 | please read it if the explanation here is too cryptic. | |
12 | ||
13 | ||
14 | Unicode-related changes | |
15 | ----------------------- | |
16 | ||
17 | The biggest changes in wxWidgets 3.0 are the changes due to the merge of the | |
18 | old ANSI and Unicode build modes in a single build. See the Unicode overview | |
19 | in the manual for more details but here are the most important incompatible | |
20 | changes: | |
21 | ||
22 | - Many wxWidgets functions taking "const wxChar *" have been changed to take | |
23 | either "const wxString&" (so that they accept both Unicode and ANSI strings; | |
24 | the argument can't be NULL anymore in this case) or "const char *" (if the | |
25 | strings are always ANSI; may still be NULL). This change is normally | |
26 | backwards compatible except: | |
27 | ||
28 | a) Virtual functions: derived classes versions must be modified to take | |
29 | "const wxString&" as well to make sure that they continue to override the | |
30 | base class version. | |
31 | ||
32 | b) Passing NULL as argument: as NULL can't be unambiguously converted to | |
33 | wxString, in many cases code using it won't compile any more and NULL | |
34 | should be replaced with an empty string. | |
35 | ||
36 | ||
37 | - Some structure fields which used to be of type "const wxChar *" (such as | |
38 | wxCmdLineEntryDesc::shortName, longName and description fields) are now of | |
39 | type "const char *", you need to remove wxT() or _T() around the values used | |
40 | to initialize them (which should normally always be ASCII). | |
41 | ||
42 | - wxIPC classes didn't work correctly in Unicode build before, this was fixed | |
43 | but at a price of breaking backwards compatibility: many methods which used | |
44 | to work with "wxChar *" before use "void *" now (some int parameters were | |
45 | also changed to size_t). While wxIPC_TEXT can still be used to transfer 7 | |
46 | bit text, the new wxIPC_UTF8TEXT format is used for transferring wxStrings. | |
47 | Also notice that connection classes should change the parameter types of | |
48 | their overridden OnExecute() or override a more convenient OnExec() instead. | |
49 | ||
50 | ||
51 | wxODBC and contrib libraries removal | |
52 | ------------------------------------ | |
53 | ||
54 | wxODBC library was unmaintained since several years and we couldn't continue | |
55 | supporting it any longer so it was removed. Please use any of the other open | |
56 | source ODBC libraries in the future projects. | |
57 | ||
58 | Also the "applet", "deprecated", "fl", "mmedia" and "plot" contrib libraries | |
59 | were removed as they were unmaintained and broken since several years. | |
60 | The "gizmos", "ogl", "net" and "foldbar" contribs have been moved to | |
61 | wxCode (see http://wxcode.sourceforge.net/complist.php); they are now | |
62 | open for futher development by volunteers. | |
63 | ||
64 | The "stc" and "svg" contribs instead have been moved respectively into a new | |
65 | "official" library stc and in the core lib. | |
66 | ||
67 | ||
68 | Changes in behaviour not resulting in compilation errors, please read this! | |
69 | --------------------------------------------------------------------------- | |
70 | ||
71 | - Default location of wxFileConfig files has changed under Windows, you will | |
72 | need to update your code if you access these files directly. | |
73 | ||
74 | - wxWindow::IsEnabled() now returns false if a window parent (and not | |
75 | necessarily the window itself) is disabled, new function IsThisEnabled() | |
76 | with the same behaviour as old IsEnabled() was added. | |
77 | ||
78 | - Generating wxNavigationKeyEvent events doesn't work any more under wxGTK (and | |
79 | other platforms in the future), use wxWindow::Navigate() or NavigateIn() | |
80 | instead. | |
81 | ||
82 | - Sizers distribute only the extra space between the stretchable items | |
83 | according to their proportions and not all available space. We believe the | |
84 | new behaviour corresponds better to user expectations but if you did rely | |
85 | on the old behaviour you will have to update your code to set the minimal | |
86 | sizes of the sizer items to be in the same proportion as the items | |
87 | proportions to return to the old behaviour. | |
88 | ||
89 | - wxWindow::Freeze/Thaw() are not virtual any more, if you overrode them in | |
90 | your code you need to override DoFreeze/Thaw() instead now. | |
91 | ||
92 | - wxCalendarCtrl has native implementation in wxGTK, but it has less features | |
93 | than the generic one. The native implementation is used by default, but you | |
94 | can still use wxGenericCalendarCtrl instead of wxCalendarCtrl in your code if | |
95 | you need the extra features. | |
96 | ||
97 | - wxDocument::FileHistoryLoad() and wxFileHistory::Load() now take const | |
98 | reference to wxConfigBase argument and not just a reference, please update | |
99 | your code if you overrode these functions and change the functions in the | |
100 | derived classes to use const reference as well. | |
101 | ||
102 | - Under MSW wxExecute() arguments are now always properly quoted, as under | |
103 | Unix, and so shouldn't contain quotes unless they are part of the argument. | |
104 | ||
105 | - wxDocument::OnNewDocument() doesn't call OnCloseDocument() any more. | |
106 | ||
107 | - If you use wxScrolledWindow::SetTargetWindow() you must implement its | |
108 | GetSizeAvailableForScrollTarget() method, please see its documentation for | |
109 | more details. | |
110 | ||
111 | ||
112 | Changes in behaviour which may result in compilation errors | |
113 | ----------------------------------------------------------- | |
114 | ||
115 | - WXWIN_COMPATIBILITY_2_4 doesn't exist any more, please update your code if | |
116 | you still relied on features deprecated since version 2.4 | |
117 | ||
118 | - wxDC classes hierarchy has changed, if you derived any classes from wxDC you | |
119 | need to review them as wxDC doesn't have any virtual methods any longer and | |
120 | uses delegation instead of inheritance to present different behaviours. | |
121 | ||
122 | - wxWindow::ProcessEvent() (and other wxEvtHandler functions inherited by wxWindow) | |
123 | has been made protected to prevent wrongly using it instead of correct | |
124 | GetEventHandler()->ProcessEvent(). | |
125 | New ProcessWindowEvent() was added for convenience. | |
126 | ||
127 | - Return type of wxString::operator[] and wxString::iterator::operator* is no | |
128 | longer wxChar (i.e. char or wchar_t), but wxUniChar. This is not a problem | |
129 | in vast majority of cases because of conversion operators, but it can break | |
130 | code that depends on the result being wxChar. | |
131 | ||
132 | - The value returned by wxString::c_str() cannot be casted to non-const char* | |
133 | or wchar_t* anymore. The solution is to use newly added wxString methods | |
134 | char_str() (which returns a buffer convertible to char*) or wchar_str() | |
135 | (which returns a buffer convertible to wchar_t*). These methods are | |
136 | available in wxWidgets 2.8 series beginning with 2.8.4 as well. | |
137 | ||
138 | - The value returned by wxString::operator[] or wxString::iterator cannot be | |
139 | used in switch statements anymore, because it's a class instance. Code like | |
140 | this won't compile: | |
141 | switch (str[i]) { ... } | |
142 | and has to be replaced with this: | |
143 | switch (str[i].GetValue()) { ... } | |
144 | ||
145 | - Return type of wxString::c_str() is now a helper wxCStrData struct and not | |
146 | const wxChar*. wxCStrData is implicitly convertible to both "const char *" | |
147 | and "const wchar_t *", so this only presents a problem if the compiler cannot | |
148 | apply the conversion. This can happen in 2 cases: | |
149 | ||
150 | + There is an ambiguity because the function being called is overloaded to | |
151 | take both "const char *" and "const wchar_t *" as the compiler can't choose | |
152 | between them. In this case you may use s.wx_str() to call the function | |
153 | matching the current build (Unicode or not) or s.mb_str() or s.wc_str() to | |
154 | explicitly select narrow or wide version of it. | |
155 | ||
156 | Notice that such functions are normally not very common but unfortunately | |
157 | Microsoft decided to extend their STL with standard-incompatible overloads | |
158 | of some functions accepting "const wchar_t *" so you may need to replace | |
159 | some occurrences of c_str() with wx_str() when using MSVC 8 or later. | |
160 | ||
161 | + Some compilers, notably Borland C++ and DigitalMars, don't correctly | |
162 | convert operator?: operands to the same type and fail with compilation | |
163 | error instead. This can be worked around by explicitly casting to const | |
164 | wxChar*: wxLogError(_("error: %s"), !err.empty() ? (const wxChar*)err.c_str() : "") | |
165 | ||
166 | - wxCtime() and wxAsctime() return char*; this is incompatible with Unicode | |
167 | build in wxWidgets 2.8 that returned wchar_t*. | |
168 | ||
169 | - DigitalMars compiler has a bug that prevents it from using | |
170 | wxUniChar::operator bool in conditions and it erroneously reports type | |
171 | conversion ambiguity in expressions such as this: | |
172 | for ( wxString::const_iterator p = s.begin(); *p; ++p ) | |
173 | This can be worked around by explicitly casting to bool: | |
174 | for ( wxString::const_iterator p = s.begin(); (bool)*p; ++p ) | |
175 | ||
176 | - Virtual wxHtmlParser::AddText() takes wxString, not wxChar*, argument now. | |
177 | ||
178 | - Functions that took wxChar* arguments that could by NULL in wxWidgets 2.8 | |
179 | are deprecated and passing NULL to them won't compile anymore, wxEmptyString | |
180 | must be used instead. | |
181 | ||
182 | - wxTmemxxx() functions take either wxChar* or char*, not void*: use memxxx() | |
183 | with void pointers. | |
184 | ||
185 | - Removed insecure wxGets() and wxTmpnam() functions. | |
186 | ||
187 | - Removed global GetLine() function from wx/protocol/protocol.h, use | |
188 | wxProtocol::ReadLine() instead. | |
189 | ||
190 | - wxVariant no longer derives from wxObject. wxVariantData also no longer | |
191 | derives from wxObject; instead of using wxDynamicCast with wxVariantData you | |
192 | can use the macro wxDynamicCastVariantData with the same arguments. | |
193 | ||
194 | - wxWindow::Next/PrevControlId() don't exist any more as they couldn't be | |
195 | implemented correctly any longer because automatically generated ids are not | |
196 | necessarily allocated consecutively now. Use GetChildren() to find the | |
197 | next/previous control sibling instead. | |
198 | ||
199 | - Calling wxConfig::Write() with an enum value will fail to compile because | |
200 | wxConfig now tries to convert all unknown types to wxString automatically. | |
201 | The simplest solution is to cast the enum value to int. | |
202 | ||
203 | - Several wxImage methods which previously had "long bitmaptype" parameters | |
204 | have been changed to accept "wxBitmapType bitmaptype", please use enum | |
205 | wxBitmapType in your code. | |
206 | ||
207 | - wxGridCellEditor::EndEdit() signature has changed and it was split in two | |
208 | functions, one still called EndEdit() and ApplyEdit(). See the documentation | |
209 | of the new functions for more details about how grid editors should be | |
210 | written now. | |
211 | ||
212 | - wxEVT_GRID_CELL_CHANGE event renamed to wxEVT_GRID_CELL_CHANGED and shouldn't | |
213 | be vetoed any more, use the new wxEVT_GRID_CELL_CHANGING event to do it. | |
214 | ||
215 | - Now wxWidgets at startup in debug builds checks if all wxEvent-derived classes | |
216 | correctly implement the Clone() function, logging a warning if they don't. | |
217 | A correct implementation for MyCustomEventClass::Clone() is simply: | |
218 | virtual wxEvent *Clone() const { return new MyCustomEventClass(*this); } | |
219 | ||
220 | ||
221 | Deprecated methods and their replacements | |
222 | ----------------------------------------- | |
223 | ||
224 | - wxCreateGreyedImage() deprecated, use wxImage::ConvertToGreyscale() instead. | |
225 | - wxString::GetWriteBuf() and UngetWriteBuf() deprecated, using wxStringBuffer | |
226 | or wxStringBufferLength instead. | |
227 | - wxDIRCTRL_SHOW_FILTERS style is deprecated, filters are alwsys shown if | |
228 | specified so this style should simply be removed | |
229 | - wxDocManager::MakeDefaultName() replaced by MakeNewDocumentName() and | |
230 | wxDocument::GetPrintableName() with GetUserReadableName() which are simpler | |
231 | to use | |
232 | - wxXmlProperty class was renamed to wxXmlAttribute in order to use standard | |
233 | terminology. Corresponding wxXmlNode methods were renamed to use | |
234 | "Attribute" instead of "Property" or "Prop" in their names. | |
235 | - wxConnection::OnExecute() is not formally deprecated yet but new code should | |
236 | use simpler OnExec() version which is called with wxString argument | |
237 | - wxMenuItem::GetLabel has been deprecated in favour of wxMenuItem::GetItemLabelText | |
238 | - wxMenuItem::GetText has been deprecated in favour of wxMenuItem::GetItemLabel | |
239 | - wxMenuItem::GetLabelFromText has been deprecated in favour of wxMenuItem::GetLabelText | |
240 | - wxMenuItem::SetText has been deprecated in favour of wxMenuItem::SetItemLabel | |
241 | - wxBrush's, wxPen's SetStyle() and GetStyle() as well as the wxBrush/wxPen ctor now take | |
242 | respectively a wxBrushStyle and a wxPenStyle value instead of a plain "int style"; | |
243 | use the new wxBrush/wxPen style names (wxBRUSHSTYLE_XXX and wxPENSTYLE_XXX) instead | |
244 | of the old deprecated wxXXX styles (which however are still available). | |
245 | - EVT_GRID_CELL_CHANGE was deprecated, use EVT_GRID_CELL_CHANGED instead if you | |
246 | don't veto the event in its handler and EVT_GRID_CELL_CHANGING if you do. | |
247 | - EVT_CALENDAR_DAY event has been deprecated, use EVT_CALENDAR_SEL_CHANGED. | |
248 | - EVT_CALENDAR_MONTH and EVT_CALENDAR_YEAR events are deprecated, | |
249 | use EVT_CALENDAR_PAGE_CHANGED which replaces both of them. | |
250 | - wxCalendarCtrl::EnableYearChange() and wxCAL_NO_YEAR_CHANGE are deprecated. | |
251 | There is no replacement for this functionality, it is being dropped as it is | |
252 | not available in native wxCalendarCtrl implementations. | |
253 | - wxDC::SetClippingRegion(const wxRegion&) overload is deprecated as it used | |
254 | different convention from the other SetClippingRegion() overloads: wxRegion | |
255 | passed to it was interpreted in physical, not logical, coordinates. Replace | |
256 | it with SetDeviceClippingRegion() if this was the correct thing to do in your | |
257 | code. | |
258 | - wxTE_AUTO_SCROLL style is deprecated as it's always on by default anyhow. | |
259 | - wxThreadHelper::Create() has been deprecated in favour of wxThreadHelper::CreateThread | |
260 | which has a better name for a mix-in class, and allows setting the thread type. | |
261 | - wxDos2UnixFilename, wxUnix2DosFilename, wxStripExtension, wxGetTempFileName, | |
262 | wxExpandPath, wxContractPath, wxRealPath, wxCopyAbsolutePath, wxSplitPath | |
263 | were deprecated in favour of wxFileName methods. See docs for more info. | |
264 | - global wxPendingEvents and wxPendingEventsLocker objects were removed; now you may use | |
265 | wxEventLoopBase::SuspendProcessingOfPendingEvents instead of locking wxPendingEventsLocker. | |
266 | ||
267 | Major new features in this release | |
268 | ---------------------------------- | |
269 | ||
270 | - wxWidgets is now always built with Unicode support but provides the same | |
271 | simple (i.e. "char *"-tolerant) API as was available in ANSI build in the | |
272 | past. | |
273 | ||
274 | - wxWidgets may now use either wchar_t (UTF-16/32) or UTF-8 internally, | |
275 | depending on what is optimal for the target platform. | |
276 | ||
277 | - New propgrid library containing wxPropertyGrid and related classes. | |
278 | ||
279 | - Many enhancements to wxDataViewCtrl. | |
280 | ||
281 | - Event loops, timers and sockets can now be used in wxBase, without GUI. | |
282 | ||
283 | - Events can now be connected to any functor, not necessarily a method of | |
284 | wxEvtHandler-derived class. The compile-time safety was also improved. | |
285 | ||
286 | - Documentation for wxWidgets has been converted from LaTex to C++ headers | |
287 | with Doxygen comments and significantly improved in the process (screenshots | |
288 | of various controls were added, more identifiers are now linked to their | |
289 | definition &c). Any reports about inaccuracies in the documentation are | |
290 | welcome (and due to using the simple Doxygen syntax it is now easier than | |
291 | ever to submit patches correcting them! :-) | |
292 | ||
293 | - Support for persistent objects automatically saving and restoring their state | |
294 | was added. | |
295 | ||
296 | ||
297 | 2.9.0 | |
298 | ----- | |
299 | ||
300 | All: | |
301 | ||
302 | - Added (experimental) IPv6 support to wxSocket (Arcen). | |
303 | - Cleaned up wxURI and made it Unicode-friendly. | |
304 | - Add support for wxExecute(wxEXEC_ASYNC) in wxBase (Lukasz Michalski) | |
305 | - Added wxXLocale class and xlocale-like functions using it. | |
306 | - Allow loading message catalogs from wxFileSystem (Axel Gembe) | |
307 | - Added wxMessageQueue class for inter-thread communications | |
308 | - Use UTF-8 for Unicode data in wxIPC classes (Anders Larsen) | |
309 | - Added support for user-defined types to wxConfig (Marcin Wojdyr). | |
310 | - Added numeric options support to wxCmdLineParser (crjjrc) | |
311 | - Added wxJoin() and wxSplit() functions (Francesco Montorsi). | |
312 | - Added wxDateTime::FormatISOCombined() and ParseISODate/Time/Combined() | |
313 | - Added wxMutex::LockTimeout() (Aleksandr Napylov). | |
314 | - Added wxMemoryInputStream(wxInputStream&) ctor (Stas Sergeev). | |
315 | - Implemented wxMemoryInputStream::CanRead(). | |
316 | - Implemented wxMemoryFSHandler::FindFirst/Next(). | |
317 | - Added wxEventLoop::DispatchTimeout(). | |
318 | - Added wxEXEC_BLOCK flag (Hank Schultz). | |
319 | - Add support for wxStream-derived classes to wxRTTI (Stas Sergeev). | |
320 | - Added wxStreamBuffer::Truncate() (Stas Sergeev). | |
321 | - Allow using wxEventLoop in console applications (Lukasz Michalski). | |
322 | - Added functions for Base64 en/decoding (Charles Reimers). | |
323 | - Added support for binary data to wxConfig (Charles Reimers). | |
324 | - Added functions for atomically inc/decrementing integers (Armel Asselin). | |
325 | - wxLogInterposer has been added to replace wxLogPassThrough and new | |
326 | wxLogInterposerTemp was added. | |
327 | - Added support for broadcasting to UDP sockets (Andrew Vincent). | |
328 | - Documentation now includes the wx library in which each class is defined. | |
329 | - wxrc --gettext now generates references to source .xrc files (Heikki | |
330 | Linnakangas). | |
331 | - wxVariant::Unshare allows exclusive allocation of data that must be shared, | |
332 | if the wxVariantData::Clone function is implemented. | |
333 | - Added wxWeakRef<T>, wxScopedPtr<T>, wxScopedArray<T>, wxSharedPtr<T> templates | |
334 | and renamed old wx/ptr_{scpd,shrd}.h headers to wx/scoped{ptr,array}.h and | |
335 | wx/sharedptr.h (but old headers are still provided for compatibility). | |
336 | - Added wxVector<T> class templates | |
337 | - Added wxON_BLOCK_EXIT_SET() and wxON_BLOCK_EXIT_NULL() to wx/scopeguard.h. | |
338 | - Added wxEvtHandler::QueueEvent() replacing AddPendingEvent() and | |
339 | wxQueueEvent() replacing wxPostEvent(). | |
340 | - wxString now uses std::[w]string internally by default, meaning that it is | |
341 | now thread-safe if the standard library provided with your compiler is. | |
342 | - Added wxCmdLineParser::AddUsageText() (Marcin 'Malcom' Malich). | |
343 | - Fix reading/writing UTF-7-encoded text streams. | |
344 | - Corrected bug in wxTimeSpan::IsShorterThan() for equal time spans. | |
345 | - Use std::unordered_{map,set} for wxHashMap/Set if available (Jan van Dijk). | |
346 | - Added wxString::Capitalize() and MakeCapitalized(). | |
347 | - Added wxArray::swap(). | |
348 | - Added wxSHUTDOWN_LOGOFF and wxSHUTDOWN_FORCE wxShutdown() flags (troelsk). | |
349 | - Added wxSocket::ShutdownOutput(). | |
350 | - Handle exceptions thrown from overridden wxView::OnCreate() gracefully. | |
351 | - Added wxPATH_RMDIR_FULL/RECURSIVE wxFileName::Rmdir() flags (Marcin Malich). | |
352 | - Added wxStandardPaths::GetAppDocumentsDir(). | |
353 | - Added wx-prefixed versions of DECLARE_NO_{COPY,ASSIGN}_CLASS macros. | |
354 | - Added wxFileName::ReplaceEnvVariable and wxFileName::ReplaceHomeDir. | |
355 | - Added wxProtocol::SetDefaultTimeout(); the default timeout for both wxHTTP and wxFTP | |
356 | protocols is 60 seconds. | |
357 | - Added wxStrnlen() for safe computation of string length. | |
358 | - Added wxImage::Clear() (troelsk) | |
359 | ||
360 | All (Unix): | |
361 | ||
362 | - Added wx-config --optional-libs command line option (John Labenski). | |
363 | - Noticeably (by a factor of ~150) improve wxIPC classes performance. | |
364 | - Configure options --with-opengl and --enable-mediactrl now default to "auto": | |
365 | if OpenGL and GStreamer libraries are available the "gl" and "media" wx libraries | |
366 | are automatically built. | |
367 | ||
368 | All (GUI): | |
369 | ||
370 | - Added wxDataViewCtrl class and helper classes. | |
371 | - Integrated wxPropertyGrid in wxWidgets itself (Jaakko Salli). | |
372 | - Provide native implementation of wxCalendarCtrl under wxMSW and wxGTK. | |
373 | - Added wxHeaderCtrl and allow using it in wxGrid. | |
374 | - Added wxRearrangeList, wxRearrangeCtrl and wxRearrangeDialog. | |
375 | - Added {wxTextCtrl,wxComboBox}::AutoComplete() and AutoCompleteFileNames(). | |
376 | - Added wxH[V]ScrolledWindow (Brad Anderson, Bryan Petty). | |
377 | - Added wxNotificationMessage class for non-intrusive notifications. | |
378 | - Added wxWindow::Show/HideWithEffect(). | |
379 | - Added wxWrapSizer (Arne Steinarson). | |
380 | - Added wxSpinCtrlDouble (John Labenski). | |
381 | - Support custom labels in wxMessageDialog (Gareth Simpson for wxMac version). | |
382 | - Added wxScrolledWindow::ShowScrollbars(). | |
383 | - Also added wxCANCEL_DEFAULT to wxMessageDialog. | |
384 | - Allow copying text in the log dialogs. | |
385 | - Added multisample (anti-aliasing) support to wxGLCanvas (Olivier Playez). | |
386 |