[windows] Add hidden at launch document #51 #39

Author: lijy91

README-ZH.md

@@ -30,6 +30,7 @@
         - [Windows](#windows)
       - [在启动时隐藏](#在启动时隐藏)
         - [macOS](#macos-1)
+        - [Windows](#windows-1)
   - [谁在用使用它？](#谁在用使用它)
   - [API](#api)
     - [WindowManager](#windowmanager)
@@ -104,7 +105,7 @@
 
 ### 安装
 
-将此添加到你的软件包的 pubspec.yaml 文件：
+将此添加到你的软件包的 `pubspec.yaml` 文件：
 
 ```yaml
 dependencies:
@@ -134,11 +135,12 @@ void main() async {
 
   // Use it only after calling `hiddenWindowAtLaunch`
   windowManager.waitUntilReadyToShow().then((_) async{
-    // 设置为无边框窗口
-    await windowManager.setAsFrameless();
-    await windowManager.setSize(Size(600, 600));
+    // 隐藏窗口标题栏
+    await windowManager.setTitleBarStyle('hidden');
+    await windowManager.setSize(Size(800, 600));
     await windowManager.setPosition(Offset.zero);
-    windowManager.show();
+    await windowManager.show();
+    await windowManager.setSkipTaskbar(false);
   });
 
   runApp(MyApp());
@@ -233,13 +235,14 @@ class _HomePageState extends State<HomePage> with WindowListener {
   }
 }
 ```
+
 #### 关闭时退出
 
 如果你需要使用 `hide` 方法，你需要禁用 `QuitOnClose`。
 
 ##### macOS
 
-`macos/Runner/AppDelegate.swift`
+更改文件 `macos/Runner/AppDelegate.swift` 如下：
 
 ```diff
 import Cocoa
@@ -256,7 +259,7 @@ class AppDelegate: FlutterAppDelegate {
 
 ##### Windows
 
-`windows/runner/main.cpp`
+更改文件 `windows/runner/main.cpp` 如下：
 
 ```diff
 int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
@@ -276,6 +279,8 @@ int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
 
 ##### macOS
 
+更改文件 `macos/Runner/MainFlutterWindow.swift` 如下：
+
 ```diff
 import Cocoa
 import FlutterMacOS
@@ -301,6 +306,63 @@ class MainFlutterWindow: NSWindow {
 
 ```
 
+##### Windows
+
+更改文件 `windows/runner/win32_window.cpp` 如下：
+
+```diff
+bool Win32Window::CreateAndShow(const std::wstring& title,
+                                const Point& origin,
+                                const Size& size) {
+  ...                              
+  HWND window = CreateWindow(
+-      window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE,
++      window_class, title.c_str(),
++      WS_OVERLAPPEDWINDOW, // do not add WS_VISIBLE since the window will be shown later
+      Scale(origin.x, scale_factor), Scale(origin.y, scale_factor),
+      Scale(size.width, scale_factor), Scale(size.height, scale_factor),
+      nullptr, nullptr, GetModuleHandle(nullptr), this);
+```
+
+确保在 `onWindowFocus` 事件中调用一次 `setState`。
+
+```dart
+import 'package:flutter/cupertino.dart';
+import 'package:window_manager/window_manager.dart';
+
+class HomePage extends StatefulWidget {
+  @override
+  _HomePageState createState() => _HomePageState();
+}
+
+class _HomePageState extends State<HomePage> with WindowListener {
+  @override
+  void initState() {
+    windowManager.addListener(this);
+    super.initState();
+  }
+
+  @override
+  void dispose() {
+    windowManager.removeListener(this);
+    super.dispose();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    // ...
+  }
+
+  @override
+  void onWindowFocus() {
+    // Make sure to call once.
+    setState(() {});
+    // do something
+  }
+}
+
+```
+
 ## 谁在用使用它？
 
 - [AuthPass](https://authpass.app/) - 基于Flutter的密码管理器，适用于所有平台。兼容Keepass 2.x（kdbx 3.x）。

README.md

@@ -30,6 +30,7 @@ English | [简体中文](./README-ZH.md)
         - [Windows](#windows)
       - [Hidden at launch](#hidden-at-launch)
         - [macOS](#macos-1)
+        - [Windows](#windows-1)
   - [Who's using it?](#whos-using-it)
   - [API](#api)
     - [WindowManager](#windowmanager)
@@ -104,7 +105,7 @@ English | [简体中文](./README-ZH.md)
 
 ### Installation
 
-Add this to your package's pubspec.yaml file:
+Add this to your package's `pubspec.yaml` file:
 
 ```yaml
 dependencies:
@@ -134,11 +135,12 @@ void main() async {
 
   // Use it only after calling `hiddenWindowAtLaunch`
   windowManager.waitUntilReadyToShow().then((_) async{
-    // Set to frameless window
-    await windowManager.setAsFrameless();
-    await windowManager.setSize(Size(600, 600));
+    // Hide window title bar
+    await windowManager.setTitleBarStyle('hidden');
+    await windowManager.setSize(Size(800, 600));
     await windowManager.setPosition(Offset.zero);
-    windowManager.show();
+    await windowManager.show();
+    await windowManager.setSkipTaskbar(false);
   });
 
   runApp(MyApp());
@@ -233,13 +235,14 @@ class _HomePageState extends State<HomePage> with WindowListener {
   }
 }
 ```
+
 #### Quit on close
 
 If you need to use the hide method, you need to disable `QuitOnClose`.
 
 ##### macOS
 
-`macos/Runner/AppDelegate.swift`
+Change the file `macos/Runner/AppDelegate.swift` as follows:
 
 ```diff
 import Cocoa
@@ -256,7 +259,7 @@ class AppDelegate: FlutterAppDelegate {
 
 ##### Windows
 
-`windows/runner/main.cpp`
+Change the file `windows/runner/main.cpp` as follows:
 
 ```diff
 int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
@@ -276,7 +279,7 @@ int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
 
 ##### macOS
 
-Change the file MainFlutterWindow.swift as follows:
+Change the file `macos/Runner/MainFlutterWindow.swift` as follows:
 
 ```diff
 import Cocoa
@@ -305,7 +308,7 @@ class MainFlutterWindow: NSWindow {
 
 ##### Windows
 
-Change the file windows\runner\win32_window.cpp as follows:
+Change the file `windows/runner/win32_window.cpp` as follows:
 
 ```diff
 bool Win32Window::CreateAndShow(const std::wstring& title,
@@ -321,6 +324,45 @@ bool Win32Window::CreateAndShow(const std::wstring& title,
       nullptr, nullptr, GetModuleHandle(nullptr), this);
 ```
 
+Make sure to call `setState` once on the `onWindowFocus` event.
+
+```dart
+import 'package:flutter/cupertino.dart';
+import 'package:window_manager/window_manager.dart';
+
+class HomePage extends StatefulWidget {
+  @override
+  _HomePageState createState() => _HomePageState();
+}
+
+class _HomePageState extends State<HomePage> with WindowListener {
+  @override
+  void initState() {
+    windowManager.addListener(this);
+    super.initState();
+  }
+
+  @override
+  void dispose() {
+    windowManager.removeListener(this);
+    super.dispose();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    // ...
+  }
+
+  @override
+  void onWindowFocus() {
+    // Make sure to call once.
+    setState(() {});
+    // do something
+  }
+}
+
+```
+
 ## Who's using it?
 
 - [AuthPass](https://authpass.app/) - Password Manager based on Flutter for all platforms. Keepass 2.x (kdbx 3.x) compatible.

example/lib/main.dart

@@ -10,9 +10,12 @@ void main() async {
 
   // Use it only after calling `hiddenWindowAtLaunch`
   windowManager.waitUntilReadyToShow().then((_) async {
-    // await windowManager.setAsFrameless();
+    // Hide window title bar
+    await windowManager.setTitleBarStyle('hidden');
     await windowManager.setSize(Size(800, 600));
     await windowManager.show();
+    await windowManager.focus();
+    await windowManager.setSkipTaskbar(false);
   });
 
   runApp(MyApp());

example/lib/pages/home.dart

@@ -76,9 +76,10 @@ class _HomePageState extends State<HomePage> with WindowListener {
             PreferenceListItem(
               title: Text('show / hide'),
               onTap: () async {
-                windowManager.hide();
+                await windowManager.hide();
                 await Future.delayed(Duration(seconds: 2));
-                windowManager.show();
+                await windowManager.show();
+                await windowManager.focus();
               },
             ),
             PreferenceListItem(
@@ -573,6 +574,11 @@ class _HomePageState extends State<HomePage> with WindowListener {
     );
   }
 
+  @override
+  void onWindowFocus() {
+    setState(() {});
+  }
+
   @override
   void onWindowEvent(String eventName) {
     print('[WindowManager] onWindowEvent: $eventName');

example/windows/runner/main.cpp

@@ -6,8 +6,6 @@
 #include "run_loop.h"
 #include "utils.h"
 
-#include <window_manager/window_manager_plugin.h>
-
 int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
                       _In_ wchar_t *command_line, _In_ int show_command) {
   // Attach to console when present (e.g., 'flutter run') or create a
@@ -29,8 +27,6 @@ int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
 
   project.set_dart_entrypoint_arguments(std::move(command_line_arguments));
 
-  HiddenWindowAtLaunch();
-
   FlutterWindow window(&run_loop, project);
   Win32Window::Point origin(10, 10);
   Win32Window::Size size(1280, 720);

example/windows/runner/win32_window.cpp

@@ -117,7 +117,7 @@ bool Win32Window::CreateAndShow(const std::wstring& title,
   double scale_factor = dpi / 96.0;
 
   HWND window = CreateWindow(
-      window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE,
+      window_class, title.c_str(), WS_OVERLAPPEDWINDOW,
       Scale(origin.x, scale_factor), Scale(origin.y, scale_factor),
       Scale(size.width, scale_factor), Scale(size.height, scale_factor),
       nullptr, nullptr, GetModuleHandle(nullptr), this);

windows/include/window_manager/window_manager_plugin.h

@@ -18,11 +18,6 @@ extern "C" {
 FLUTTER_PLUGIN_EXPORT void WindowManagerPluginRegisterWithRegistrar(
     FlutterDesktopPluginRegistrarRef registrar);
 
-#define WMP_FRAMELESS 0x01
-#define WMP_HIDDEN_AT_LAUNCH 0x02
-
-FLUTTER_PLUGIN_EXPORT void HiddenWindowAtLaunch();
-
 #if defined(__cplusplus)
 }  // extern "C"
 #endif

windows/window_manager.cpp

@@ -155,6 +155,14 @@ void WindowManager::Blur() {
 }
 
 void WindowManager::Show() {
+  HWND hWnd = GetMainWindow();
+  DWORD gwlStyle = GetWindowLong(hWnd, GWL_STYLE);
+  gwlStyle = gwlStyle | WS_VISIBLE;
+  if ((gwlStyle & WS_VISIBLE) == 0) {
+    SetWindowLong(hWnd, GWL_STYLE, gwlStyle);
+    ::SetWindowPos(hWnd, HWND_TOP, 0, 0, 0, 0, SWP_NOSIZE | SWP_NOMOVE);
+  }
+
   ShowWindowAsync(GetMainWindow(), SW_SHOW);
   SetForegroundWindow(GetMainWindow());
 }

windows/window_manager_plugin.cpp

@@ -15,7 +15,6 @@
 #include "window_manager.cpp"
 
 namespace {
-bool is_hidden_window_at_launch = false;
 std::unique_ptr<
     flutter::MethodChannel<flutter::EncodableValue>,
     std::default_delete<flutter::MethodChannel<flutter::EncodableValue>>>
@@ -377,7 +376,3 @@ void WindowManagerPluginRegisterWithRegistrar(
       flutter::PluginRegistrarManager::GetInstance()
           ->GetRegistrar<flutter::PluginRegistrarWindows>(registrar));
 }
-
-void HiddenWindowAtLaunch() {
-  is_hidden_window_at_launch = true;
-}