Merge pull request #7 from Adrian-Samoticha/issue_5

Issue #5

Author: Adrian-Samoticha

example/lib/main_area/command_list_provider.dart

@@ -1,5 +1,6 @@
 import 'dart:async';
 
+import 'package:macos_window_utils/macos/ns_window_level.dart';
 import 'package:macos_window_utils/macos/ns_window_toolbar_style.dart';
 import 'package:macos_window_utils/macos/ns_visual_effect_view_material.dart';
 import 'package:macos_window_utils/macos/ns_visual_effect_view_state.dart';
@@ -332,6 +333,49 @@ class CommandListProvider {
             'subtitle.',
         function: () => WindowManipulator.setSubtitle(''),
       ),
+      Command(
+        name: 'setLevel(NSWindowLevel.floating)',
+        description: 'Sets the window to appear in front of all normal-level '
+            'windows.',
+        function: () => WindowManipulator.setLevel(NSWindowLevel.floating),
+      ),
+      Command(
+        name: 'setLevel(NSWindowLevel.normal.withOffset(-1))',
+        description: 'Sets the window to appear in behind all normal-level '
+            'windows.',
+        function: () =>
+            WindowManipulator.setLevel(NSWindowLevel.normal.withOffset(-1)),
+      ),
+      Command(
+        name: 'setLevel(NSWindowLevel.normal)',
+        description: 'Resets the window\'s level to the default value.',
+        function: () => WindowManipulator.setLevel(NSWindowLevel.normal),
+      ),
+      Command(
+        name: 'orderOut()',
+        description: 'Removes the window from the screen list, which hides the '
+            'window.',
+        function: () => WindowManipulator.orderOut(),
+      ),
+      Command(
+        name: 'orderBack()',
+        description: 'Moves the window to the back of its level in the screen '
+            'list, without changing either the key window or the main window.',
+        function: () => WindowManipulator.orderBack(),
+      ),
+      Command(
+        name: 'orderFront()',
+        description: 'Moves the window to the front of its level in the screen '
+            'list, without changing either the key window or the main window.',
+        function: () => WindowManipulator.orderFront(),
+      ),
+      Command(
+        name: 'orderFrontRegardless()',
+        description: 'Moves the window to the front of its level, even if its '
+            'application isn\'t active, without changing either the key window '
+            'or the main window.',
+        function: () => WindowManipulator.orderFrontRegardless(),
+      ),
     ];
   }
 }

lib/macos/ns_visual_effect_view_state.dart

@@ -1,4 +1,4 @@
-/// Available `NSVisualEffectViewState` states.
+/// Available `NSVisualEffectViewState` values.
 enum NSVisualEffectViewState {
   /// The backdrop should always appear active.
   active,

lib/macos/ns_window_level.dart

@@ -0,0 +1,64 @@
+/// This enum maps to the `NSWindow.Level` structure in Swift.
+enum _Base {
+  floating,
+  mainMenu,
+  modalPanel,
+  normal,
+  popUpMenu,
+  screenSaver,
+  statusBar,
+  submenu,
+  tornOffMenu,
+}
+
+/// A class that represents the level of an `NSWindow`.
+class NSWindowLevel {
+  final _Base _base;
+  final int offset;
+
+  String get baseName => _base.name;
+
+  const NSWindowLevel._withValues(this._base, this.offset);
+
+  /// Useful for floating palettes.
+  static NSWindowLevel floating =
+      const NSWindowLevel._withValues(_Base.floating, 0);
+
+  /// Reserved for the application’s main menu.
+  static NSWindowLevel mainMenu =
+      const NSWindowLevel._withValues(_Base.mainMenu, 0);
+
+  /// The level for a modal panel.
+  static NSWindowLevel modalPanel =
+      const NSWindowLevel._withValues(_Base.modalPanel, 0);
+
+  /// The default level for NSWindow objects.
+  static NSWindowLevel normal =
+      const NSWindowLevel._withValues(_Base.normal, 0);
+
+  /// The level for a pop-up menu.
+  static NSWindowLevel popUpMenu =
+      const NSWindowLevel._withValues(_Base.popUpMenu, 0);
+
+  /// The level for a screen saver.
+  static NSWindowLevel screenSaver =
+      const NSWindowLevel._withValues(_Base.screenSaver, 0);
+
+  /// The level for a status window.
+  static NSWindowLevel statusBar =
+      const NSWindowLevel._withValues(_Base.statusBar, 0);
+
+  /// Reserved for submenus. Synonymous with `NSTornOffMenuWindowLevel`, which
+  /// is preferred.
+  static NSWindowLevel submenu =
+      const NSWindowLevel._withValues(_Base.submenu, 0);
+
+  /// The level for a torn-off menu. Synonymous with `NSSubmenuWindowLevel`.
+  static NSWindowLevel tornOffMenu =
+      const NSWindowLevel._withValues(_Base.tornOffMenu, 0);
+
+  /// Returns a new instance of [NSWindowLevel] with a given offset.
+  NSWindowLevel withOffset(int offset) {
+    return NSWindowLevel._withValues(_base, offset);
+  }
+}

lib/window_manipulator.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 
 import 'package:flutter/services.dart';
 import 'package:macos_window_utils/macos/ns_visual_effect_view_state.dart';
+import 'package:macos_window_utils/macos/ns_window_level.dart';
 import 'package:macos_window_utils/macos/ns_window_toolbar_style.dart';
 import 'package:macos_window_utils/macos/visual_effect_view_properties.dart';
 import 'package:macos_window_utils/macos/ns_visual_effect_view_material.dart';
@@ -458,4 +459,58 @@ class WindowManipulator {
       'subtitle': subtitle,
     });
   }
