continued spinning committed

[wxWidgets.git] / docs / changes.txt

------------------------
wxWidgets 2.5 Change Log
------------------------

INCOMPATIBLE CHANGES SINCE 2.4.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_4
    is defined to 1 if you wish to retain maximal compatibility with 2.4
    series.

! windows are no longer fully repainted when resized, use new style
  wxFULL_REPAINT_ON_RESIZE to force this (wxNO_FULL_REPAINT_ON_RESIZE stll
  exists but doesn't do anything any more, this behaviour is default now)


- no initialization/cleanup can be done in wxApp/~wxApp because they are
  now called much earlier/later than before; please move any exiting code
  from there to wxApp::OnInit()/OnExit()
- also, OnExit() is not called if OnInit() fails
- finally the program exit code is OnRun() return value, not OnExit() one
- wxTheApp can't be assigned to any longer, use wxApp::SetInstance() instead
- wxFileType::GetIcon() returns wxIconLocation, not wxIcon
- wxColourDatabase is not a wxList any more, use AddColour to add new colours
- wxWindow::Clear() is now called ClearBackground()
- pointer returned by wxFont::GetNativeFontInfo() must not be deleted now
- wxMouseEvent::Moving() doesn't return true if mouse is being dragged any more
- (most) controls now inherit parents colours by default, override
  ShouldInheritColours() to return false if you don't want this to happen
- wxApp::SendIdleEvent() now takes 2 arguments
- wxTabView::GetLayers() changed return type from wxList& to wxTabLayerList&
  (when WXWIN_COMPATIBILITY_2_4 == 0)
- wxID_SEPARATOR (id used for the menu separators) value changed from -1 to -2
- wxGetNumberFromUser() is now in separate wx/numdlg.h, not wx/textdlg.h
- wxChoice and wxCombobox now handle their size in the same way as in all the
  other ports under MSW, new code is actually correct but different from weird
  stuff they were doing before so the behaviour of your programs might change
- wxTaskBarIcon objects must now be destroyed before the application can exit.
  Previously, the application terminated if there were no top level windows;
  now it terminates if there are no top level windows or taskbar icons left.
- wxZlibInputStream is not by default compatible with the output of the
  2.4.x version of wxZlibOutputStream. However, there is a compatibilty mode,
  switched on by passing wxZLIB_24COMPATIBLE to the constructor.
- when WXWIN_COMPATIBILITY_2_4 == 0 wxHashTable uses a new implementation
  not using wxList keyed interface (the same used when wxUSE_STL == 1),
  the only incompatibility being that Next() returns a wxHashTable::Node*
  instead of a wxNode*.
- non-const wxDC methods GetBackground(), GetBrush(), GetFont() and GetPen()
  don't exist any more, please fix your code -- it never worked correctly
  anyhow if you modified the objects returned by these methods so you should
  simply switch to using const methods.

wxTaskBarIcon must be explicitly destroyed now, otherwise the application
  won't exit even though there are no top level windows


DEPRECATED METHODS SINCE 2.4.x
==============================

Deprecated methods may still be used but will disappear in future wxWidgets
versions, please update your code to not use them.

- wxDocManager::GetNoHistoryFiles() renamed to GetHistoryFilesCount()
- wxSizer::Remove(wxWindow *), use Detach() instead [it is more clear]
- wxSizer::Set/GetOption(): use Set/GetProportion() instead
- wxKeyEvent::KeyCode(): use GetKeyCode instead
- wxList::Number, First, Last, Nth: use GetCount, GetFirst/Last, Item instead
- wxNode::Next, Previous, Data: use GetNext, GetPrevious, GetData instead
- wxListBase::operator wxList&(): use typesafe lists instead
- wxTheFontMapper: use wxFontMapper::Get() instead
- wxStringHashTable: use wxHashMap instead
- wxHashTableLong: use wxHashMap instead
- wxArrayString::GetStringArray: use wxCArrayString or alternative wxWidgets
                                 methods taking wxArrayString
- wxArrayString::Remove(index, count): use RemoveAt instead
- wxTreeItemId conversion to long is deprecated and shouldn't be used
- wxTreeCtrl::GetFirst/NextChild() 2nd argument now has type wxTreeItemIdValue
  and not long, please change declarations of "cookie"s in your code
  accordingly -- otherwise your code won't work on 64 bit platforms
- [MSW only] wxWindow::GetUseCtl3D(), GetTransparentBackground() and
             SetTransparent() as well as wxNO_3D and wxUSER_COLOURS styles
- wxList keyed interface: use wxHashMap instead
- wxColourDatabase::FindColour(): use Find() instead (NB: different ret type)
- wxHashTable::Next: use wxHashTable::Node* or
                     wxHashTable::compatibility_iterator to store the return
                     value
- wxWave class; use wxSound instead


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

2.5.2
-----

All:

- Hindi translation added (Dhananjaya Sharma)
- Brazilian Portuguese translation added (E. A. Tacao)
- wxDynamicCast() now uses static_cast<wxObject *> internally and so using it
  with anything not deriving from wxObject will fail at compile time (instead
  of run-time) now
- when wxUSE_STL == 1 and STL provides quasi-standard hash_map/hash_set,
  wxHashMap/wxHashSet are just typedefs for them. This makes impossible
  to forward declare these classes.

All (GUI):

- wxHtmlWindow now delays image scaling until rendering,
  resulting in much better display of scaled images
- Added UpdateSize to wxSplitterWindow to allow layout while hidden
- implemented Freeze/Thaw() for wxGenericTreeCtrl (Kevin Hock)
- support for KOI8-U encoding added (Yuriy Tkachenko)
- The old wxADJUST_MINSIZE behaviour is now the default behaviour for
  sizer items that are windows.  This means that GetAdjustedBestSize
  will now be called by default to determine the minimum size that a
  window in a sizer should have.  If you want to still use the initial
  size (and not the BestSize) then use the wxFIXED_MINSIZE flag.  When
  windows are added to a sizer their initial size is made the window's
  min size using SetSizeHints, and calls to wxSizer::SetItemMinSize
  are also forwarded to SetSizeHints for window items.
- added wxRegEx::GetMatchCount()
- it is now possible to display images in wxHtmlListBox

wxMSW:

- wxWindow::Freeze()/Thaw() can now be nested
- Added wxSP_NO_XP_THEME style to wxSplitterWindow to switch off
  XP theming (some applications look bad without 3D borders)
- wxMenuBar::GetLabelTop() doesn't include '&'s in the label any more
- wxRegConf couldn't read global settings without admin privileges and didn't
  even try to do it by default -- now it does
- wxTaskBarIcon must be explicitly destroyed now, otherwise the application
  won't exit even though there are no top level windows
- wxFileName::GetModificationTime() works with opened files too now
- wxDC::GetClippingBox() now works even for clipping regions created by Windows
- fixed wxFileDataObject in Unicode build (Alex D)
- subdindented paragraphs support (Tim Kosse)

wxGTK:

- added support for wxTE_RIGHT and wxTE_CENTRE styles under GTK2 (Mart Raudsepp)

wxMotif:

- removed wxMenuItem::DeleteSubMenu()
- wxButtons use Motif default size, which is smaller than it used to be
  and closer to wxMSW/wxGTK look. This can be disabled by setting
  motif.largebuttons system option to 1 (see wxSystemOptions).

wxUniv/X11:

- implemented DrawRoundedRectangle() (clawghoul)

wxHTML:

- improved tables and lists layout algorithms (Tim Kosse)
- <div> handling fix (Xavier Nodet)

Unix:
- fixed priorities of mailcap entries (David Hart)
- added "wx-config --libs=std,<extra>" syntax (i.e. support for "std")

wxODBC:
- Full Unicode support is now available
- BLOB support is working


2.5.1
-----

All: