wxWidgets/docs
Vadim Zeitlin bdad37f278 Add translations update to the pre-release list of things to do
Remind that a request to update translations should be sent to the
translators mailing list.
2022-04-09 22:51:25 +02:00
..
base Change documentation references from OS X to macOS (#1927) 2020-07-04 22:08:24 +02:00
contributing Add translations update to the pre-release list of things to do 2022-04-09 22:51:25 +02:00
dfb
doxygen Update version to 3.1.7 and rebake the makefiles 2022-04-07 17:40:13 +02:00
gtk Update configure --enable-debug[_flag] options description 2021-09-05 16:04:56 +02:00
ios Change documentation references from OS X to macOS (#1927) 2020-07-04 22:08:24 +02:00
motif
msw Update the release documents for 3.1.6 release 2022-04-04 01:16:33 +02:00
osx Replace old Trac links with GitHub ones 2022-01-13 16:52:58 +01:00
publicity Fix a typo in "security fixes" in the change log 2022-04-04 15:41:33 +02:00
qt Fixup the QT architecture markdown page 2021-05-21 02:48:05 +01:00
tech
univ Remove setup0.h files 2021-01-31 19:02:56 +01:00
vms
wine Fix spelling mistakes found by codespell 2020-07-13 17:38:47 +02:00
x11 Fix doxygen section bugs 2021-05-21 02:26:24 +01:00
changes_30.txt
changes.txt Add change log section for the next 3.1.7 release 2022-04-07 17:39:56 +02:00
gpl.txt Update GPL and LGPL license texts to the latest versions 2020-03-26 19:50:13 -04:00
index.htm Fix spelling mistakes found by codespell 2020-07-13 17:38:47 +02:00
lgpl.txt Update GPL and LGPL license texts to the latest versions 2020-03-26 19:50:13 -04:00
licence.txt
licendoc.txt
preamble.txt
readme.txt Update version to 3.1.7 and rebake the makefiles 2022-04-07 17:40:13 +02:00
release.md Update checksums for 3.1.6 release files again 2022-04-04 16:04:58 +02:00
xserver.txt

wxWidgets 3.1.7 Release Notes
=============================

Welcome to the latest development release of wxWidgets, a free and open source
cross-platform C++ framework for writing advanced GUI applications using native
controls.

wxWidgets allows you to write native-looking GUI applications for all the major
desktop platforms and also helps with abstracting the differences in the non-GUI
aspects between them. It is free for the use in both open source and commercial
applications, comes with the full, easy to read and modify, source and extensive
documentation and a collection of more than a hundred examples. You can learn
more about wxWidgets at:

* https://www.wxwidgets.org/

Documentation is available online at:

* https://docs.wxwidgets.org/3.1.7/

wxWidgets sources and binaries for the selected platforms are available for
download from:

* https://www.wxwidgets.org/downloads/

or, for a more more permanent but less convenient to use link, from

* https://github.com/wxWidgets/wxWidgets/releases/tag/v3.1.7/

Please see https://docs.wxwidgets.org/3.1.7/overview_install.html for full
installation instructions.



Changes since 3.1.5
-------------------

In almost a year since the previous release, there have been more than 1700
commits from 82 unique contributors (41 with multiple contributions), so it is
impossible to summarize all the changes in this document without making it too
long, please see the fuller changelog at

https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.7/docs/changes.txt

for more details, but here are some of the most important changes:

- New wxBitmapBundle class allowing to provide art work for both normal and
  high DPI in a simple way.
- New wxUILocale class replacing the old (but still available) wxLocale, but
  not suffering from its multiple problems and providing more functionality.
- Support for using native spell-checking in wxTextCtrl.
- Support for undo/redo in wxTextCtrl in wxOSX.
- Better drag-and-drop implementation in wxOSX.
- Fixes for important bugs in wxDataViewCtrl under all platforms.
- Many improvements and bug fixes for Wayland support in wxGTK.
- Support for the latest OS versions (Windows 11, macOS 12) and compilers (MSVS
  2022, gcc 12, clang 13).
- Project bug tracker has been moved to GitHub Issues.

Notice that in spite of all the changes, this release remains almost completely
compatible with 3.1.5 at the API level, so upgrading to it if you're already
using wxWidgets 3 should be straightforward.


Changes since 3.0
-----------------

Compared to the stable 3.0.x series, this version brings too many
improvements and even more bug fixes to list them all, but here is the
maximally condensed summary:

- Build system improvements: support for new compilers (up to MSVS 2022,
  g++ 11, clang 13) with an even simpler way of using wxWidgets from
  MSVS, with wxwidgets.props file, and OS versions as well as an
  entirely new CMake build system.
- Support for native dark mode under macOS 10.14 Mojave and later and
  support for macOS 11 and later on ARM hardware.
- New features: HTTPS and HTTP/2 support with wxWebRequest and friends;
  support for freezing rows/columns in wxGrid; mouse gesture events
  (GSoC 2017 project); non-integer font sizes and arbitrary font weights
  in wxFont; fractional pen widths in wxGraphicsContext; arbitrary label
  windows in wxStaticBox; markup in wxDataViewCtrl items text; better
  support for high DPI monitors and per-monitor DPI, notably the
  addition of wxBitmapBundle, and dynamic DPI changes support under MSW;
  support for ZIP 64 files; LZMA compression; much improved
  accessibility support under MSW; new Edge-based wxWebView
  implementation.
- New classes: wxActivityIndicator, wxAddRemoveCtrl, wxAppProgressIndicator,
  wxBitmapBundle, wxNativeWindow, wxPersistentComboBox,
  wxPowerResourceBlocker, wxSecretStore, wxTempFFile and many new
  features in the existing classes.
- New XRC handlers for all the new and some of the existing classes.
- Significant improvements to: wxBusyInfo, wxDataViewCtrl, wxDirDialog, wxGrid,
  wxNotificationMessage, wxSpinCtrl, wxStaticBox, wxStyledTextCtrl,
  wxUIActionSimulator.
- Improvements to compile-time safety with the possibility to disable dangerous
  implicit conversions between wxString and "char*" strings.
- Latest versions of all bundled 3rd party libraries, including all the
  security fixes and support for WebKit 2 and GStreamer 1.7 under Unix.
- Revamped OpenGL support better suited to modern OpenGL (3.2+).
- Further C++11 and later support improvements, wxWidgets can be built using
  C++20 compilers.
- A lot of bug fixes, especially in wxGTK3 and wxOSX/Cocoa ports.
- New experimental wxQt port.



Platforms Supported
-------------------

This version of wxWidgets supports the following primary platforms:

* Windows XP, Vista, 7, 8, 10 and 11 (32/64 bits).
* Most Unix variants using the GTK+ toolkit (version 2.6 or newer)
* macOS (10.10 or newer) using Cocoa

There is some support for the following platforms:

* Most Unix variants with X11
* Most Unix variants with Motif/Lesstif
* Most Unix variants with GTK+ 1.2
* Most Unix variants with Qt 5 or newer (experimental)

All C++ compilers in common use are supported.


Licence
-------

For licensing information, please see the files:

* docs/preamble.txt
* docs/licence.txt
* docs/licendoc.txt
* docs/gpl.txt
* docs/lgpl.txt
* docs/xserver.txt

Although this may seem complex, it is there to allow authors of proprietary,
commercial applications to use wxWidgets in addition to those writing GPL'ed
applications. In summary, the licence is LGPL plus a clause allowing
unrestricted distribution of application binaries. To answer a FAQ, you don't
have to distribute any source if you wish to write commercial applications using
wxWidgets.

However, if you distribute wxGTK, wxQt or wxMotif (with Lesstif) version of your
application, don't forget that it is linked against GTK+, Qt or Lesstif, which
are covered by LGPL *without* exception notice and so is bound by its
requirements.

If you use TIFF image handler, please see src/tiff/COPYRIGHT for libtiff licence
details.

If you use JPEG image handler, documentation for your program should contain
following sentence: "This software is based in part on the work of the
Independent JPEG Group". See src/jpeg/README for details.

If you use wxRegEx class, please see 3rdparty/pcre/LICENCE for PCRE licence
details.

If you use wxXML classes or XRC, see src/expat/COPYING for licence details.


Reporting Bugs
--------------

The wxWidgets bug tracker can be found here:

* https://github.com/wxWidgets/wxWidgets/issues/

Please use the search function find any possibly relevant bugs before reporting
new ones. Also please notice that often trying to correct the bug yourself is
the quickest way to fix it. Even if you fail to do it, you may discover
valuable information allowing us to fix it while doing it. We also give much
higher priority to bug reports with patches fixing the problems so this ensures
that your report will be addressed sooner.


Further Information
-------------------

If you are looking for community support, you can get it from

* Mailing Lists: https://www.wxwidgets.org/support/mailing-lists/
* Discussion Forums: https://forums.wxwidgets.org/
* #wxwidgets IRC Channel: https://www.wxwidgets.org/support/irc/
* Stack Overflow (tag your questions with "wxwidgets"):
  https://stackoverflow.com/questions/tagged/wxwidgets

Commercial support is also available, please see
https://www.wxwidgets.org/support/commercial/

Finally, keep in mind that wxWidgets is an open source project collaboratively
developed by its users and your contributions to it are always welcome!


Have fun!

The wxWidgets Team, April 2022