d3b9a780d3
This introduces the ability to set the action for a key binding. A combo box is used to let the user select a new action. ## References #6900 - Actions page Epic #9427 - Actions page design doc #9949 - Actions page PR ## Detailed Description of the Pull Request / Additional comments ### Settings Model Changes - `ActionAndArgs` - new ctor that just takes a `ShortcutAction` - `ActionMap` - `AvailableActions` provides a map of all the "acceptable" actions to choose from. This is a merged list of (1) all `{ "command": X }` style actions and (2) any actions with args that are already defined in the ActionMap (or any parents). - `RegisterKeyBinding` introduces a new unnamed key binding to the action map. ### Editor Changes - XAML - Pretty straightforward, when in edit mode, we replace the text block with a combo box. This combo box just presents the actions you can choose from. - `RebindKeysEventArgs` --> `ModifyKeyBindingEventArgs` - `AvailableActionAndArgs` - stores the list of actions to choose from in the combo box - _Unfortunately_, `KeyBindingViewModel` needs this so that we can populate the combo box - `Actions` stores and maintains this though. We populate this from the settings model on navigation. - `ProposedAction` vs `CurrentAction` - similar to `ProposedKeys` and `Keys`, we need a way to distinguish the value from the settings model and the value of the control (i.e. combo box). - `CurrentAction` --> settings model - `ProposedAction` --> combo box selected item ## Validation Steps Performed - Cancel: - ✔️ change action --> cancel button --> begin editing action again --> original action is selected - Accept: - ✔️ don't change anything - ✔️ change action --> OK! --> Save! - NOTE: The original action is still left as a stub `{ "command": "closePane" }`. This is intentional because we want to prevent all modifications to the command palette. - ✔️ change action & change key chord --> OK! --> Save! - ✔️ change action & change key chord (conflicting key chord) --> OK! --> click ok on flyout --> Save! - NOTE: original action is left as a stub; original key chord explicitly unbound; new command/keys combo added.
136 lines
6.6 KiB
C++
136 lines
6.6 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#pragma once
|
|
|
|
#include "Actions.g.h"
|
|
#include "KeyBindingViewModel.g.h"
|
|
#include "ActionsPageNavigationState.g.h"
|
|
#include "ModifyKeyBindingEventArgs.g.h"
|
|
#include "Utils.h"
|
|
#include "ViewModelHelpers.h"
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
|
|
{
|
|
struct KeyBindingViewModelComparator
|
|
{
|
|
bool operator()(const Editor::KeyBindingViewModel& lhs, const Editor::KeyBindingViewModel& rhs) const
|
|
{
|
|
return lhs.Name() < rhs.Name();
|
|
}
|
|
};
|
|
|
|
struct ModifyKeyBindingEventArgs : ModifyKeyBindingEventArgsT<ModifyKeyBindingEventArgs>
|
|
{
|
|
public:
|
|
ModifyKeyBindingEventArgs(const Control::KeyChord& oldKeys, const Control::KeyChord& newKeys, const hstring oldActionName, const hstring newActionName) :
|
|
_OldKeys{ oldKeys },
|
|
_NewKeys{ newKeys },
|
|
_OldActionName{ std::move(oldActionName) },
|
|
_NewActionName{ std::move(newActionName) } {}
|
|
|
|
WINRT_PROPERTY(Control::KeyChord, OldKeys, nullptr);
|
|
WINRT_PROPERTY(Control::KeyChord, NewKeys, nullptr);
|
|
WINRT_PROPERTY(hstring, OldActionName);
|
|
WINRT_PROPERTY(hstring, NewActionName);
|
|
};
|
|
|
|
struct KeyBindingViewModel : KeyBindingViewModelT<KeyBindingViewModel>, ViewModelHelper<KeyBindingViewModel>
|
|
{
|
|
public:
|
|
KeyBindingViewModel(const Control::KeyChord& keys, const hstring& name, const Windows::Foundation::Collections::IObservableVector<hstring>& availableActions);
|
|
|
|
hstring Name() const { return _CurrentAction; }
|
|
hstring KeyChordText() const { return _KeyChordText; }
|
|
|
|
// UIA Text
|
|
hstring EditButtonName() const noexcept;
|
|
hstring CancelButtonName() const noexcept;
|
|
hstring AcceptButtonName() const noexcept;
|
|
hstring DeleteButtonName() const noexcept;
|
|
|
|
void EnterHoverMode() { IsHovered(true); };
|
|
void ExitHoverMode() { IsHovered(false); };
|
|
void ActionGotFocus() { IsContainerFocused(true); };
|
|
void ActionLostFocus() { IsContainerFocused(false); };
|
|
void EditButtonGettingFocus() { IsEditButtonFocused(true); };
|
|
void EditButtonLosingFocus() { IsEditButtonFocused(false); };
|
|
bool ShowEditButton() const noexcept;
|
|
void ToggleEditMode();
|
|
void DisableEditMode() { IsInEditMode(false); }
|
|
void AttemptAcceptChanges();
|
|
void AttemptAcceptChanges(hstring newKeyChordText);
|
|
void DeleteKeyBinding() { _DeleteKeyBindingRequestedHandlers(*this, _Keys); }
|
|
|
|
// ProposedAction: the entry selected by the combo box; may disagree with the settings model.
|
|
// CurrentAction: the combo box item that maps to the settings model value.
|
|
// AvailableActions: the list of options in the combo box; both actions above must be in this list.
|
|
// NOTE: ProposedAction and CurrentAction may disagree mainly due to the "edit mode" system in place.
|
|
// Current Action serves as...
|
|
// 1 - a record of what to set ProposedAction to on a cancellation
|
|
// 2 - a form of translation between ProposedAction and the settings model
|
|
// We would also need an ActionMap reference to remove this, but this is a better separation
|
|
// of responsibilities.
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(IInspectable, ProposedAction);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(hstring, CurrentAction);
|
|
WINRT_PROPERTY(Windows::Foundation::Collections::IObservableVector<hstring>, AvailableActions, nullptr);
|
|
|
|
// ProposedKeys: the text shown in the text box; may disagree with the settings model.
|
|
// Keys: the key chord bound in the settings model.
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(hstring, ProposedKeys);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(Control::KeyChord, Keys, nullptr);
|
|
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(bool, IsInEditMode, false);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(Windows::UI::Xaml::Controls::Flyout, AcceptChangesFlyout, nullptr);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(bool, IsAutomationPeerAttached, false);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(bool, IsHovered, false);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(bool, IsContainerFocused, false);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(bool, IsEditButtonFocused, false);
|
|
VIEW_MODEL_OBSERVABLE_PROPERTY(Windows::UI::Xaml::Media::Brush, ContainerBackground, nullptr);
|
|
TYPED_EVENT(ModifyKeyBindingRequested, Editor::KeyBindingViewModel, Editor::ModifyKeyBindingEventArgs);
|
|
TYPED_EVENT(DeleteKeyBindingRequested, Editor::KeyBindingViewModel, Terminal::Control::KeyChord);
|
|
|
|
private:
|
|
hstring _KeyChordText{};
|
|
};
|
|
|
|
struct ActionsPageNavigationState : ActionsPageNavigationStateT<ActionsPageNavigationState>
|
|
{
|
|
public:
|
|
ActionsPageNavigationState(const Model::CascadiaSettings& settings) :
|
|
_Settings{ settings } {}
|
|
|
|
WINRT_PROPERTY(Model::CascadiaSettings, Settings, nullptr)
|
|
};
|
|
|
|
struct Actions : ActionsT<Actions>
|
|
{
|
|
public:
|
|
Actions();
|
|
|
|
void OnNavigatedTo(const winrt::Windows::UI::Xaml::Navigation::NavigationEventArgs& e);
|
|
Windows::UI::Xaml::Automation::Peers::AutomationPeer OnCreateAutomationPeer();
|
|
void KeyChordEditor_KeyDown(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e);
|
|
|
|
WINRT_CALLBACK(PropertyChanged, Windows::UI::Xaml::Data::PropertyChangedEventHandler);
|
|
WINRT_PROPERTY(Editor::ActionsPageNavigationState, State, nullptr);
|
|
WINRT_PROPERTY(Windows::Foundation::Collections::IObservableVector<Editor::KeyBindingViewModel>, KeyBindingList);
|
|
|
|
private:
|
|
void _ViewModelPropertyChangedHandler(const Windows::Foundation::IInspectable& senderVM, const Windows::UI::Xaml::Data::PropertyChangedEventArgs& args);
|
|
void _ViewModelDeleteKeyBindingHandler(const Editor::KeyBindingViewModel& senderVM, const Control::KeyChord& args);
|
|
void _ViewModelModifyKeyBindingHandler(const Editor::KeyBindingViewModel& senderVM, const Editor::ModifyKeyBindingEventArgs& args);
|
|
|
|
std::optional<uint32_t> _GetContainerIndexByKeyChord(const Control::KeyChord& keys);
|
|
|
|
bool _AutomationPeerAttached{ false };
|
|
Windows::Foundation::Collections::IObservableVector<hstring> _AvailableActionAndArgs;
|
|
Windows::Foundation::Collections::IMap<hstring, Model::ActionAndArgs> _AvailableActionMap;
|
|
};
|
|
}
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Editor::factory_implementation
|
|
{
|
|
BASIC_FACTORY(Actions);
|
|
}
|