FALSE, not false

[wxWidgets.git] / docs / changes.txt

diff --git a/docs/changes.txt b/docs/changes.txt
index e86d7983f191f44d815ef650251226b024fb9cf3..bd59434497102daf6d920b4d23c980db3b18c745 100644 (file)
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -4,13 +4,24 @@ wxWindows 2 Change Log
 INCOMPATIBLE CHANGES SINCE 2.2.x
 ================================
 
 INCOMPATIBLE CHANGES SINCE 2.2.x
 ================================
 

+    Please take a few minutes to read the following list, especially
+    paying attention to the most important changes which are marked
+    with '!' in the first column.
+
+    Also please note that you should ensure that WXWIN_COMPATIBILITY_2_2
+    is defined to 1 if you wish to retain maximal compatibility with 2.2
+    series -- however you are also strongly encouraged to try to compile
+    your code without this define as it won't be default any longer in
+    2.6 release.
+
+

 wxBase:
 
 wxBase:
 

-- wxArray<T>::Remove(size_t) has been removed to fix compilation problems
+! wxArray<T>::Remove(size_t) has been removed to fix compilation problems

   under 64 bit architectures, please replace it with RemoveAt() in your
   code.
 
   under 64 bit architectures, please replace it with RemoveAt() in your
   code.
 

-- wxArray<T> macros have been changed to fix runtime problems under 64 bit
+! wxArray<T> macros have been changed to fix runtime problems under 64 bit

   architectures and as a side effect of this WX_DEFINE_ARRAY() can only be
   used now for the pointer types, WX_DEFINE_ARRAY_INT should be used for the
   arrays containing non-pointers.
   architectures and as a side effect of this WX_DEFINE_ARRAY() can only be
   used now for the pointer types, WX_DEFINE_ARRAY_INT should be used for the
   arrays containing non-pointers.


@@ -22,19 +33,36 @@ wxBase:
   by all derived classes, if you have user-defined event classes please
   add "wxEvent *Clone() const { return new MyEvent(*this); }" line to them
 
   by all derived classes, if you have user-defined event classes please
   add "wxEvent *Clone() const { return new MyEvent(*this); }" line to them
 

+- small change to wxStopWatch::Pause() semantics, please see the documentation
+
+- unlikely but possible incompatibility: the definition of TRUE has changed
+  from "1" to "(bool)1" (and the same thing for FALSE), so the code which
+  could be erroneously compiled previously such as doing "return FALSE" from
+  a function returning a pointer would stop compiling now (but this change
+  is not supposed to have any effects on valid code)
+
+- another minor change: wxApp::OnAssert() has a new "cond" argument, you
+  must modify YourApp::OnAssert() signature if you were using it to override
+  the default assert handling.
+
+

 All (GUI):
 
 All (GUI):
 

-- the event type constants are not constants any more but are dynamically
+! the event type constants are not constants any more but are dynamically

   allocated during run-time which means that they can't be used as case labels
   in the switch()es, you must rewrite them to use if()s instead
 
   You may also define WXWIN_COMPATIBILITY_EVENT_TYPES to get the old behaviour
   allocated during run-time which means that they can't be used as case labels
   in the switch()es, you must rewrite them to use if()s instead
 
   You may also define WXWIN_COMPATIBILITY_EVENT_TYPES to get the old behaviour

-  but this is strongly discouraged, please consider changing your codei
+  but this is strongly discouraged, please consider changing your code

   instead!
 
   instead!
 

-- wxDialog does not derive from wxPanel any longer - if you were using it in
+! wxDialog does not derive from wxPanel any longer - if you were using it in

   your code, please update it. The quick fix for the most cases is to replace
   your code, please update it. The quick fix for the most cases is to replace

