c9dc4198ac
Applies feedback from https://github.com/microsoft/terminal/pull/9949#pullrequestreview-662590658 Highlights include: - bugfix: make all edit buttons stay visible if the user is using assistive technology - rename a few functions and resources to match the correct naming scheme - update the localized text for a conflicting key chord being assigned - provide better comments throughout the actions page code ## References #9949 - Original PR Closes #10168
319 lines
14 KiB
C++
319 lines
14 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.h"
|
|
#include "Actions.h"
|
|
#include "Actions.g.cpp"
|
|
#include "KeyBindingViewModel.g.cpp"
|
|
#include "ActionsPageNavigationState.g.cpp"
|
|
#include "LibraryResources.h"
|
|
|
|
using namespace winrt::Windows::Foundation;
|
|
using namespace winrt::Windows::Foundation::Collections;
|
|
using namespace winrt::Windows::System;
|
|
using namespace winrt::Windows::UI::Core;
|
|
using namespace winrt::Windows::UI::Xaml;
|
|
using namespace winrt::Windows::UI::Xaml::Controls;
|
|
using namespace winrt::Windows::UI::Xaml::Data;
|
|
using namespace winrt::Windows::UI::Xaml::Navigation;
|
|
using namespace winrt::Microsoft::Terminal::Settings::Model;
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
|
|
{
|
|
KeyBindingViewModel::KeyBindingViewModel(const Control::KeyChord& keys, const Model::Command& cmd) :
|
|
_Keys{ keys },
|
|
_KeyChordText{ Model::KeyChordSerialization::ToString(keys) },
|
|
_Command{ cmd }
|
|
{
|
|
// Add a property changed handler to our own property changed event.
|
|
// This propagates changes from the settings model to anybody listening to our
|
|
// unique view model members.
|
|
PropertyChanged([this](auto&&, const PropertyChangedEventArgs& args) {
|
|
const auto viewModelProperty{ args.PropertyName() };
|
|
if (viewModelProperty == L"Keys")
|
|
{
|
|
_KeyChordText = Model::KeyChordSerialization::ToString(_Keys);
|
|
_NotifyChanges(L"KeyChordText");
|
|
}
|
|
else if (viewModelProperty == L"IsContainerFocused" ||
|
|
viewModelProperty == L"IsEditButtonFocused" ||
|
|
viewModelProperty == L"IsHovered" ||
|
|
viewModelProperty == L"IsAutomationPeerAttached" ||
|
|
viewModelProperty == L"IsInEditMode")
|
|
{
|
|
_NotifyChanges(L"ShowEditButton");
|
|
}
|
|
});
|
|
}
|
|
|
|
hstring KeyBindingViewModel::EditButtonName() const noexcept { return RS_(L"Actions_EditButton/[using:Windows.UI.Xaml.Controls]ToolTipService/ToolTip"); }
|
|
hstring KeyBindingViewModel::CancelButtonName() const noexcept { return RS_(L"Actions_CancelButton/[using:Windows.UI.Xaml.Controls]ToolTipService/ToolTip"); }
|
|
hstring KeyBindingViewModel::AcceptButtonName() const noexcept { return RS_(L"Actions_AcceptButton/[using:Windows.UI.Xaml.Controls]ToolTipService/ToolTip"); }
|
|
hstring KeyBindingViewModel::DeleteButtonName() const noexcept { return RS_(L"Actions_DeleteButton/[using:Windows.UI.Xaml.Controls]ToolTipService/ToolTip"); }
|
|
|
|
bool KeyBindingViewModel::ShowEditButton() const noexcept
|
|
{
|
|
return (IsContainerFocused() || IsEditButtonFocused() || IsHovered() || IsAutomationPeerAttached()) && !IsInEditMode();
|
|
}
|
|
|
|
void KeyBindingViewModel::ToggleEditMode()
|
|
{
|
|
// toggle edit mode
|
|
IsInEditMode(!_IsInEditMode);
|
|
if (_IsInEditMode)
|
|
{
|
|
// if we're in edit mode,
|
|
// pre-populate the text box with the current keys
|
|
ProposedKeys(KeyChordText());
|
|
}
|
|
}
|
|
|
|
void KeyBindingViewModel::AttemptAcceptChanges()
|
|
{
|
|
AttemptAcceptChanges(_ProposedKeys);
|
|
}
|
|
|
|
void KeyBindingViewModel::AttemptAcceptChanges(hstring newKeyChordText)
|
|
{
|
|
auto args{ make_self<RebindKeysEventArgs>(_Keys, _Keys) };
|
|
try
|
|
{
|
|
// Attempt to convert the provided key chord text
|
|
const auto newKeyChord{ KeyChordSerialization::FromString(newKeyChordText) };
|
|
args->NewKeys(newKeyChord);
|
|
_RebindKeysRequestedHandlers(*this, *args);
|
|
}
|
|
catch (hresult_invalid_argument)
|
|
{
|
|
// Converting the text into a key chord failed
|
|
// TODO GH #6900:
|
|
// This is tricky. I still haven't found a way to reference the
|
|
// key chord text box. It's hidden behind the data template.
|
|
// Ideally, some kind of notification would alert the user, but
|
|
// to make it look nice, we need it to somehow target the text box.
|
|
// Alternatively, we want a full key chord editor/listener.
|
|
// If we implement that, we won't need this validation or error message.
|
|
}
|
|
}
|
|
|
|
Actions::Actions()
|
|
{
|
|
InitializeComponent();
|
|
}
|
|
|
|
Automation::Peers::AutomationPeer Actions::OnCreateAutomationPeer()
|
|
{
|
|
_AutomationPeerAttached = true;
|
|
for (const auto& kbdVM : _KeyBindingList)
|
|
{
|
|
// To create a more accessible experience, we want the "edit" buttons to _always_
|
|
// appear when a screen reader is attached. This ensures that the edit buttons are
|
|
// accessible via the UIA tree.
|
|
get_self<KeyBindingViewModel>(kbdVM)->IsAutomationPeerAttached(_AutomationPeerAttached);
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
void Actions::OnNavigatedTo(const NavigationEventArgs& e)
|
|
{
|
|
_State = e.Parameter().as<Editor::ActionsPageNavigationState>();
|
|
|
|
// Convert the key bindings from our settings into a view model representation
|
|
const auto& keyBindingMap{ _State.Settings().ActionMap().KeyBindings() };
|
|
std::vector<Editor::KeyBindingViewModel> keyBindingList;
|
|
keyBindingList.reserve(keyBindingMap.Size());
|
|
for (const auto& [keys, cmd] : keyBindingMap)
|
|
{
|
|
auto container{ make_self<KeyBindingViewModel>(keys, cmd) };
|
|
container->PropertyChanged({ this, &Actions::_ViewModelPropertyChangedHandler });
|
|
container->DeleteKeyBindingRequested({ this, &Actions::_ViewModelDeleteKeyBindingHandler });
|
|
container->RebindKeysRequested({ this, &Actions::_ViewModelRebindKeysHandler });
|
|
container->IsAutomationPeerAttached(_AutomationPeerAttached);
|
|
keyBindingList.push_back(*container);
|
|
}
|
|
|
|
std::sort(begin(keyBindingList), end(keyBindingList), KeyBindingViewModelComparator{});
|
|
_KeyBindingList = single_threaded_observable_vector(std::move(keyBindingList));
|
|
}
|
|
|
|
void Actions::KeyChordEditor_KeyDown(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e)
|
|
{
|
|
const auto& senderTB{ sender.as<TextBox>() };
|
|
const auto& kbdVM{ senderTB.DataContext().as<Editor::KeyBindingViewModel>() };
|
|
if (e.OriginalKey() == VirtualKey::Enter)
|
|
{
|
|
// Fun fact: this is happening _before_ "_ProposedKeys" gets updated
|
|
// with the two-way data binding. So we need to directly extract the text
|
|
// and tell the view model to update itself.
|
|
get_self<KeyBindingViewModel>(kbdVM)->AttemptAcceptChanges(senderTB.Text());
|
|
|
|
// For an unknown reason, when 'AcceptChangesFlyout' is set in the code above,
|
|
// the flyout isn't shown, forcing the 'Enter' key to do nothing.
|
|
// To get around this, detect if the flyout was set, and display it
|
|
// on the text box.
|
|
if (kbdVM.AcceptChangesFlyout() != nullptr)
|
|
{
|
|
kbdVM.AcceptChangesFlyout().ShowAt(senderTB);
|
|
}
|
|
e.Handled(true);
|
|
}
|
|
else if (e.OriginalKey() == VirtualKey::Escape)
|
|
{
|
|
kbdVM.ToggleEditMode();
|
|
e.Handled(true);
|
|
}
|
|
}
|
|
|
|
void Actions::_ViewModelPropertyChangedHandler(const IInspectable& sender, const Windows::UI::Xaml::Data::PropertyChangedEventArgs& args)
|
|
{
|
|
const auto senderVM{ sender.as<Editor::KeyBindingViewModel>() };
|
|
const auto propertyName{ args.PropertyName() };
|
|
if (propertyName == L"IsInEditMode")
|
|
{
|
|
if (senderVM.IsInEditMode())
|
|
{
|
|
// Ensure that...
|
|
// 1. we move focus to the edit mode controls
|
|
// 2. this is the only entry that is in edit mode
|
|
for (uint32_t i = 0; i < _KeyBindingList.Size(); ++i)
|
|
{
|
|
const auto& kbdVM{ _KeyBindingList.GetAt(i) };
|
|
if (senderVM == kbdVM)
|
|
{
|
|
// This is the view model entry that went into edit mode.
|
|
// Move focus to the edit mode controls by
|
|
// extracting the list view item container.
|
|
const auto& container{ KeyBindingsListView().ContainerFromIndex(i).try_as<ListViewItem>() };
|
|
container.Focus(FocusState::Programmatic);
|
|
}
|
|
else
|
|
{
|
|
// Exit edit mode for all other containers
|
|
get_self<KeyBindingViewModel>(kbdVM)->DisableEditMode();
|
|
}
|
|
}
|
|
|
|
const auto& containerBackground{ Resources().Lookup(box_value(L"ActionContainerBackgroundEditing")).as<Windows::UI::Xaml::Media::Brush>() };
|
|
get_self<KeyBindingViewModel>(senderVM)->ContainerBackground(containerBackground);
|
|
}
|
|
else
|
|
{
|
|
// Focus on the list view item
|
|
KeyBindingsListView().ContainerFromItem(senderVM).as<Controls::Control>().Focus(FocusState::Programmatic);
|
|
|
|
const auto& containerBackground{ Resources().Lookup(box_value(L"ActionContainerBackground")).as<Windows::UI::Xaml::Media::Brush>() };
|
|
get_self<KeyBindingViewModel>(senderVM)->ContainerBackground(containerBackground);
|
|
}
|
|
}
|
|
}
|
|
|
|
void Actions::_ViewModelDeleteKeyBindingHandler(const Editor::KeyBindingViewModel& senderVM, const Control::KeyChord& keys)
|
|
{
|
|
// Update the settings model
|
|
_State.Settings().ActionMap().DeleteKeyBinding(keys);
|
|
|
|
// Find the current container in our list and remove it.
|
|
// This is much faster than rebuilding the entire ActionMap.
|
|
uint32_t index;
|
|
if (_KeyBindingList.IndexOf(senderVM, index))
|
|
{
|
|
_KeyBindingList.RemoveAt(index);
|
|
|
|
// Focus the new item at this index
|
|
if (_KeyBindingList.Size() != 0)
|
|
{
|
|
const auto newFocusedIndex{ std::clamp(index, 0u, _KeyBindingList.Size() - 1) };
|
|
KeyBindingsListView().ContainerFromIndex(newFocusedIndex).as<Controls::Control>().Focus(FocusState::Programmatic);
|
|
}
|
|
}
|
|
}
|
|
|
|
void Actions::_ViewModelRebindKeysHandler(const Editor::KeyBindingViewModel& senderVM, const Editor::RebindKeysEventArgs& args)
|
|
{
|
|
if (args.OldKeys().Modifiers() != args.NewKeys().Modifiers() || args.OldKeys().Vkey() != args.NewKeys().Vkey())
|
|
{
|
|
// We're actually changing the key chord
|
|
const auto senderVMImpl{ get_self<KeyBindingViewModel>(senderVM) };
|
|
const auto& conflictingCmd{ _State.Settings().ActionMap().GetActionByKeyChord(args.NewKeys()) };
|
|
if (conflictingCmd)
|
|
{
|
|
// We're about to overwrite another key chord.
|
|
// Display a confirmation dialog.
|
|
TextBlock errorMessageTB{};
|
|
errorMessageTB.Text(RS_(L"Actions_RenameConflictConfirmationMessage"));
|
|
|
|
const auto conflictingCmdName{ conflictingCmd.Name() };
|
|
TextBlock conflictingCommandNameTB{};
|
|
conflictingCommandNameTB.Text(fmt::format(L"\"{}\"", conflictingCmdName.empty() ? RS_(L"Actions_UnnamedCommandName") : conflictingCmdName));
|
|
conflictingCommandNameTB.FontStyle(Windows::UI::Text::FontStyle::Italic);
|
|
|
|
TextBlock confirmationQuestionTB{};
|
|
confirmationQuestionTB.Text(RS_(L"Actions_RenameConflictConfirmationQuestion"));
|
|
|
|
Button acceptBTN{};
|
|
acceptBTN.Content(box_value(RS_(L"Actions_RenameConflictConfirmationAcceptButton")));
|
|
acceptBTN.Click([=](auto&, auto&) {
|
|
// remove conflicting key binding from list view
|
|
const auto containerIndex{ _GetContainerIndexByKeyChord(args.NewKeys()) };
|
|
_KeyBindingList.RemoveAt(*containerIndex);
|
|
|
|
// remove flyout
|
|
senderVM.AcceptChangesFlyout().Hide();
|
|
senderVM.AcceptChangesFlyout(nullptr);
|
|
|
|
// update settings model and view model
|
|
_State.Settings().ActionMap().RebindKeys(args.OldKeys(), args.NewKeys());
|
|
senderVMImpl->Keys(args.NewKeys());
|
|
senderVM.ToggleEditMode();
|
|
});
|
|
|
|
StackPanel flyoutStack{};
|
|
flyoutStack.Children().Append(errorMessageTB);
|
|
flyoutStack.Children().Append(conflictingCommandNameTB);
|
|
flyoutStack.Children().Append(confirmationQuestionTB);
|
|
flyoutStack.Children().Append(acceptBTN);
|
|
|
|
Flyout acceptChangesFlyout{};
|
|
acceptChangesFlyout.Content(flyoutStack);
|
|
senderVM.AcceptChangesFlyout(acceptChangesFlyout);
|
|
return;
|
|
}
|
|
else
|
|
{
|
|
// update settings model
|
|
_State.Settings().ActionMap().RebindKeys(args.OldKeys(), args.NewKeys());
|
|
|
|
// update view model (keys)
|
|
senderVMImpl->Keys(args.NewKeys());
|
|
}
|
|
}
|
|
|
|
// update view model (exit edit mode)
|
|
senderVM.ToggleEditMode();
|
|
}
|
|
|
|
// Method Description:
|
|
// - performs a search on KeyBindingList by key chord.
|
|
// Arguments:
|
|
// - keys - the associated key chord of the command we're looking for
|
|
// Return Value:
|
|
// - the index of the view model referencing the command. If the command doesn't exist, nullopt
|
|
std::optional<uint32_t> Actions::_GetContainerIndexByKeyChord(const Control::KeyChord& keys)
|
|
{
|
|
for (uint32_t i = 0; i < _KeyBindingList.Size(); ++i)
|
|
{
|
|
const auto kbdVM{ get_self<KeyBindingViewModel>(_KeyBindingList.GetAt(i)) };
|
|
const auto& otherKeys{ kbdVM->Keys() };
|
|
if (keys.Modifiers() == otherKeys.Modifiers() && keys.Vkey() == otherKeys.Vkey())
|
|
{
|
|
return i;
|
|
}
|
|
}
|
|
|
|
// TODO GH #6900:
|
|
// an expedited search can be done if we use cmd.Name()
|
|
// to quickly search through the sorted list.
|
|
return std::nullopt;
|
|
}
|
|
}
|