RustDesk/flutter/lib/common/widgets
rustdesk cd7686baa2 feat(shortcuts): user-configurable keyboard shortcuts for session actions
Adds a keyboard shortcut feature (Rust matcher + Dart UI + cross-language
  parity tests) that lets users bind combinations like Ctrl+Alt+Shift+P to
  session actions. Bindings are stored in LocalConfig under
  `keyboard-shortcuts`; the matcher gates dispatch on `enabled` and
  `pass_through` flags so flipping the master switch off is a hard stop.

  Wire-up summary:
  - src/keyboard/shortcuts.rs: matcher, default bindings, parity test against
    flutter/test/fixtures/default_keyboard_shortcuts.json
  - src/keyboard.rs: shortcut intercept in process_event{,_with_session},
    feature-gated to `flutter`; runs before key swapping so users bind to
    physical keys
  - src/flutter_ffi.rs: main_reload_keyboard_shortcuts +
    main_get_default_keyboard_shortcuts; reload_from_config seeded in main_init
  - flutter/lib/common/widgets/keyboard_shortcuts/: shared config page body,
    recording dialog, shortcut display formatter, action group registry
  - flutter/lib/desktop/pages/desktop_keyboard_shortcuts_page.dart and
    flutter/lib/mobile/pages/mobile_keyboard_shortcuts_page.dart: platform
    shells around the shared body
  - flutter/lib/models/shortcut_model.dart: per-session ShortcutModel +
    registerSessionShortcutActions for actions with no toolbar TToggleMenu /
    TRadioMenu (fullscreen, switch display/tab, close tab, voice call, etc.)
  - flutter/lib/common/widgets/toolbar.dart: optional `actionId` field on
    TToggleMenu / TRadioMenu, plus per-helper auto-register pass that wires
    tagged entries' existing onChanged into the ShortcutModel
  - flutter/test/keyboard_shortcuts_test.dart + fixtures: cross-language
    parity (default bindings, supported key vocabulary)

  Design principles applied during review:

  1. Additions are fine; modifications to original logic must be deliberate.
     Tagging an existing TToggleMenu entry with `actionId:` is an addition.
     Rewriting its onChanged to satisfy a new contract is a modification —
     and was reverted for every case where the original click behavior was
     working. Four closures were touched and then reverted (mobile View
     Mode, Privacy mode multi-impl, Relative mouse mode, Reverse mouse
     wheel); their shortcuts are wired via standalone closures in
     shortcut_model.dart instead.

  2. Toolbar auto-register is reserved for entries whose onChanged is
     inherently self-flipping — typically `sessionToggleOption(name)` where
     the named option is flipped in place and the input bool is unused. The
     register pass passes `!menu.value` from registration time, which is
     harmless under self-flipping but wrong for closures that consume the
     input bool directly. Tagging a non-self-flipping entry forces a closure
     rewrite; choose non-toolbar registration in that case.

  3. When shortcuts are disabled, toolbar behavior must be bit-for-bit
     unchanged. The matcher's `enabled`-gate already guarantees no
     dispatch; the auto-register pass is left unconditional (its only effect
     is HashMap operations on a separate ShortcutModel) so mid-session
     enable works without a reconnect. The trade-off is intentional and
     documented at the top of toolbarControls.

  4. Comments stay terse. Rationale lives in one place — the doc comment of
     the helper or registration site, not duplicated at every call site.

  5. Where an existing helper needs a new optional behavior (e.g.
     `_OptionCheckBox` gaining a tooltip slot), the new branch must reduce
     to byte-identical output for existing callers (`trailing == null`
     case → original `Expanded(Text)` layout). Verified.

  6. Action IDs and labels stay consistent. Renamed `reset_cursor` →
     `reset_canvas` so the action ID matches its user-facing label
     ("Reset canvas") and capability flag.

  Out-of-scope but included:
  - AGENTS.md: documents flutter_rust_bridge no-codegen workflow and the
    Web target's hand-written TS client, since both are load-bearing for
    any new FFI work.
  - remote_toolbar.dart: i18n fix for the per-monitor tooltip ("All
    monitors" / "Monitor #N"), unrelated to shortcuts but kept here.
2026-04-30 16:40:42 +08:00
..
keyboard_shortcuts feat(shortcuts): user-configurable keyboard shortcuts for session actions 2026-04-30 16:40:42 +08:00
address_book.dart flutter: improve address book pull error handling (#14813) 2026-04-18 11:19:32 +08:00
animated_rotation_widget.dart don't use Offstage as widget of animated loading, reuse refresh as 2023-08-18 12:58:37 +08:00
audio_input.dart feat: macos, audio, loopback (#10025) 2024-11-23 19:41:27 +09:00
autocomplete.dart refact: Remote ID editor, only select text on focus (#10854) 2025-02-20 19:35:04 +08:00
chat_page.dart fix: linux, flutter, workaround freeze (#10324) 2024-12-20 09:24:08 +08:00
connection_page_title.dart refact: web desktop, web_id_input_tip (#9490) 2024-09-27 21:56:10 +08:00
custom_password.dart password lowercase check like uppercase (#9343) 2024-09-13 09:29:00 +08:00
custom_scale_base.dart fix: scale custom on mobile (#13324) 2025-10-31 11:08:03 +08:00
dialog.dart ask for note at end of connection (#13499) 2025-11-13 23:35:40 +08:00
gestures.dart fix issue: #13911 'Double Click' bug on iPad with Magic Mouse (#14086) 2026-01-28 15:14:06 +08:00
login.dart add microsoft oidc logo 2026-04-15 14:39:46 +08:00
my_group.dart - UI display: display_name first (#14358) 2026-02-22 14:59:25 +08:00
overlay.dart flutter: keep chat window within screen bounds to prevent hidden chat window (fixes rustdesk#13397) (#13406) 2025-11-04 09:44:13 +08:00
peer_card.dart show peer note (#13140) 2025-10-12 14:59:42 +08:00
peer_tab_page.dart fix: load local peers, called two times on select tab (#10859) 2025-02-20 22:47:42 +08:00
peers_view.dart - UI display: display_name first (#14358) 2026-02-22 14:59:25 +08:00
remote_input.dart fix(iPad): keep touch gestures with external mouse (#14652) 2026-04-27 19:44:35 +08:00
setting_widgets.dart refact: option, touch mode, move to local (#13055) 2025-10-17 13:36:46 +08:00
toolbar.dart feat(shortcuts): user-configurable keyboard shortcuts for session actions 2026-04-30 16:40:42 +08:00