Merge pull request #46 from macosui/issue_10

Issue #45

.gitignore

@@ -9,3 +9,4 @@ build/
 # https://dart.dev/guides/libraries/private-files#pubspeclock.
 pubspec.lock
 .vscode/settings.json
+.idea/workspace.xml

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.5.0
+
+- Add the following window methods:
+  - `preventWindowClosure`
+  - `allowWindowClosure`
+  - `isWindowClosureAllowed`
+  - `closeWindow`
+  - `performClose`
+
 ## 1.4.0
 
 - Add methods to retrieve or manipulate the window’s size and position.

README.md

@@ -37,6 +37,7 @@ English | [简体中文](README_zh.md)
 + An abstract `NSWindowDelegate` class that can be used to detect `NSWindow` events, such as window resizing, moving, exposing, and minimizing.
 + An `NSAppPresentationOptions` class that allows modifications to the window's fullscreen presentation options.
 + Methods to get and set the positions of the window’s standard window buttons (such as the close, miniaturize, and zoom buttons).
++ Methods to control whether the window should be closable by the user, as well as methods to close the window programmatically.
 
 Additionally, the package ships with an example project that showcases the plugin's features via an intuitive searchable user interface:
 
@@ -50,7 +51,7 @@ First, install the package via the following command:
 flutter pub add macos_window_utils
 ```
 
-Afterwards, open the `macos/Runner.xcworkspace` folder of your project using Xcode, press ⇧ + ⌘ + O and search for `Runner.xcodeproj`.
+Afterward, open the `macos/Runner.xcworkspace` folder of your project using Xcode, press ⇧ + ⌘ + O and search for `Runner.xcodeproj`.
 
 Go to `Info` > `Deployment Target` and set the `macOS Deployment Target` to `10.14.6` or above. Then, open your project's `Podfile` (if it doesn't show up in Xcode, you can find it in your project's `macos` directory via VS Code) and set the minimum deployment version in the first line to `10.14.6` or above:
 

README_zh.md

@@ -25,6 +25,7 @@
 + 一个抽象的 `NSWindowDelegate` 类，可用于检测 `NSWindow` 事件，例如窗口调整大小、移动、暴露和最小化。
 + 一个 `NSAppPresentationOptions` 类，允许修改窗口的全屏演示选项。
 + 获取和设置窗口标准窗口按钮（例如关闭、缩小和缩放按钮）位置的方法。
++ 控制窗口是否应关闭用户以及以编程方式关闭窗口的方法。
 
 此外，该包还附带了一个示例项目，通过直观的可搜索用户界面展示了插件的功能：
 

example/lib/main_area/window_manipulator_demo/command_list_provider/command_list_provider.dart

@@ -636,6 +636,43 @@ class CommandListProvider {
             const Offset(64, 32) & const Size(512, 512),
             animate: true),
       ),
+      Command(
+        name: 'WindowManipulator.preventWindowClosure()',
+        description: 'Prevents the window from being closed by the user.\n\n'
+            'The window will still be closable programmatically by calling '
+            '`closeWindow`.',
+        function: () => WindowManipulator.preventWindowClosure(),
+      ),
+      Command(
+        name: 'WindowManipulator.allowWindowClosure()',
+        description: 'Allows the window to be closed by the user.',
+        function: () => WindowManipulator.allowWindowClosure(),
+      ),
+      Command(
+        name: 'WindowManipulator.isWindowClosureAllowed()',
+        description: 'Returns whether the window can be closed by the user.',
+        function: () async => debugPrint(
+            (await WindowManipulator.isWindowClosureAllowed()).toString()),
+      ),
+      Command(
+        name: 'WindowManipulator.closeWindow()',
+        description: 'Removes the window from the screen. \n\n'
+            'The close method differs in two important ways from the '
+            '`performClose` method:\n'
+            '  + It does not attempt to send a '
+            '`NSWindowDelegate.windowShouldClose` '
+            'message to its delegates.\n'
+            '+ It does not simulate the user clicking the close button by '
+            'momentarily highlighting the button.\n\n'
+            'Use `performClose` if you need these features.',
+        function: () => WindowManipulator.closeWindow(),
+      ),
+      Command(
+        name: 'WindowManipulator.performClose()',
+        description: 'Simulates the user clicking the close button by '
+            'momentarily highlighting the button and then closing the window.',
+        function: () => WindowManipulator.performClose(),
+      ),
     ];
   }
 }

lib/widgets/titlebar_safe_area.dart

@@ -7,8 +7,7 @@ import 'package:macos_window_utils/macos_window_utils.dart';
 class _MacOSTitlebarSafeArea extends StatefulWidget {
   final Widget child;
 
-  const _MacOSTitlebarSafeArea({Key? key, required this.child})
-      : super(key: key);
+  const _MacOSTitlebarSafeArea({required this.child});
 
   @override
   State<_MacOSTitlebarSafeArea> createState() => _MacOSTitlebarSafeAreaState();
@@ -54,7 +53,7 @@ class TitlebarSafeArea extends StatelessWidget {
   ///  child: Text('Hello World'),
   /// )
   /// ```