+
+  /// Sets the level of the window.
+  ///
+  /// Each level in the list groups windows within it in front of those in all
+  /// preceding groups. Floating windows, for example, appear in front of all
+  /// normal-level windows. When a window enters a new level, it’s ordered in
+  /// front of all its peers in that level.
+  ///
+  /// Usage examples:
+  ///
+  /// ```dart
+  /// // Set the window to appear in front of all normal-level windows:
+  /// WindowManipulator.setLevel(NSWindowLevel.floating);
+  ///
+  /// // Set the window to appear behind all normal-level windows:
+  /// WindowManipulator.setLevel(NSWindowLevel.normal.withOffset(-1));
+  ///
+  /// // Reset the window's level to the default value:
+  /// WindowManipulator.setLevel(NSWindowLevel.normal);
+  /// ```
+  static Future<void> setLevel(NSWindowLevel level) async {
+    await _completer.future;
+    await _methodChannel.invokeMethod('setLevel', {
+      'base': level.baseName,
+      'offset': level.offset,
+    });
+  }
+
+  /// Removes the window from the screen list, which hides the window.
+  static Future<void> orderOut() async {
+    await _completer.future;
+    await _methodChannel.invokeMethod('orderOut');
+  }
+
+  /// Moves the window to the back of its level in the screen list, without
+  /// changing either the key window or the main window.
+  static Future<void> orderBack() async {
+    await _completer.future;
+    await _methodChannel.invokeMethod('orderBack');
+  }
+
+  /// Moves the window to the front of its level in the screen list, without
+  /// changing either the key window or the main window.
+  static Future<void> orderFront() async {
+    await _completer.future;
+    await _methodChannel.invokeMethod('orderFront');
+  }
+
+  /// Moves the window to the front of its level, even if its application isn't
+  /// active, without changing either the key window or the main window.
+  static Future<void> orderFrontRegardless() async {
+    await _completer.future;
+    await _methodChannel.invokeMethod('orderFrontRegardless');
+  }
 }

macos/Classes/LevelNameToLevelConverter.swift

@@ -0,0 +1,44 @@
+//
+//  LevelNameToLevelConverter.swift
+//  macos_window_utils
+//
+//  Created by Adrian Samoticha on 11.01.23.
+//
+
+import Foundation
+
+class LevelNameToLevelConverter {
+    public static func getLevelFromName(_ name: String) -> NSWindow.Level {
+        switch (name) {
+        case "floating":
+            return .floating
+        
+        case "mainMenu":
+            return .mainMenu
+            
+        case "modalPanel":
+            return .modalPanel
+            
+        case "normal":
+            return .normal
+            
+        case "popUpMenu":
+            return .popUpMenu
+            
+        case "screenSaver":
+            return .screenSaver
+            
+        case "statusBar":
+            return .statusBar
+            
+        case "submenu":
+            return .submenu
+            
+        case "tornOffMenu":
+            return .tornOffMenu
+            
+        default:
+            return .normal
+        }
+    }
+}

macos/Classes/MacOSWindowUtilsPlugin.swift

@@ -356,6 +356,33 @@ public class MacOSWindowUtilsPlugin: NSObject, FlutterPlugin {
             result(true)
             break
 
+        case "setLevel":
+            let baseName = args["base"] as! String
+            let offset = args["offset"] as! Int
+            
+            let baseLevel = LevelNameToLevelConverter.getLevelFromName(baseName)
+            let level = NSWindow.Level(baseLevel.rawValue + offset)
+            
+            MainFlutterWindowManipulator.setLevel(level)
+            
+            result(true)
+            
+        case "orderOut":
+            MainFlutterWindowManipulator.orderOut()
+            result(true)
+            
+        case "orderBack":
+            MainFlutterWindowManipulator.orderBack()
+            result(true)
+            
+        case "orderFront":
+            MainFlutterWindowManipulator.orderFront()
+            result(true)
+            
+        case "orderFrontRegardless":
+            MainFlutterWindowManipulator.orderFrontRegardless()
+            result(true)
+            
         default:
             result(FlutterMethodNotImplemented)
             break

macos/Classes/MainFlutterWindowManipulator.swift

@@ -488,4 +488,50 @@ public class MainFlutterWindowManipulator {
 
         self.mainFlutterWindow!.subtitle = subtitle
     }
+    
+    public static func setLevel(_ level: NSWindow.Level) {
+        if (self.mainFlutterWindow == nil) {
+            printNotStartedWarning()
+            return
+        }
+        
+        self.mainFlutterWindow!.level = level
+    }
+    
+    public static func orderOut() {
+        if (self.mainFlutterWindow == nil) {
+            printNotStartedWarning()
+            return
+        }
+        
+        self.mainFlutterWindow!.orderOut(nil)
+    }
+    
+    public static func orderBack() {
+        if (self.mainFlutterWindow == nil) {
+            printNotStartedWarning()
+            return
+        }
+        
+        self.mainFlutterWindow!.orderBack(nil)
+    }
+    
+    
+    public static func orderFront() {
+        if (self.mainFlutterWindow == nil) {
+            printNotStartedWarning()
+            return
+        }
+        
+        self.mainFlutterWindow!.orderFront(nil)
+    }
+    
+    public static func orderFrontRegardless() {
+        if (self.mainFlutterWindow == nil) {
+            printNotStartedWarning()
+            return
+        }
+        
+        self.mainFlutterWindow!.orderFrontRegardless()
+    }
 }