Add release notes for v0.4.6.

beeware · Aug 28, 2024 · 34e6b43 · 34e6b43
1 parent e757387
commit 34e6b43
Show file tree

Hide file tree

Showing 86 changed files with 69 additions and 97 deletions.
diff --git a/changes/1870.feature.rst b/changes/1870.feature.rst
diff --git a/changes/2023.feature.rst b/changes/2023.feature.rst
diff --git a/changes/2099.removal.rst b/changes/2099.removal.rst
diff --git a/changes/2209.feature.1.rst b/changes/2209.feature.1.rst
diff --git a/changes/2209.feature.2.rst b/changes/2209.feature.2.rst
diff --git a/changes/2209.removal.rst b/changes/2209.removal.rst
diff --git a/changes/2382.misc.rst b/changes/2382.misc.rst
diff --git a/changes/2478.feature.rst b/changes/2478.feature.rst
diff --git a/changes/2619.bugfix.rst b/changes/2619.bugfix.rst
diff --git a/changes/2635.misc.rst b/changes/2635.misc.rst
diff --git a/changes/2636.feature.rst b/changes/2636.feature.rst
diff --git a/changes/2638.bugfix.rst b/changes/2638.bugfix.rst
diff --git a/changes/2640.misc.rst b/changes/2640.misc.rst
diff --git a/changes/2643.bugfix.rst b/changes/2643.bugfix.rst
diff --git a/changes/2643.feature.rst b/changes/2643.feature.rst
diff --git a/changes/2646.bugfix.rst b/changes/2646.bugfix.rst
diff --git a/changes/2646.removal.1.rst b/changes/2646.removal.1.rst
diff --git a/changes/2646.removal.2.rst b/changes/2646.removal.2.rst
diff --git a/changes/2647.misc.rst b/changes/2647.misc.rst
diff --git a/changes/2648.misc.rst b/changes/2648.misc.rst
diff --git a/changes/2653.bugfix.rst b/changes/2653.bugfix.rst
diff --git a/changes/2654.misc.rst b/changes/2654.misc.rst
diff --git a/changes/2657.misc.rst b/changes/2657.misc.rst
diff --git a/changes/2660.misc.rst b/changes/2660.misc.rst
diff --git a/changes/2661.bugfix.rst b/changes/2661.bugfix.rst
diff --git a/changes/2665.misc.rst b/changes/2665.misc.rst
diff --git a/changes/2668.misc.rst b/changes/2668.misc.rst
diff --git a/changes/2669.feature.rst b/changes/2669.feature.rst
diff --git a/changes/2669.removal.rst b/changes/2669.removal.rst
diff --git a/changes/2675.misc.rst b/changes/2675.misc.rst
diff --git a/changes/2676.misc.rst b/changes/2676.misc.rst
diff --git a/changes/2677.misc.rst b/changes/2677.misc.rst
diff --git a/changes/2678.feature.1.rst b/changes/2678.feature.1.rst
diff --git a/changes/2678.feature.2.rst b/changes/2678.feature.2.rst
diff --git a/changes/2682.misc.rst b/changes/2682.misc.rst
diff --git a/changes/2683.misc.rst b/changes/2683.misc.rst
diff --git a/changes/2684.misc.rst b/changes/2684.misc.rst
diff --git a/changes/2689.misc.rst b/changes/2689.misc.rst
diff --git a/changes/2693.misc.rst b/changes/2693.misc.rst
diff --git a/changes/2694.misc.rst b/changes/2694.misc.rst
diff --git a/changes/2695.misc.rst b/changes/2695.misc.rst
diff --git a/changes/2696.misc.rst b/changes/2696.misc.rst
diff --git a/changes/2697.misc.rst b/changes/2697.misc.rst
diff --git a/changes/2698.misc.rst b/changes/2698.misc.rst
diff --git a/changes/2699.misc.rst b/changes/2699.misc.rst
diff --git a/changes/2701.feature.rst b/changes/2701.feature.rst
diff --git a/changes/2703.bugfix.rst b/changes/2703.bugfix.rst
diff --git a/changes/2709.misc.rst b/changes/2709.misc.rst
diff --git a/changes/2710.misc.rst b/changes/2710.misc.rst
diff --git a/changes/2711.misc.rst b/changes/2711.misc.rst
diff --git a/changes/2712.misc.rst b/changes/2712.misc.rst
diff --git a/changes/2722.misc.rst b/changes/2722.misc.rst
diff --git a/changes/2723.misc.rst b/changes/2723.misc.rst
diff --git a/changes/2724.misc.rst b/changes/2724.misc.rst
diff --git a/changes/2726.misc.rst b/changes/2726.misc.rst
diff --git a/changes/2727.misc.rst b/changes/2727.misc.rst
diff --git a/changes/2728.misc.rst b/changes/2728.misc.rst
diff --git a/changes/2733.misc.rst b/changes/2733.misc.rst
diff --git a/changes/2734.misc.rst b/changes/2734.misc.rst
diff --git a/changes/2735.misc.rst b/changes/2735.misc.rst
diff --git a/changes/2736.misc.rst b/changes/2736.misc.rst
diff --git a/changes/2739.misc.rst b/changes/2739.misc.rst
diff --git a/changes/2740.misc.rst b/changes/2740.misc.rst
diff --git a/changes/2742.misc.rst b/changes/2742.misc.rst
diff --git a/changes/2743.misc.rst b/changes/2743.misc.rst
diff --git a/changes/2745.doc.rst b/changes/2745.doc.rst
diff --git a/changes/2752.bugfix.rst b/changes/2752.bugfix.rst
diff --git a/changes/2755.misc.rst b/changes/2755.misc.rst
diff --git a/changes/2756.misc.rst b/changes/2756.misc.rst
diff --git a/changes/2757.misc.rst b/changes/2757.misc.rst
diff --git a/changes/2758.misc.rst b/changes/2758.misc.rst
diff --git a/changes/2760.misc.rst b/changes/2760.misc.rst
diff --git a/changes/2764.feature.rst b/changes/2764.feature.rst
diff --git a/changes/2771.misc.rst b/changes/2771.misc.rst
diff --git a/changes/2775.misc.rst b/changes/2775.misc.rst
diff --git a/changes/2776.misc.rst b/changes/2776.misc.rst
diff --git a/changes/2777.misc.rst b/changes/2777.misc.rst
diff --git a/changes/2779.bugfix.rst b/changes/2779.bugfix.rst
diff --git a/changes/2783.misc.rst b/changes/2783.misc.rst
diff --git a/changes/2788.misc.rst b/changes/2788.misc.rst
diff --git a/changes/2789.misc.rst b/changes/2789.misc.rst
diff --git a/changes/2790.misc.rst b/changes/2790.misc.rst
diff --git a/changes/90.feature.rst b/changes/90.feature.rst
diff --git a/changes/97.feature.1.rst b/changes/97.feature.1.rst
diff --git a/changes/97.feature.2.rst b/changes/97.feature.2.rst
diff --git a/docs/background/project/releases.rst b/docs/background/project/releases.rst
@@ -6,6 +6,75 @@ Release History
 
 .. towncrier release notes start
 
