[desktop_multi_window] Added the resizable function (macOS only) (MixinNetwork#130)

GroovinChip · web-flow · commit 775846bef243 · 2022-08-07T12:37:57.000+08:00
* [desktop_multi_window] first pass at `resizable` flag

* [desktop_multi_window] fix typo in example

* [desktop_multi_window] Working resizable function

Fixes an error I made where the insert/remove functions were in the wrong blocks of the condition

* [desktop_multi_window] Improve docs

* Improves `resizable` docs
* Fix grammar for `setFrameAutosaveName`

* [desktop_multi_window] Make it clear that `resizable` is only for macOS

* [desktop_multi_window] Update version &amp; changelog
diff --git a/packages/desktop_multi_window/CHANGELOG.md b/packages/desktop_multi_window/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.2.0
+* Added the ability to determine whether a created window will be resizable or not
+([#101](https://github.com/MixinNetwork/flutter-plugins/issues/101) and [#130](https://github.com/MixinNetwork/flutter-plugins/pull/130))
+
 ## 0.1.0
 
 * [BREAK CHANGE] upgrade min flutter version to 3.0.0
diff --git a/packages/desktop_multi_window/example/lib/main.dart b/packages/desktop_multi_window/example/lib/main.dart
@@ -45,12 +45,13 @@ class _ExampleMainWindowState extends State<_ExampleMainWindow> {
                   'args1': 'Sub window',
                   'args2': 100,
                   'args3': true,
-                  'bussiness': 'bussiness_test',
+                  'business': 'business_test',
                 }));
                 window
                   ..setFrame(const Offset(0, 0) & const Size(1280, 720))
                   ..center()
                   ..setTitle('Another window')
+                  ..resizable(false)
                   ..show();
               },
               child: const Text('Create a new World!'),
diff --git a/packages/desktop_multi_window/example/pubspec.lock b/packages/desktop_multi_window/example/pubspec.lock
@@ -63,7 +63,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.2"
+    version: "0.2.0"
   fake_async:
     dependency: transitive
     description:
