Flutter快捷菜单扩展插件shortcut_menu_extender的使用

Flutter快捷菜单扩展插件shortcut_menu_extender的使用

该插件允许Flutter应用扩展全局快捷菜单。

平台支持

快速开始

安装

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  shortcut_menu_extender: ^0.1.1

然后运行flutter pub get来安装该依赖。

使用

Windows

首先，修改文件windows/runner/main.cpp如下：

#include <flutter/dart_project.h>
#include <flutter/flutter_view_controller.h>
#include <windows.h>

#include "flutter_window.h"
#include "utils.h"

#include <shortcut_menu_extender_windows/shortcut_menu_extender_windows_plugin_c_api.h>

int APIENTRY wWinMain(_In_ HINSTANCE instance,
                      _In_opt_ HINSTANCE prev,
                      _In_ wchar_t* command_line,
                      _In_ int show_command) {
  HANDLE instance_mutex =
      CreateMutex(NULL, TRUE, L"shortcut_menu_extender_example");
  if (GetLastError() == ERROR_ALREADY_EXISTS &&
      !ShouldHandleByShortcutMenuExtenderCommand()) {
    HWND hwnd = ::FindWindow(L"FLUTTER_RUNNER_WIN32_WINDOW",
                             L"shortcut_menu_extender_example");
    if (hwnd != NULL && ShouldHandleByShortcutMenuExtender()) {
      DispatchToShortcutMenuExtender(hwnd);
    }
    CloseHandle(instance_mutex);
    return EXIT_SUCCESS;
  }

  // Attach to console when present (e.g., 'flutter run') or create a
  // new console when running with a debugger.
  if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) {
    CreateAndAttachConsole();
  }

  // Initialize COM, so that it is available for use in the library and/or
  // plugins.
  ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED);

  flutter::DartProject project(L"data");

  std::vector<std::string> command_line_arguments = GetCommandLineArguments();

  project.set_dart_entrypoint_arguments(std::move(command_line_arguments));

  FlutterWindow window(project);
  Win32Window::Point origin(10, 10);
  Win32Window::Size size(1280, 720);
  if (!window.Create(L"shortcut_menu_extender_example", origin, size)) {
    return EXIT_FAILURE;
  }
  window.SetQuitOnClose(true);

  ::MSG msg;
  while (::GetMessage(&msg, nullptr, 0, 0)) {
    ::TranslateMessage(&msg);
    ::DispatchMessage(&msg);
  }

  ::CoUninitialize();
  return EXIT_SUCCESS;
}

接下来，在你的主入口文件（如main.dart）中初始化并使用该插件：

import 'package:shortcut_menu_extender/shortcut_menu_extender.dart';

void main() async {
  // 必须添加这一行。
  WidgetsFlutterBinding.ensureInitialized();

  if (shortcutMenuExtenderCommand.runIfNeeded(args)) exit(0);

  runApp(MyApp());
}

注册/注销

注册一个快捷菜单项：

shortcutMenuExtender.register(
  'MyFlutterApp',
  name: 'Open With MyFlutterApp',
  executable: Platform.resolvedExecutable,
  useDefaultIcon: true,
);

注销一个快捷菜单项：

shortcutMenuExtender.unregister(
  'MyFlutterApp',
);

监听事件

创建一个状态管理类，并实现ShortcutMenuListener接口：

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

  [@override](/user/override)
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> with ShortcutMenuListener {
  [@override](/user/override)
  void initState() {
    shortcutMenuExtender.addListener(this);
    super.initState();
  }

  [@override](/user/override)
  void dispose() {
    shortcutMenuExtender.removeListener(this);
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    // 构建你的UI
  }

  [@override](/user/override)
  void onShortcutMenuClicked(String key, String path) {
    print('onShortcutMenuClicked: $key, $path');
  }
}

请参阅该插件的示例应用以获取完整的示例。

赞助商

cmlanche

许可证

MIT

示例代码

以下是example/lib/main.dart的完整示例代码：

import 'dart:async';
import 'dart:io';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:shortcut_menu_extender/shortcut_menu_extender.dart';

const _kShortcutMenuKeyMyFlutterApp = 'MyFlutterApp';
const _kShortcutMenuKeyMyFlutterApp2 = 'MyFlutterApp2';

void main(List<String> args) {
  WidgetsFlutterBinding.ensureInitialized();

  if (shortcutMenuExtenderCommand.runIfNeeded(args)) exit(0);
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

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

class _MyAppState extends State<MyApp> with ShortcutMenuListener {
  String _platformVersion = 'Unknown';
  final _shortcutMenuExtenderPlugin = ShortcutMenuExtender();

  final List<FileSystemEntity> _entities = [];

  [@override](/user/override)
  void initState() {
    shortcutMenuExtender.addListener(this);
    super.initState();
    initPlatformState();
  }

  [@override](/user/override)
  void dispose() {
    shortcutMenuExtender.removeListener(this);
    super.dispose();
  }

  // 平台消息是异步的，所以我们在这里初始化。
  Future<void> initPlatformState() async {
    String platformVersion;
    // 平台消息可能会失败，所以我们使用try/catch处理PlatformException。
    // 我们还处理消息可能返回null的情况。
    try {
      platformVersion =
          await _shortcutMenuExtenderPlugin.getPlatformVersion() ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // 如果小部件在异步平台消息飞行时从树中移除，我们希望丢弃回复而不是调用setState更新我们的不存在的外观。
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Column(
          children: [
            Text('Running on: $_platformVersion\n'),
            ElevatedButton(
              onPressed: () {
                shortcutMenuExtender.register(
                  _kShortcutMenuKeyMyFlutterApp,
                  name: 'Open with MyFlutterApp',
                  executable: Platform.resolvedExecutable,
                  useDefaultIcon: true,
                );
              },
              child: const Text('register MyFlutterApp'),
            ),
            ElevatedButton(
              onPressed: () {
                shortcutMenuExtender.unregister(
                  _kShortcutMenuKeyMyFlutterApp,
                );
              },
              child: const Text('unregister MyFlutterApp'),
            ),
            ElevatedButton(
              onPressed: () {
                shortcutMenuExtender.register(
                  _kShortcutMenuKeyMyFlutterApp2,
                  name: '用我的FlutterApp打开',
                  executable: Platform.resolvedExecutable,
                  useDefaultIcon: false,
                );
              },
              child: const Text('register 我的MyFlutterApp2'),
            ),
            ElevatedButton(
              onPressed: () {
                shortcutMenuExtender.unregister(
                  _kShortcutMenuKeyMyFlutterApp2,
                );
              },
              child: const Text('unregister 我的FlutterApp2'),
            ),
            Expanded(
              child: ListView(
                children: [
                  for (final entity in _entities)
                    ListTile(
                      title: Text(entity.statSync().type.toString()),
                      subtitle: Text(entity.path),
                    ),
                ],
              ),
            ),
          ],
        ),
      ),
    );
  }

  [@override](/user/override)
  void onShortcutMenuClicked(String key, String path) {
    if (key == _kShortcutMenuKeyMyFlutterApp) {
      final type = FileSystemEntity.typeSync(path);
      if (type == FileSystemEntityType.file) {
        _entities.add(File(path));
      } else if (type == FileSystemEntityType.directory) {
        _entities.add(Directory(path));
      }
      setState(() {});
    } else if (key == _kShortcutMenuKeyMyFlutterApp2) {
      if (kDebugMode) {
        print('key: $key, path: $path');
      }
    }
  }
}