-  const TitlebarSafeArea({Key? key, required this.child}) : super(key: key);
+  const TitlebarSafeArea({super.key, required this.child});
 
   @override
   Widget build(BuildContext context) {

lib/widgets/transparent_macos_bottom_bar.dart

@@ -31,13 +31,12 @@ class TransparentMacOSBottomBar extends StatelessWidget {
   /// )
   /// ```
   const TransparentMacOSBottomBar(
-      {Key? key,
+      {super.key,
       this.alphaValue = 1.0,
       this.material = NSVisualEffectViewMaterial.sidebar,
       this.state = NSVisualEffectViewState.followsWindowActiveState,
       this.resizeEventRelay,
-      required this.child})
-      : super(key: key);
+      required this.child});
 
   @override
   Widget build(BuildContext context) {

lib/widgets/transparent_macos_sidebar.dart

@@ -31,13 +31,12 @@ class TransparentMacOSSidebar extends StatelessWidget {
   /// )
   /// ```
   const TransparentMacOSSidebar(
-      {Key? key,
+      {super.key,
       this.alphaValue = 1.0,
       this.material = NSVisualEffectViewMaterial.sidebar,
       this.state = NSVisualEffectViewState.followsWindowActiveState,
       this.resizeEventRelay,
-      required this.child})
-      : super(key: key);
+      required this.child});
 
   @override
   Widget build(BuildContext context) {

lib/widgets/visual_effect_subview_container/visual_effect_subview_container.dart

@@ -53,16 +53,15 @@ class VisualEffectSubviewContainer extends StatefulWidget {
   /// [VisualEffectSubviewContainerResizeEventRelay] through which its update
   /// behavior can be controlled manually.
   const VisualEffectSubviewContainer(
-      {Key? key,
+      {super.key,
       required this.child,
       this.alphaValue = 1.0,
       this.cornerRadius,
       this.cornerMask = 0xf,
       required this.material,
       this.state = NSVisualEffectViewState.followsWindowActiveState,
       this.padding = EdgeInsets.zero,
-      this.resizeEventRelay})
-      : super(key: key);
+      this.resizeEventRelay});
 
   @override
   State<VisualEffectSubviewContainer> createState() =>

lib/window_manipulator.dart

@@ -742,4 +742,66 @@ class WindowManipulator {
       'animate': animate,
     });
   }
+
+  /// Prevents the window from being closed by the user.
+  ///
+  /// Requires the window delegate to be enabled.
+  ///
+  /// The window will still be closable programmatically by calling
+  /// [closeWindow].
+  static Future<void> preventWindowClosure() async {
+    await _completer.future;
+    final hasSucceeded = await _windowManipulatorMethodChannel
+        .invokeMethod('preventWindowClosure');
+
+    assert(
+        hasSucceeded,
+        'preventWindowClosure failed. Please make sure that '
+        'the `enableWindowDelegate` parameter is set to true in your '
+        'WindowManipulator.initialize call.');
+  }
+
+  /// Allows the window to be closed by the user.
+  ///
+  /// Requires the window delegate to be enabled.
+  static Future<void> allowWindowClosure() async {
+    await _completer.future;
+    final hasSucceeded = await _windowManipulatorMethodChannel
+        .invokeMethod('allowWindowClosure');
+
+    assert(
+        hasSucceeded,
+        'allowWindowClosure failed. Please make sure that '
+        'the `enableWindowDelegate` parameter is set to true in your '
+        'WindowManipulator.initialize call.');
+  }
+
+  /// Returns whether the window can be closed by the user.
+  static Future<bool> isWindowClosureAllowed() async {
+    await _completer.future;
+    return await _windowManipulatorMethodChannel
+        .invokeMethod('isWindowClosureAllowed');
+  }
+
+  /// Removes the window from the screen.
+  ///
+  /// The close method differs in two important ways from the [performClose]
+  /// method:
+  /// + It does not attempt to send a [NSWindowDelegate.windowShouldClose]
+  ///   message to its delegates.
+  /// + It does not simulate the user clicking the close button by momentarily
+  ///   highlighting the button.
+  ///
+  /// Use [performClose] if you need these features.
+  static Future<void> closeWindow() async {
+    await _completer.future;
+    await _windowManipulatorMethodChannel.invokeMethod('closeWindow');
+  }
+
+  /// Simulates the user clicking the close button by momentarily highlighting
+  /// the button and then closing the window.
+  static Future<void> performClose() async {
+    await _completer.future;
+    await _windowManipulatorMethodChannel.invokeMethod('performClose');
+  }
 }

macos/Classes/FlutterWindowDelegate.swift

@@ -11,6 +11,7 @@ import FlutterMacOS
 class FlutterWindowDelegate: NSObject, NSWindowDelegate {
     private var methodChannel: FlutterMethodChannel?
     private var fullScreenPresentationOptions: NSApplication.PresentationOptions?
+    public var windowShouldCloseReturnValue: Bool = true
 
     public static func create(window: NSWindow, methodChannel: FlutterMethodChannel) -> FlutterWindowDelegate {
         let newDelegate = FlutterWindowDelegate()
@@ -142,7 +143,8 @@ class FlutterWindowDelegate: NSObject, NSWindowDelegate {
 
     func windowShouldClose(_ sender: NSWindow) -> Bool {
         methodChannel!.invokeMethod("windowShouldClose", arguments: nil)
-        return true
+
+        return windowShouldCloseReturnValue
     }
 
     func windowWillClose(_ notification: Notification) {

macos/Classes/MacOSWindowUtilsPlugin.swift

@@ -484,6 +484,28 @@ public class MacOSWindowUtilsPlugin: NSObject, FlutterPlugin {
             result(true)
             break
 
+        case "preventWindowClosure":
+            result(MainFlutterWindowManipulator.preventWindowClosure())
+            break
+
+        case "allowWindowClosure":
+            result(MainFlutterWindowManipulator.allowWindowClosure())
+            break
+
+        case "isWindowClosureAllowed":
+            result(MainFlutterWindowManipulator.isWindowClosureAllowed())
+            break
+
+        case "closeWindow":
+            MainFlutterWindowManipulator.closeWindow()
+            result(true)
+            break
+
+        case "performClose":
+            MainFlutterWindowManipulator.performClose()
+            result(true)
+            break
+
         default:
             result(FlutterMethodNotImplemented)
             break