+0.4.6 (2024-08-28)
+==================
+
+* An app can now define a ``preferences()`` method to hook into the default menu item generated by Toga. The system-installed (but disabled) app command, that command will no longer be installed unless a ``preferences()`` method is defined. (`#90 <https://github.com/beeware/toga/issues/90>`__)
+
+Features
+--------
+
+* Toga can now define apps that persist in the background without having any open windows. (`#97 <https://github.com/beeware/toga/issues/97>`__)
+* Apps can now add items to the system tray. (`#97 <https://github.com/beeware/toga/issues/97>`__)
+* It is now possible to use an instance of Window as the main window of an app. This allows the creation of windows that don't have a menu bar or toolbar decoration. (`#1870 <https://github.com/beeware/toga/issues/1870>`__)
+* The initial position of each newly created window is now different, cascading down the screen as windows are created. (`#2023 <https://github.com/beeware/toga/issues/2023>`__)
+* The API for Documents and document types has been finalized. Document handling behavior is now controlled by declaring document types as part of your ``toga.App`` definition. (`#2209 <https://github.com/beeware/toga/issues/2209>`__)
+* Toga can now define an app whose life cycle isn't tied to a single main window. (`#2209 <https://github.com/beeware/toga/issues/2209>`__)
+* The Divider widget was implemented on iOS. (`#2478 <https://github.com/beeware/toga/issues/2478>`__)
+* Commands can now be retrieved by ID. System-installed commands (such as "About" and "Visit Homepage") are installed using a known ID that can be used at runtime to manipulate those commands. (`#2636 <https://github.com/beeware/toga/issues/2636>`__)
+* A ``MainWindow`` can now have an ``on_close`` handler. If a request is made to close the main window, the ``on_close`` handler will be evaluated; app exit handling will only be processed if the close handler allows the close to continue. (`#2643 <https://github.com/beeware/toga/issues/2643>`__)
+* Dialogs can now be displayed relative to an app, in addition to be being modal to a window. (`#2669 <https://github.com/beeware/toga/issues/2669>`__)
+* An ``on_running`` event handler was added to ``toga.App``. This event will be triggered when the app's main loop starts. (`#2678 <https://github.com/beeware/toga/issues/2678>`__)
+* The ``on_exit`` handler for an app can now be defined by overriding the method on the ``toga.App`` subclass. (`#2678 <https://github.com/beeware/toga/issues/2678>`__)
+* CommandSet now exposes a full set and dictionary interface. Commands can be added to a CommandSet using ``[]`` notation and a command ID; they can be removed using set-like ``remove()`` or ``discard()`` calls with a Command instance, or using dictionary-like ``pop()`` or ``del`` calls with the command ID. (`#2701 <https://github.com/beeware/toga/issues/2701>`__)
+* WebView2 on Winforms now uses the v1.0.2592.51 WebView2 runtime DLLs. (`#2764 <https://github.com/beeware/toga/issues/2764>`__)
+
+Bugfixes
+--------
+
+* The order of creation of system-level commands is now consistent between platforms. Menu creation is guaranteed to be deferred until the user's startup method has been invoked. (`#2619 <https://github.com/beeware/toga/issues/2619>`__)
+* The type of SplitContainer's content was modified to be a list, rather than a tuple. (`#2638 <https://github.com/beeware/toga/issues/2638>`__)
+* Programmatically invoking ``close()`` on the main window will now trigger ``on_exit`` handling. Previously ``on_exit`` handling would only be triggered if the close was initiated by a user action. (`#2643 <https://github.com/beeware/toga/issues/2643>`__)
+* GTK apps no longer have extra padding between the menu bar and the window content when the app does not have a toolbar. (`#2646 <https://github.com/beeware/toga/issues/2646>`__)
+* On Winforms, the window of an application that is set as the main window is no longer shown as a result of assigning the window as ``App.main_window``. (`#2653 <https://github.com/beeware/toga/issues/2653>`__)
+* Menu items on macOS are now able to correctly bind to the arrow and home/end/delete keys. (`#2661 <https://github.com/beeware/toga/issues/2661>`__)
+* On GTK, the currently selected tab index on an ``OptionContainer`` can now be retrieved inside an ``on_select`` handler. (`#2703 <https://github.com/beeware/toga/issues/2703>`__)
+* The WebView can now be loaded when using Python from the Windows Store. (`#2752 <https://github.com/beeware/toga/issues/2752>`__)
+* The WebView and MapView widgets now log an error if initialization fails. (`#2779 <https://github.com/beeware/toga/issues/2779>`__)
+
+
+Backward Incompatible Changes
+-----------------------------
+
+* The ``add_background_task()`` API on ``toga.App`` has been deprecated. Background tasks can be implemented using the new ``on_running`` event handler, or by using :any:`asyncio.create_task`. (`#2099 <https://github.com/beeware/toga/issues/2099>`__)
+* The API for Documents and Document-based apps has been significantly modified. Unfortunately, these changes are not backwards compatible; any existing Document-based app will require modification.
+
+ The ``DocumentApp`` base class is no longer required. Apps can subclass ``App`` directly, passing the document types as a ``list`` of ``Document`` classes, rather than a mapping of extension to document type.
+
+ The API for ``Document`` subclasses has also changed:
+
+ * A path is no longer provided as an argument to the Document constructor;
+
+ * The ``document_type`` is now specified as a class property called ``description``; and
+
+ * Extensions are now defined as a class property of the ``Document``; and
+
+ * The ``can_close()`` handler is no longer honored. Documents now track if they are modified, and have a default ``on_close`` handler that uses the modification status of a document to control whether a document can close. Invoking ``touch()`` on document will mark a document as modified. This modification flag is cleared by saving the document. (`#2209 <https://github.com/beeware/toga/issues/2209>`__)
+* It is no longer possible to create a toolbar on a ``Window`` instance. Toolbars can only be added to ``MainWindow`` (or subclass). (`#2646 <https://github.com/beeware/toga/issues/2646>`__)
+* The default title of a ``toga.Window`` is now the name of the app, rather than ``"Toga"``. (`#2646 <https://github.com/beeware/toga/issues/2646>`__)
+* The APIs on ``Window`` for displaying dialogs (``info_dialog()``, ``question_dialog()``, etc) have been deprecated. They can be replaced with creating an instance of a ``Dialog`` class (e.g., ``InfoDialog``), and passing that instance to ``window.dialog()``. (`#2669 <https://github.com/beeware/toga/issues/2669>`__)
+
+Documentation
+-------------
+
+* Building Toga's documentation now requires the use of Python 3.12. (`#2745 <https://github.com/beeware/toga/issues/2745>`__)
+
+Misc
+----
+
+* `#2382 <https://github.com/beeware/toga/issues/2382>`__, `#2635 <https://github.com/beeware/toga/issues/2635>`__, `#2640 <https://github.com/beeware/toga/issues/2640>`__, `#2647 <https://github.com/beeware/toga/issues/2647>`__, `#2648 <https://github.com/beeware/toga/issues/2648>`__, `#2654 <https://github.com/beeware/toga/issues/2654>`__, `#2657 <https://github.com/beeware/toga/issues/2657>`__, `#2660 <https://github.com/beeware/toga/issues/2660>`__, `#2665 <https://github.com/beeware/toga/issues/2665>`__, `#2668 <https://github.com/beeware/toga/issues/2668>`__, `#2675 <https://github.com/beeware/toga/issues/2675>`__, `#2676 <https://github.com/beeware/toga/issues/2676>`__, `#2677 <https://github.com/beeware/toga/issues/2677>`__, `#2682 <https://github.com/beeware/toga/issues/2682>`__, `#2683 <https://github.com/beeware/toga/issues/2683>`__, `#2684 <https://github.com/beeware/toga/issues/2684>`__, `#2689 <https://github.com/beeware/toga/issues/2689>`__, `#2693 <https://github.com/beeware/toga/issues/2693>`__, `#2694 <https://github.com/beeware/toga/issues/2694>`__, `#2695 <https://github.com/beeware/toga/issues/2695>`__, `#2696 <https://github.com/beeware/toga/issues/2696>`__, `#2697 <https://github.com/beeware/toga/issues/2697>`__, `#2698 <https://github.com/beeware/toga/issues/2698>`__, `#2699 <https://github.com/beeware/toga/issues/2699>`__, `#2709 <https://github.com/beeware/toga/issues/2709>`__, `#2710 <https://github.com/beeware/toga/issues/2710>`__, `#2711 <https://github.com/beeware/toga/issues/2711>`__, `#2712 <https://github.com/beeware/toga/issues/2712>`__, `#2722 <https://github.com/beeware/toga/issues/2722>`__, `#2723 <https://github.com/beeware/toga/issues/2723>`__, `#2724 <https://github.com/beeware/toga/issues/2724>`__, `#2726 <https://github.com/beeware/toga/issues/2726>`__, `#2727 <https://github.com/beeware/toga/issues/2727>`__, `#2728 <https://github.com/beeware/toga/issues/2728>`__, `#2733 <https://github.com/beeware/toga/issues/2733>`__, `#2734 <https://github.com/beeware/toga/issues/2734>`__, `#2735 <https://github.com/beeware/toga/issues/2735>`__, `#2736 <https://github.com/beeware/toga/issues/2736>`__, `#2739 <https://github.com/beeware/toga/issues/2739>`__, `#2740 <https://github.com/beeware/toga/issues/2740>`__, `#2742 <https://github.com/beeware/toga/issues/2742>`__, `#2743 <https://github.com/beeware/toga/issues/2743>`__, `#2755 <https://github.com/beeware/toga/issues/2755>`__, `#2756 <https://github.com/beeware/toga/issues/2756>`__, `#2757 <https://github.com/beeware/toga/issues/2757>`__, `#2758 <https://github.com/beeware/toga/issues/2758>`__, `#2760 <https://github.com/beeware/toga/issues/2760>`__, `#2771 <https://github.com/beeware/toga/issues/2771>`__, `#2775 <https://github.com/beeware/toga/issues/2775>`__, `#2776 <https://github.com/beeware/toga/issues/2776>`__, `#2777 <https://github.com/beeware/toga/issues/2777>`__, `#2783 <https://github.com/beeware/toga/issues/2783>`__, `#2788 <https://github.com/beeware/toga/issues/2788>`__, `#2789 <https://github.com/beeware/toga/issues/2789>`__, `#2790 <https://github.com/beeware/toga/issues/2790>`__
+
+
 0.4.5 (2024-06-11)
 ==================