-  the occurences of wxPanel with wxWindow.
+  the occurrences of wxPanel with wxWindow.
+
+! if you handle (and don't skip) EVT_KEY_DOWN, the EVT_CHAR event is not
+  generated at all, so you must call event.Skip() in your OnKeyDown() if
+  you want to get OnChar() as well

 
 - wxYES_NO is now wxYES | wxNO and the manifest values of both wxYES and wxNO
   have changed (to fix some unfortunate clashes), please check your code to
 
 - wxYES_NO is now wxYES | wxNO and the manifest values of both wxYES and wxNO
   have changed (to fix some unfortunate clashes), please check your code to


@@ -57,9 +85,25 @@ All (GUI):
 - wxEvtHandler cannot be copied/assigned any longer - this never worked but
   now it results in compile-time error instead of run-time crashes
 
 - wxEvtHandler cannot be copied/assigned any longer - this never worked but
   now it results in compile-time error instead of run-time crashes
 

+- WXK_NUMLOCK and WXK_SCROLL keys no longer result in EVT_CHAR() events,
+  they only generate EVT_KEY_DOWN/UP() ones
+
+- the dialogs use wxApp::GetTopWindow() as the parent implicitly if the
+  parent specified is NULL, use wxDIALOG_NO_PARENT style to prevent this
+  from happening
+
+- several obsolete synonyms are only retained in WXWIN_COMPATIBILITY_2_2 mode:
+  for example, use wxScrolledWindow::GetViewStart() now instead of ViewStart()
+  and GetCount() instead of Number() in many classes
+
+- wxCmdLineParser does not use wxLog to output messages anymore.
+  to obtain the previous behaviour, add
+  wxMessageOutput::Set(new wxMessageOutputLog); to your program
+  (you will need to #include <wx/msgout.h>)
+

 wxMSW:
 
 wxMSW:
 

-- build system changed: setup.h is not a static file in include/wx any more
+! build system changed: setup.h is not a static file in include/wx any more

   but is created as part of the build process under lib/<toolkit>/wx/include
   where <toolkit> is of the form (msw|univ)[dll][u][d]. You'll need to update
   the include path in your make/project files appropriately. Furthermore,
   but is created as part of the build process under lib/<toolkit>/wx/include
   where <toolkit> is of the form (msw|univ)[dll][u][d]. You'll need to update
   the include path in your make/project files appropriately. Furthermore,


@@ -68,8 +112,7 @@ wxMSW:
   make/project files.
 
 - child frames appear in the taskbar by default now, use wxFRAME_NO_TASKBAR
   make/project files.
 
 - child frames appear in the taskbar by default now, use wxFRAME_NO_TASKBAR

-  style to avoid it, wxFRAME_FLOAT_ON_PARENT style is now obsolete and has no
-  effect
+  style to avoid it

 
 - all overloads of wxDC::SetClippingRegion() combine the given region with the
   previously selected one instead of replacing it
 
 - all overloads of wxDC::SetClippingRegion() combine the given region with the
   previously selected one instead of replacing it


@@ -78,14 +121,38 @@ wxMSW:
   return the programs directory any longer but its value (this function has
   never been meant to return the programs directory anyhow)
 
   return the programs directory any longer but its value (this function has
   never been meant to return the programs directory anyhow)
 

+- wxHTML apps don't need to include wx/html/msw/wxhtml.rc in resources file
+  anymore. The file was removed from wxMSW
+
+

 Unix ports:
 
 Unix ports:
 

-- You should use `wx-config --cxxflags` in your makefiles instead of
+! You should use `wx-config --cxxflags` in your makefiles instead of

   `wx-config --cflags` for compiling C++ files. CXXFLAGS contains CFLAGS
   and the compiler flags for C++ files only, CFLAGS should still be used
   to compile pure C files.
 
 
   `wx-config --cflags` for compiling C++ files. CXXFLAGS contains CFLAGS
   and the compiler flags for C++ files only, CFLAGS should still be used
   to compile pure C files.
 
 

+wxThread and related classes:
+
+- The thread-related classes have been heavily changed since 2.2.x versions
+  as the old code had many serious problems. This could have resulted in
+  semantical changes other than those mentioned here, please review use of
+  wxThread, wxMutex and wxCondition classes in your code.
+
+! wxCondition now *must* be used with a mutex, please read the (updated) class
+  documentation for details and revise your code accordingly: this change was
+  unfortunately needed as it was impossible to ensure the correct behaviour
+  (i.e. absense of race conditions) using the old API.
+
+- wxMutex is not recursive any more in POSIX implementation (it hasn't been
+  recursive in 2.2.x but was in 2.3.1 and 2.3.2), please refer to the class
+  documentation for the discussion of the recursive mutexes.
+
+- wxMutex::IsLocked() doesn't exist any more and should have never existed:
+  this is was unique example of a thread-unsafe-by-design method.
+
+

 OTHER CHANGES
 =============
 
 OTHER CHANGES
 =============
 


@@ -94,23 +161,36 @@ OTHER CHANGES
 
 wxBase:
 
 
 wxBase:
 

+- wxSemaphore class added, many fixed to wxCondition and wxThread (K.S. Sreeram)

 - fixes to the command line parsing error and usage messages
 - modified wxFileName::CreateTempFileName() to open the file atomically
   (if possible) and, especially, not to leak the file descriptors under Unix
 - memory leak in wxHTTP fixed (Dimitri)
 - fixes to AM_PATH_WXCONFIG autoconf macro
 - added wxHashMap class that replaces type-unsafe wxHashTable and is modelled
 - fixes to the command line parsing error and usage messages
 - modified wxFileName::CreateTempFileName() to open the file atomically
   (if possible) and, especially, not to leak the file descriptors under Unix
 - memory leak in wxHTTP fixed (Dimitri)
 - fixes to AM_PATH_WXCONFIG autoconf macro
 - added wxHashMap class that replaces type-unsafe wxHashTable and is modelled

-  after STL hash_map
+  after (non standard) STL hash_map

 - wxLocale now works in Unicode mode
 - wxLocale can now load message catalogs in arbitrary encoding
 - wxLocale now works in Unicode mode
 - wxLocale can now load message catalogs in arbitrary encoding

+- fixed the bug related to the redrawing on resize introduced in 2.3.2
+- added static wxFontMapper::Get() accessor (use of wxTheFontMapper is now
+  deprecated)
+- added wxShutdown() function (Marco Cavallini)
+- added wxEXPLICIT macro

 
 Unix (Base/GUI):
 
 - wxWindows may be built using BSD and Solaris (and possibly other) make
   programs and not only GNU make
 
 Unix (Base/GUI):
 
 - wxWindows may be built using BSD and Solaris (and possibly other) make
   programs and not only GNU make

+- wxTCP-based IPC classes now support communicating over Unix domain sockets
+- wxWindows may be built as a dynamic shared library under Darwin / Mac OS X
+  lazy linking issues have been solved by linking a single module (.o) into
+  the shared library (two step link using distrib/mac/shared-ld-sh)
+- fixed thread priority setting under Linux

 
 All (GUI):
 
 
 All (GUI):
 

+- it is now possible to set the icons of different sizes for frames (e.g. a
+  small and big ones) using the new wxIconBundle class

 - implemented radio menu items and radio toolbar buttons
 - added possibility to show text in the toolbar buttons
 - added wxArtProvider class that can be used to customize the look of standard
 - implemented radio menu items and radio toolbar buttons
 - added possibility to show text in the toolbar buttons
 - added wxArtProvider class that can be used to customize the look of standard


@@ -127,6 +207,22 @@ All (GUI):
 - added EVT_MENU_OPEN and EVT_MENU_CLOSE events
 - added Hungarian translations (Janos Vegh)
 - added wxImage::SaveFile(filename) method (Chris Elliott)
 - added EVT_MENU_OPEN and EVT_MENU_CLOSE events
 - added Hungarian translations (Janos Vegh)
 - added wxImage::SaveFile(filename) method (Chris Elliott)

+- added wxImage::FloodFill and implemented wxWindowDC::DoFloodFill method
+  for GTK+, Mac, MGL, X11, Motif ports (Chris Elliott)
+- added (platform-dependent) scan code to wxKeyEvent (Bryce Denney)
+- added wxTextCtrl::EmulateKeyPress()
+- Added wxMouseCaptureChangedEvent
+- Added custom character filtering to wxTextValidator
+- wxTreeCtrl now supports incremental keyboard search
+- wxHelpProvider::RemoveHelp added and called from ~wxWindowBase
+  so that erroneous help strings are no longer found as the hash
+  table fills up
+- updated libpng from 1.0.3 to 1.2.4
+- Added wxView::OnClosingDocument so the application can do
+  cleanup.
+- generic wxListCtrl renamed to wxGenericListCtrl, wxImageList
+  renamed to wxGenericImageList, so they can be used on wxMSW
+  (Rene Rivera).

 
 wxMSW:
 
 
 wxMSW:
 


@@ -140,13 +236,32 @@ wxMSW:
 - improvements to wxWindows applications behaviour when the system colours
   are changed
 - fixed wxProgressDialog for ranges > 65535
 - improvements to wxWindows applications behaviour when the system colours
   are changed
 - fixed wxProgressDialog for ranges > 65535

+- wxSpinButton and wxSpinCtrl now support full 32 bit range (if the version
+  of comctl32.dll installed on the system supports it)

 - wxFontEnumerator now returns all fonts, not only TrueType ones
 - bugs in handling wxFrame styles (border/caption related) fixed
 - showing a dialog from EVT_RADIOBUTTON handler doesn't lead to an infinite
   recursion any more
 - wxTextCtrl with wxTE_RICH flag scrolls to the end when text is appended to it
 - the separators are not seen behind the controls added to the toolbar any more
 - wxFontEnumerator now returns all fonts, not only TrueType ones
 - bugs in handling wxFrame styles (border/caption related) fixed
 - showing a dialog from EVT_RADIOBUTTON handler doesn't lead to an infinite
   recursion any more
 - wxTextCtrl with wxTE_RICH flag scrolls to the end when text is appended to it
 - the separators are not seen behind the controls added to the toolbar any more

+- wxLB_SORT style can be used with wxCheckListBox

 - wxWindowDC and wxClientDC::GetSize() works correctly now
 - wxWindowDC and wxClientDC::GetSize() works correctly now

+- Added wxTB_NODIVIDER and wxTB_NOALIGN so native toolbar can be used in FL
+- Multiline labels in buttons are now supoprted (simply use "\n" in the label)
+- Implemented wxMouseCaptureChangedEvent and made wxGenericDragImage check it
+  has the capture before release it.
+- fixed bugs in multiple selection wxCheckListBox
+- default button handling is now closer to expected
+- setting tooltips for wxSlider now works
+- multiple events avoided in wxComboBox
+- tooltip asserts avoided for read-only wxComboBox
+- fixed a race condition during a thread exit and a join
+- fixed a condition where a thread can hang during
+  message/event processing
+- increased space between wxRadioBox label and first radio button
+- don't fail to register remaining window classes if one fails to register
+- set window proc for non-control windows to avoid problems
+  with multiple wxWindows apps running simultaneously

 
 wxGTK:
 
 
 wxGTK:
 


@@ -154,6 +269,24 @@ wxGTK:
 - wxButton now honours wxBU_EXACTFIT
 - wxStaticBox now honours wxALIGN_XXX styles
 - added support for non alphanumeric simple character accelerators ('-', '=')
 - wxButton now honours wxBU_EXACTFIT
 - wxStaticBox now honours wxALIGN_XXX styles
 - added support for non alphanumeric simple character accelerators ('-', '=')

+- new behaviour for wxWindow::Refresh() as it now produces a delayed refresh. 
+  Call the new wxWindow::Update() to force an immediate update
+- support for more SGI hardware (12-bit mode among others)
+- fixed wxDC::Blit() to honour source DC's logical coordinates
+- implemented wxIdleEvent::RequestMore() for simple background tasks
+- implemented wxChoice::Delete()
+- fixed bad memory leak in wxFileDialog (Chris Elliott)
+- made internal GC pool dynamically growable
+
+wxMotif:
+
+- improved colour settings return values (Ian Brown)
+- improved border style handling for wxStaticText (Ian Brown)
+- improved toolbar control alignment
+- implemented wxSpinButton
+- implemented wxCheckListBox
+- fixed wxSpinCtrl and wxStaticLine when used with sizers
+- wxStaticBitmap now shows transparent icons correctly

 
 wxHTML:
 
 
 wxHTML:
 


@@ -192,6 +325,7 @@ All (GUI):
 - wxGrid cell editing veto support (Roger Gammans)
 - wxListCtrl ITEM_FOCUSED event added
 - support for ICO files in wxImage added (Chris Elliott)
 - wxGrid cell editing veto support (Roger Gammans)
 - wxListCtrl ITEM_FOCUSED event added
 - support for ICO files in wxImage added (Chris Elliott)

+- improvements to wxDragImage (Chuck Messenger)

 
 wxMSW:
 
 
 wxMSW:
 


@@ -202,6 +336,14 @@ wxMSW:
 wxGTK:
 
 - fixed popup menu positioning bug
 wxGTK:
 
 - fixed popup menu positioning bug

+- fixed the edit function for wxListCtrl (Chuck Messenger)
+- fixed the key-hitting events for wxListCtrl and wxTreeCtrl, so they
+  correctly return the key which was pressed (Chuck Messenger)
+
+wxMac:
+
+- support for configuration and build under Mac OS X using the Apple Developer
+  Tools

 
 wxHTML:
 
 
 wxHTML:
 


@@ -380,7 +522,7 @@ wxMSW:
 - fixed "missing" initial resize of wxMDIChildFrame
 - wxFrame restores focus better
 - Now ignore wxTHICK_FRAME in wxWindow constructor: only relevant to
 - fixed "missing" initial resize of wxMDIChildFrame
 - wxFrame restores focus better
 - Now ignore wxTHICK_FRAME in wxWindow constructor: only relevant to

-  frames anddialogs, interferes with other window styles otherwise
+  frames and dialogs, interferes with other window styles otherwise

   (sometimes you'd get a thick frame in a subwindow)
 - wxTextCtrl insertion point set to the beginning of the control by SetValue
 - Fix so wxMDIParentFrame is actually shown when Show(TRUE) is called.
   (sometimes you'd get a thick frame in a subwindow)
 - wxTextCtrl insertion point set to the beginning of the control by SetValue
 - Fix so wxMDIParentFrame is actually shown when Show(TRUE) is called.


@@ -463,7 +605,7 @@ all (GUI):
 
 - Added wxImage::Rotate.
 - new wxCalendarCtrl class for picking a date interactively
 
 - Added wxImage::Rotate.
 - new wxCalendarCtrl class for picking a date interactively

-- wxMenu(Bar)::Insert() and Remove() functions for dynamic menu menagament
+- wxMenu(Bar)::Insert() and Remove() functions for dynamic menu management

 - wxToolBar supports arbitrary controls (not only buttons) and can be
   dynamically changed (Delete/Insert functions)
 - vertical toolbars supported by MSW and GTK native wxToolBar classes
 - wxToolBar supports arbitrary controls (not only buttons) and can be
   dynamically changed (Delete/Insert functions)
 - vertical toolbars supported by MSW and GTK native wxToolBar classes


@@ -479,7 +621,7 @@ all (GUI):
 - wxScrolledWindow now has keyboard interface
 - wxTextEntryDialog may be used for entering passwords (supports wxTE_PASSWORD)
 - added wxEncodingConverter and improved wxFontMapper
 - wxScrolledWindow now has keyboard interface
 - wxTextEntryDialog may be used for entering passwords (supports wxTE_PASSWORD)
 - added wxEncodingConverter and improved wxFontMapper

-  for dealing with convertions between different encodings,
+  for dealing with conversions between different encodings,

   charsets support in wxLocale and wxHTML
 - wxDragImage class added
 - samples/help improved to show standard and advanced HTML help
   charsets support in wxLocale and wxHTML
 - wxDragImage class added
 - samples/help improved to show standard and advanced HTML help


@@ -521,11 +663,11 @@ wxHTML:
   including faster search, bookmarks, printing, setup dialog
   and cross-platform binary compatible .cached files for faster
   loading of large helpbooks, case insensitive search
   including faster search, bookmarks, printing, setup dialog
   and cross-platform binary compatible .cached files for faster
   loading of large helpbooks, case insensitive search

-  splitted into 3 parts: wxHtmlHelpData, Frame and Controller
+  split into 3 parts: wxHtmlHelpData, Frame and Controller

 - added support for charsets and <meta> tag
 - added support for font faces and justified paragraphs,
   taken some steps to prepare wxHTML for frames
 - added support for charsets and <meta> tag
 - added support for font faces and justified paragraphs,
   taken some steps to prepare wxHTML for frames

-- added dynamic pushing/poping of wxHtmlParser tag handlers
+- added dynamic pushing/popping of wxHtmlParser tag handlers

 - improved HTML printing
 - added extensive table of HTML characters substitutions (&nbsp; etc.)
 - fixed wxHtmlWindow flickering, several minor bugfixes
 - improved HTML printing
 - added extensive table of HTML characters substitutions (&nbsp; etc.)
 - fixed wxHtmlWindow flickering, several minor bugfixes


@@ -788,7 +930,7 @@ wxMotif:
   global memory operators (usually OK) and #defining new to be
   WXDEBUG_NEW (sometimes it might not be OK).
 - Added time.cpp to makefile; set wxUSE_DATETIME to 1.
   global memory operators (usually OK) and #defining new to be
   WXDEBUG_NEW (sometimes it might not be OK).
 - Added time.cpp to makefile; set wxUSE_DATETIME to 1.

-- Added a parent-existance check to popup menu code to make it not crash.
+- Added a parent-existence check to popup menu code to make it not crash.

 - Added some optimization in wxWindow::SetSize to produce less flicker.
   It remains to be seen whether this produces any resize bugs.
 
 - Added some optimization in wxWindow::SetSize to produce less flicker.
   It remains to be seen whether this produces any resize bugs.
 


@@ -844,7 +986,7 @@ wxMSW:
 - wxConfig API improved, documentation updated.
 - Printing classes name conventions cleaned up.
 - wxUpdateUIEvent now derives from wxCommandEvent
 - wxConfig API improved, documentation updated.
 - Printing classes name conventions cleaned up.
 - wxUpdateUIEvent now derives from wxCommandEvent

-  so event can travel up the window hierachy.
+  so event can travel up the window hierarchy.

 
 Alpha 14, July 31st 1998
 ------------------------
 
 Alpha 14, July 31st 1998
 ------------------------


@@ -1105,7 +1247,7 @@ Generic:
 - Added wxMouseEvent::GetPosition and
   wxMouseEvent::GetLogicalPosition, both returning wxPoints.
 - Made wxSize and wxRect contain longs not ints.
 - Added wxMouseEvent::GetPosition and
   wxMouseEvent::GetLogicalPosition, both returning wxPoints.
 - Made wxSize and wxRect contain longs not ints.

-- Cured some lemory leaks (thanks Vadim).
+- Cured some memory leaks (thanks Vadim).

 - Tidied up OnIdle and introduced RequestMore/MoreRequested so
   will only keep processing OnIdle if it returns TRUE from
   MoreRequested.
 - Tidied up OnIdle and introduced RequestMore/MoreRequested so
   will only keep processing OnIdle if it returns TRUE from
   MoreRequested.


@@ -1134,7 +1276,7 @@ All:
   implementation updated to use these base classes.
 - wxHelpInstance now separated into wxHelpControllerBase (base
   for all implementations), wxWinHelpController (uses standard
   implementation updated to use these base classes.
 - wxHelpInstance now separated into wxHelpControllerBase (base
   for all implementations), wxWinHelpController (uses standard

-  WinHelp), wxXLPHelPController (talks to wxHelp by DDE or
+  WinHelp), wxXLPHelpController (talks to wxHelp by DDE or

   TCP/IP). There will be others eventually, such as
   wxHTMLHelpController for Microsoft (and Netscape?) HTML Help.
 - Added Vadim Zeitlin's wxString class plus
   TCP/IP). There will be others eventually, such as
   wxHTMLHelpController for Microsoft (and Netscape?) HTML Help.
 - Added Vadim Zeitlin's wxString class plus


@@ -1215,7 +1357,7 @@ At this point, the following has been achieved:
   Windows types where needed e.g. WXHWND.
 - PrologIO revised.
 - wxScrolledWindow, wxStatusBar and new MDI classes added.
   Windows types where needed e.g. WXHWND.
 - PrologIO revised.
 - wxScrolledWindow, wxStatusBar and new MDI classes added.

-  MDI is now achived using separate classes, not window styles.
+  MDI is now achieved using separate classes, not window styles.

 - wxSystemSettings added, and made use of to reflect standard
   Windows settings.
 - SetButtonFont/SetLabelFont replaced by SetFont; font and colour
 - wxSystemSettings added, and made use of to reflect standard
   Windows settings.
 - SetButtonFont/SetLabelFont replaced by SetFont; font and colour