diff --git a/packages/desktop_multi_window/lib/desktop_multi_window.dart b/packages/desktop_multi_window/lib/desktop_multi_window.dart
@@ -27,7 +27,7 @@ class DesktopMultiWindow {
   /// NOTE: [createWindow] will only create a new window, you need to call
   /// [WindowController.show] to show the window.
   static Future<WindowController> createWindow([String? arguments]) async {
-    final windowId = await miltiWindowChannel.invokeMethod<int>(
+    final windowId = await multiWindowChannel.invokeMethod<int>(
       'createWindow',
       arguments,
     );
@@ -73,7 +73,7 @@ class DesktopMultiWindow {
 
   /// Get all sub window id.
   static Future<List<int>> getAllSubWindowIds() async {
-    final result = await miltiWindowChannel
+    final result = await multiWindowChannel
         .invokeMethod<List<dynamic>>('getAllSubWindowIds');
     final ids = result?.cast<int>() ?? const [];
     assert(!ids.contains(0), 'ids must not contains main window id');
diff --git a/packages/desktop_multi_window/lib/src/channels.dart b/packages/desktop_multi_window/lib/src/channels.dart
@@ -1,6 +1,6 @@
 import 'package:flutter/services.dart';
 
-const miltiWindowChannel = MethodChannel('mixin.one/flutter_multi_window');
+const multiWindowChannel = MethodChannel('mixin.one/flutter_multi_window');
 
 const windowEventChannel = MethodChannel(
   'mixin.one/flutter_multi_window_channel',
diff --git a/packages/desktop_multi_window/lib/src/window_controller.dart b/packages/desktop_multi_window/lib/src/window_controller.dart
@@ -36,6 +36,13 @@ abstract class WindowController {
   /// Set the window's title.
   Future<void> setTitle(String title);
 
-  /// available only on macOS.
+  /// Whether the window can be resized. Available only on macOS.
+  ///
+  /// Most useful for ensuring windows *cannot* be resized. Windows are
+  /// resizable by default, so there is no need to explicitly define a window
+  /// as resizable by calling this function.
+  Future<void> resizable(bool resizable);
+
+  /// Available only on macOS.
   Future<void> setFrameAutosaveName(String name);
 }
diff --git a/packages/desktop_multi_window/lib/src/window_controller_impl.dart b/packages/desktop_multi_window/lib/src/window_controller_impl.dart
@@ -1,3 +1,4 @@
+import 'dart:io';
 import 'dart:ui';
 
 import 'package:flutter/services.dart';
@@ -6,7 +7,7 @@ import 'channels.dart';
 import 'window_controller.dart';
 
 class WindowControllerMainImpl extends WindowController {
-  final MethodChannel _channel = miltiWindowChannel;
+  final MethodChannel _channel = multiWindowChannel;
 
   // the id of this window
   final int _id;
@@ -55,6 +56,20 @@ class WindowControllerMainImpl extends WindowController {
     });
   }
 
+  @override
+  Future<void> resizable(bool resizable) {
+    if (Platform.isMacOS) {
+      return _channel.invokeMethod('resizable', <String, dynamic>{
+        'windowId': _id,
+        'resizable': resizable,
+      });
+    } else {
+      throw MissingPluginException(
+        'This functionality is only available on macOS',
+      );
+    }
+  }
+
   @override
   Future<void> setFrameAutosaveName(String name) {
     return _channel.invokeMethod('setFrameAutosaveName', <String, dynamic>{
diff --git a/packages/desktop_multi_window/macos/Classes/FlutterMultiWindowPlugin.swift b/packages/desktop_multi_window/macos/Classes/FlutterMultiWindowPlugin.swift
@@ -67,6 +67,12 @@ public class FlutterMultiWindowPlugin: NSObject, FlutterPlugin {
       let title = arguments["title"] as! String
       MultiWindowManager.shared.setTitle(windowId: windowId, title: title)
       result(nil)
+	case "resizable":
+	  let arguments = call.arguments as! [String: Any?]
+	  let windowId = arguments["windowId"] as! Int64
+	  let resizable = arguments["resizable"] as! Bool
+	  MultiWindowManager.shared.resizable(windowId: windowId, resizable: resizable)
+	  result(nil)
     case "setFrameAutosaveName":
       let arguments = call.arguments as! [String: Any?]
       let windowId = arguments["windowId"] as! Int64
diff --git a/packages/desktop_multi_window/macos/Classes/FlutterWindow.swift b/packages/desktop_multi_window/macos/Classes/FlutterWindow.swift
@@ -39,6 +39,14 @@ class BaseFlutterWindow: NSObject {
     window.title = title
   }
 
+  func resizable(resizable: Bool) {
+    if (resizable) {
+      window.styleMask.insert(.resizable)
+    } else {
+      window.styleMask.remove(.resizable)
+    }
+  }
+
   func close() {
     window.close()
   }
diff --git a/packages/desktop_multi_window/macos/Classes/MultiWindowManager.swift b/packages/desktop_multi_window/macos/Classes/MultiWindowManager.swift
@@ -94,6 +94,14 @@ class MultiWindowManager {
     window.setTitle(title: title)
   }
 
+  func resizable(windowId: Int64, resizable: Bool) {
+    guard let window = windows[windowId] else {
+      debugPrint("window \(windowId) not exists.")
+      return
+    }
+    window.resizable(resizable: resizable)
+  }
+
   func setFrameAutosaveName(windowId: Int64, name: String) {
     guard let window = windows[windowId] else {
       debugPrint("window \(windowId) not exists.")
diff --git a/packages/desktop_multi_window/pubspec.yaml b/packages/desktop_multi_window/pubspec.yaml
@@ -1,6 +1,6 @@
 name: desktop_multi_window
 description: A flutter plugin that create and manager multi window in desktop.
-version: 0.1.0
+version: 0.2.0
 homepage: https://github.com/MixinNetwork/flutter-plugins/tree/main/packages/desktop_multi_window
 
 environment:

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,14 @@ class BaseFlutterWindow: NSObject {`
`39`	`39`	`window.title = title`
`40`	`40`	`}`
`41`	`41`
	`42`	`+ func resizable(resizable: Bool) {`
	`43`	`+ if (resizable) {`
	`44`	`+ window.styleMask.insert(.resizable)`
	`45`	`+ } else {`
	`46`	`+ window.styleMask.remove(.resizable)`
	`47`	`+ }`
	`48`	`+ }`
	`49`	`+`
`42`	`50`	`func close() {`
`43`	`51`	`window.close()`
`44`	`52`	`}`