starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Question: Is there a way to get keybinding and convert it to string (text)? #9008

New Issue
Closed
opened 2026-01-31 01:43:33 +00:00 by claunia · 12 comments
claunia commented 2026-01-31 01:43:33 +00:00
Owner
Copy Link

Originally created by @Chips1234 on GitHub (Jun 13, 2020).

Description of the new feature/enhancement

Is there a way to get the appkeybinding item (e.g. shortcut "Ctrl+T") and convert it to string so we can display it as tooltip/dialog label etc? Thank you in advance!

Originally created by @Chips1234 on GitHub (Jun 13, 2020). <!-- 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING: 1. If I delete this entire template and go my own path, the core team may close my issue without further explanation or engagement. 2. If I list multiple bugs/concerns in this one issue, the core team may close my issue without further explanation or engagement. 3. If I write an issue that has many duplicates, the core team may close my issue without further explanation or engagement (and without necessarily spending time to find the exact duplicate ID number). 4. If I leave the title incomplete when filing the issue, the core team may close my issue without further explanation or engagement. 5. If I file something completely blank in the body, the core team may close my issue without further explanation or engagement. All good? Then proceed! --> # Description of the new feature/enhancement Is there a way to get the `appkeybinding` item (e.g. shortcut "Ctrl+T") and convert it to string so we can display it as tooltip/dialog label etc? Thank you in advance!
claunia commented 2026-01-31 01:43:34 +00:00
Author
Owner
Copy Link

@beviu commented on GitHub (Jun 14, 2020):

Maybe you can use this:

c0ffc9b6dc/src/cascadia/TerminalApp/TerminalPage.cpp (L1406-L1411)

@beviu commented on GitHub (Jun 14, 2020): Maybe you can use this: https://github.com/microsoft/terminal/blob/c0ffc9b6dce9b632c868b6584a0f1c8c9dd1df93/src/cascadia/TerminalApp/TerminalPage.cpp#L1406-L1411
claunia commented 2026-01-31 01:43:34 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Jun 15, 2020):

Even better, I'd try KeyChordSerialization::ToString. That's what I'm using to similar effect in the command palette:
dd684cbca1/src/cascadia/TerminalApp/TerminalPage.cpp (L106-L110)

@zadjii-msft commented on GitHub (Jun 15, 2020): Even better, I'd try `KeyChordSerialization::ToString`. That's what I'm using to similar effect in the command palette: https://github.com/microsoft/terminal/blob/dd684cbca1002806f4b8b80d80178942f0bcbb81/src/cascadia/TerminalApp/TerminalPage.cpp#L106-L110
claunia commented 2026-01-31 01:43:35 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 15, 2020):

Okay thanks!

@Chips1234 commented on GitHub (Jun 15, 2020): Okay thanks!
claunia commented 2026-01-31 01:43:35 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 15, 2020):

So do I replace command with the command (example Copy)?

@Chips1234 commented on GitHub (Jun 15, 2020): So do I replace `command` with the command (example Copy)?
claunia commented 2026-01-31 01:43:35 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 15, 2020):

@zadjii-msft. So, can you please give me an example (maybe for the copyText shortcut?) Thanks!

@Chips1234 commented on GitHub (Jun 15, 2020): @zadjii-msft. So, can you please give me an example (maybe for the copyText shortcut?) Thanks!
claunia commented 2026-01-31 01:43:35 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 16, 2020):

And what should I call the method? std::wstring?

@Chips1234 commented on GitHub (Jun 16, 2020): And what should I call the method? `std::wstring`?
claunia commented 2026-01-31 01:43:35 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Jun 16, 2020):

I'd probably just make a method on AppKeyBindings that exposed the map of KeyChord->ActionAndArgs, and I'd do something like this:

for (const auto& keyAndArgs : _settings->GetKeybindings().GetKeyMap())
{
    const auto& chord = keyAndArgs.first;
    const auto& actionAndArgs = keyAndArgs.second;
    if (keyChord) 
    { 
        auto label = KeyChordSerialization::ToString(keyChord);
        // Do something with the label here. 
        // EX: Maybe append it to a text box:
        _myTextBox.Text(fmt::format(L"{} - {}", _myTextBox.Text(), label));
    }
}

That would be easier than building every possible action and then checking if that action is bound to something.

@zadjii-msft commented on GitHub (Jun 16, 2020): I'd probably just make a method on `AppKeyBindings` that exposed the map of `KeyChord`->`ActionAndArgs`, and I'd do something like this: ```c++ for (const auto& keyAndArgs : _settings->GetKeybindings().GetKeyMap()) { const auto& chord = keyAndArgs.first; const auto& actionAndArgs = keyAndArgs.second; if (keyChord) { auto label = KeyChordSerialization::ToString(keyChord); // Do something with the label here. // EX: Maybe append it to a text box: _myTextBox.Text(fmt::format(L"{} - {}", _myTextBox.Text(), label)); } } ``` That would be easier than building every possible action and then checking if that action is bound to something.
claunia commented 2026-01-31 01:43:35 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 16, 2020):

Thanks!

@Chips1234 commented on GitHub (Jun 16, 2020): Thanks!
claunia commented 2026-01-31 01:43:36 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 22, 2020):

@zadjii-msft I figured out the Dialog Construct from run-time part but can you maybe go to my branch on my fork and demonstrate the KeyChordSerialization::ToString part? I learn much better if I get to see it in action. Thank you so much!

@Chips1234 commented on GitHub (Jun 22, 2020): @zadjii-msft I figured out the Dialog Construct from run-time part but can you maybe go to my [branch ](https://github.com/Chips1234/terminal/tree/dev/chips1234/dialog-to-show-all-shortcuts)on my fork and demonstrate the `KeyChordSerialization::ToString` part? I learn much better if I get to see it in action. Thank you so much!
claunia commented 2026-01-31 01:43:36 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Jun 22, 2020):

@Chips1234 Sure.

This code is a good sample of how to add runs of text to a dialog dynamically at runtime.

Then, I'd just do the code I mentioned above to retrieve all the KeyChord's and convert them into strings of text. You can see something similar over in this branch, though, you won't be setting KeyChordText, you'll probably just be setting run.Text(KeyChordSerialization::ToString(keyChord));

@zadjii-msft commented on GitHub (Jun 22, 2020): @Chips1234 Sure. [This code is a good sample](https://github.com/microsoft/terminal/blob/81eb13542abac72094ce0371a45f99768add9f61/src/cascadia/TerminalApp/AppLogic.cpp#L340-L382) of how to add runs of text to a dialog dynamically at runtime. Then, I'd just do the code I mentioned above to retrieve all the `KeyChord`'s and convert them into strings of text. You can see something similar over in [this branch](https://github.com/microsoft/terminal/blob/b90cc38f0ffb371f16a3bb5f306f01ddf72ddc5e/src/cascadia/TerminalApp/TerminalPage.cpp#L107-L110), though, you won't be setting `KeyChordText`, you'll probably just be setting `run.Text(KeyChordSerialization::ToString(keyChord));`
claunia commented 2026-01-31 01:43:36 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 22, 2020):

Thanks

@Chips1234 commented on GitHub (Jun 22, 2020): Thanks
claunia commented 2026-01-31 01:43:36 +00:00
Author
Owner
Copy Link

@Chips1234 commented on GitHub (Jun 24, 2020):

And I put the run.text where?

@Chips1234 commented on GitHub (Jun 24, 2020): And I put the `run.text` where?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-CodeHealth Issue-Question Needs-Triage Product-Terminal Resolution-Answered
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#9008
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?