Flutter Windows平台钩子插件win32hooks的使用

win32hooks

一个用于跟踪鼠标按钮和Windows事件的Windows Flutter插件。

示例输出：

flutter: WinEventInfo: EventStruct(event: 10, hWnd: 262318, idObject: 0, idChild: 0, dwEventThread: 11296, dwmsEventTime: 183474890)
flutter: WinEventInfo: EventStruct(event: 11, hWnd: 262318, idObject: 0, idChild: 0, dwEventThread: 11296, dwmsEventTime: 183474968)
flutter: MouseInfo: MouseStruct(button: MouseButtons.Button4, down: true, up: false, type: MouseEvent.control)
flutter: MouseInfo: MouseStruct(button: MouseButtons.Button4, down: false, up: true, type: MouseEvent.control)

开始使用

这还不是完全完成的版本，但如果你不想调试Windows API，它已经足够使用了。

简单示例

// 在任何类之外：
final winHooks = WinHooks(); // 全局变量。

class _MyAppState extends State<MyApp> with WinHookEventListener {

  [@override](/user/override)
  void initState() {
    super.initState();
    initialState();
  }

  Future<void> initialState() async {
    if (!mounted) return;
    // 对于onMouseInfoReceived和onWinEventInfoReceived
    winHooks.addListener(this);

    /// 清理cpp内存中的鼠标按钮和dart事件变量
    /// 当你重新加载或热重载应用时，如果在期间更改了按钮，这将非常有用。
    winHooks.cleanHooks();

    /// 参数是自解释的。
    winHooks.setWinEventParameters(minEvent: WinHookEvent.SYSTEM_MOVESIZESTART, maxEvent: WinHookEvent.SYSTEM_MOVESIZEEND, reinstallHooks: false);

    /// [MouseEvent.control] 用于阻止该按钮的传播
    /// [MouseEvent.watch] 仅用于接收按下按钮时的回调。
    winHooks.addMouseHook(button: MouseButtons.Button4, mouseEvent: MouseEvent.control, reinstallHooks: false);

    /// 初始化cpp调用。
    winHooks.installWinHook();
    setState(() {});
  }

  /**
  MouseStruct {
      MouseButtons button;
      bool down = false;
      bool up = false;
      MouseEvent type;
  }
  MouseButtons {
      Left,
      Right,
      Middle,
      ScrollUp,
      ScrollDown,
      Button3,
      Button4,
  }
  enum MouseEvent { control, watch }
  */
  [@override](/user/override)
  void onMouseInfoReceived(MouseStruct mouse) {
    print("MouseInfo: ${mouse.toString()}");
  }

  /**
      int event = 0;
      int hWnd = 0;
      int idObject = 0;
      int idChild = 0;
      int dwEventThread = 0;
      int dwmsEventTime = 0;
  */

  [@override](/user/override)
  void onWinEventInfoReceived(WinEventStruct event) {
    print("WinEventInfo: ${event.toString()}");
  }
}

完整示例代码

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:win32hooks/const.win.dart';
import 'dart:async';

import 'package:win32hooks/win32hooks.dart';

final winHooks = WinHooks();

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> with WinHookEventListener {
  [@override](/user/override)
  void initState() {
    super.initState();
    initialState();
  }

  Future<void> initialState() async {
    if (!mounted) return;
    //winHooks.uninstallWinHook();
    winHooks.addListener(this);
    winHooks.cleanHooks();
    winHooks.setWinEventParameters(minEvent: WinHookEvent.SYSTEM_MOVESIZESTART, maxEvent: WinHookEvent.SYSTEM_MOVESIZEEND, reinstallHooks: false);
    winHooks.addMouseHook(button: MouseButtons.Button4, mouseEvent: MouseEvent.control, reinstallHooks: false);
    winHooks.installWinHook();
    setState(() {});
  }

  [@override](/user/override)
  void onMouseInfoReceived(MouseStruct mouse) {
    print("MouseInfo: ${mouse.toString()}");
  }

  [@override](/user/override)
  void onWinEventInfoReceived(WinEventStruct event) {
    print("WinEventInfo: ${event.toString()}");
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: Column(
            children: [
              const Divider(height: 10, thickness: 10, color: Colors.transparent),
              OutlinedButton(
                child: const Text('安装WinHooks'),
                onPressed: () async {
                  await winHooks.installWinHook();
                  setState(() {});
                },
              ),
              const Divider(
                height: 10,
                thickness: 10,
                color: Colors.transparent,
              ),
              OutlinedButton(
                child: const Text('卸载钩子'),
                onPressed: () {
                  winHooks.uninstallWinHook();
                },
              ),
              Text("${winHooks.hookMouseID} : ${winHooks.hookEventID}"),
              const SizedBox(height: 10),
              // 插入富文本区域
            ],
          ),
        ),
      ),
    );
  }
}