-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce the Terminal Settings Editor (#8048)
This commit introduces the terminal settings editor (to wit: the Settings UI) as a standalone project. This project, and this commit, is the result of two and a half months of work. TSE started as a hackathon project in the Microsoft 2020 Hackathon, and from there it's grown to be a bona-fide graphical settings editor. There is a lot of xaml data binding in here, a number of views and a number of view models, and a bunch of paradigms that we've been reviewing and testing out and designing and refining. Specified in #6720, #8269 Follow-up work in #6800 Closes #1564 Closes #8048 (PR) Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com> Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com> Co-authored-by: Alberto Medina Gutierrez <almedina@microsoft.com> Co-authored-by: John Grandle <jograndl@microsoft.com> Co-authored-by: xerootg <xerootg@users.noreply.github.com> Co-authored-by: Scott <sarmiger1@gmail.com> Co-authored-by: Vineeth Thomas Alex <vineeththomasalex@gmail.com> Co-authored-by: Leon Liang <lelian@microsoft.com> Co-authored-by: Dustin L. Howett <duhowett@microsoft.com> Signed-off-by: Dustin L. Howett <duhowett@microsoft.com>
- Loading branch information
9 people
committed
Dec 11, 2020
1 parent
b80a4e4
commit 05f3ccb
Showing
57 changed files
with
4,280 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ LKG | |
| mfcribbon | ||
| microsoft | ||
| microsoftonline | ||
| muxc | ||
| netcore | ||
| osgvsowi | ||
| pgc | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| #include "pch.h" | ||
| #include "ColorSchemes.h" | ||
| #include "ColorTableEntry.g.cpp" | ||
| #include "ColorSchemes.g.cpp" | ||
| #include "ColorSchemesPageNavigationState.g.cpp" | ||
|
|
||
| #include <LibraryResources.h> | ||
|
|
||
| using namespace winrt; | ||
| using namespace winrt::Windows::UI; | ||
| using namespace winrt::Windows::UI::Xaml::Navigation; | ||
| using namespace winrt::Windows::UI::Xaml::Controls; | ||
| using namespace winrt::Windows::UI::Xaml::Media; | ||
| using namespace winrt::Windows::Foundation; | ||
| using namespace winrt::Windows::Foundation::Collections; | ||
|
|
||
| namespace winrt::Microsoft::Terminal::Settings::Editor::implementation | ||
| { | ||
| static const std::array<hstring, 16> TableColorNames = { | ||
| RS_(L"ColorScheme_Black/Header"), | ||
| RS_(L"ColorScheme_Red/Header"), | ||
| RS_(L"ColorScheme_Green/Header"), | ||
| RS_(L"ColorScheme_Yellow/Header"), | ||
| RS_(L"ColorScheme_Blue/Header"), | ||
| RS_(L"ColorScheme_Purple/Header"), | ||
| RS_(L"ColorScheme_Cyan/Header"), | ||
| RS_(L"ColorScheme_White/Header"), | ||
| RS_(L"ColorScheme_BrightBlack/Header"), | ||
| RS_(L"ColorScheme_BrightRed/Header"), | ||
| RS_(L"ColorScheme_BrightGreen/Header"), | ||
| RS_(L"ColorScheme_BrightYellow/Header"), | ||
| RS_(L"ColorScheme_BrightBlue/Header"), | ||
| RS_(L"ColorScheme_BrightPurple/Header"), | ||
| RS_(L"ColorScheme_BrightCyan/Header"), | ||
| RS_(L"ColorScheme_BrightWhite/Header") | ||
| }; | ||
|
|
||
| ColorSchemes::ColorSchemes() : | ||
| _ColorSchemeList{ single_threaded_observable_vector<hstring>() }, | ||
| _CurrentColorTable{ single_threaded_observable_vector<Editor::ColorTableEntry>() } | ||
| { | ||
| InitializeComponent(); | ||
| } | ||
|
|
||
| void ColorSchemes::OnNavigatedTo(const NavigationEventArgs& e) | ||
| { | ||
| _State = e.Parameter().as<Editor::ColorSchemesPageNavigationState>(); | ||
| _UpdateColorSchemeList(); | ||
|
|
||
| // Initialize our color table view model with 16 dummy colors | ||
| // so that on a ColorScheme selection change, we can loop through | ||
| // each ColorTableEntry and just change its color. Performing a | ||
| // clear and 16 appends doesn't seem to update the color pickers | ||
| // very accurately. | ||
| for (uint8_t i = 0; i < TableColorNames.size(); ++i) | ||
| { | ||
| auto entry = winrt::make<ColorTableEntry>(i, Windows::UI::Color{ 0, 0, 0, 0 }); | ||
| _CurrentColorTable.Append(entry); | ||
| } | ||
| } | ||
|
|
||
| // Function Description: | ||
| // - Called when a different color scheme is selected. Updates our current | ||
| // color scheme and updates our currently modifiable color table. | ||
| // Arguments: | ||
| // - args: The selection changed args that tells us what's the new color scheme selected. | ||
| // Return Value: | ||
| // - <none> | ||
| void ColorSchemes::ColorSchemeSelectionChanged(IInspectable const& /*sender*/, | ||
| SelectionChangedEventArgs const& args) | ||
| { | ||
| // Update the color scheme this page is modifying | ||
| auto str = winrt::unbox_value<hstring>(args.AddedItems().GetAt(0)); | ||
| auto colorScheme = _State.Globals().ColorSchemes().Lookup(str); | ||
| CurrentColorScheme(colorScheme); | ||
| _UpdateColorTable(colorScheme); | ||
| } | ||
|
|
||
| // Function Description: | ||
| // - Updates the list of all color schemes available to choose from. | ||
| // Arguments: | ||
| // - <none> | ||
| // Return Value: | ||
| // - <none> | ||
| void ColorSchemes::_UpdateColorSchemeList() | ||
| { | ||
| // Surprisingly, though this is called every time we navigate to the page, | ||
| // the list does not keep growing on each navigation. | ||
| const auto& colorSchemeMap{ _State.Globals().ColorSchemes() }; | ||
| for (const auto& pair : colorSchemeMap) | ||
| { | ||
| _ColorSchemeList.Append(pair.Key()); | ||
| } | ||
| } | ||
|
|
||
| // Function Description: | ||
| // - Called when a ColorPicker control has selected a new color. This is specifically | ||
| // called by color pickers assigned to a color table entry. It takes the index | ||
| // that's been stuffed in the Tag property of the color picker and uses it | ||
| // to update the color table accordingly. | ||
| // Arguments: | ||
| // - sender: the color picker that raised this event. | ||
| // - args: the args that contains the new color that was picked. | ||
| // Return Value: | ||
| // - <none> | ||
| void ColorSchemes::ColorPickerChanged(IInspectable const& sender, | ||
| ColorChangedEventArgs const& args) | ||
| { | ||
| if (auto picker = sender.try_as<ColorPicker>()) | ||
| { | ||
| if (auto tag = picker.Tag()) | ||
| { | ||
| auto index = winrt::unbox_value<uint8_t>(tag); | ||
| CurrentColorScheme().SetColorTableEntry(index, args.NewColor()); | ||
| _CurrentColorTable.GetAt(index).Color(args.NewColor()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Function Description: | ||
| // - Updates the currently modifiable color table based on the given current color scheme. | ||
| // Arguments: | ||
| // - colorScheme: the color scheme to retrieve the color table from | ||
| // Return Value: | ||
| // - <none> | ||
| void ColorSchemes::_UpdateColorTable(const Model::ColorScheme& colorScheme) | ||
| { | ||
| for (uint8_t i = 0; i < TableColorNames.size(); ++i) | ||
| { | ||
| _CurrentColorTable.GetAt(i).Color(colorScheme.Table()[i]); | ||
| } | ||
| } | ||
|
|
||
| ColorTableEntry::ColorTableEntry(uint8_t index, Windows::UI::Color color) | ||
| { | ||
| Name(TableColorNames[index]); | ||
| Index(winrt::box_value<uint8_t>(index)); | ||
| Color(color); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "ColorTableEntry.g.h" | ||
| #include "ColorSchemes.g.h" | ||
| #include "ColorSchemesPageNavigationState.g.h" | ||
| #include "Utils.h" | ||
|
|
||
| namespace winrt::Microsoft::Terminal::Settings::Editor::implementation | ||
| { | ||
| struct ColorSchemesPageNavigationState : ColorSchemesPageNavigationStateT<ColorSchemesPageNavigationState> | ||
| { | ||
| public: | ||
| ColorSchemesPageNavigationState(const Model::GlobalAppSettings& settings) : | ||
| _Globals{ settings } {} | ||
|
|
||
| GETSET_PROPERTY(Model::GlobalAppSettings, Globals, nullptr); | ||
| }; | ||
|
|
||
| struct ColorSchemes : ColorSchemesT<ColorSchemes> | ||
| { | ||
| ColorSchemes(); | ||
|
|
||
| void OnNavigatedTo(const winrt::Windows::UI::Xaml::Navigation::NavigationEventArgs& e); | ||
|
|
||
| void ColorSchemeSelectionChanged(winrt::Windows::Foundation::IInspectable const& sender, winrt::Windows::UI::Xaml::Controls::SelectionChangedEventArgs const& args); | ||
| void ColorPickerChanged(winrt::Windows::Foundation::IInspectable const& sender, winrt::Windows::UI::Xaml::Controls::ColorChangedEventArgs const& args); | ||
|
|
||
| GETSET_PROPERTY(Editor::ColorSchemesPageNavigationState, State, nullptr); | ||
| GETSET_PROPERTY(Windows::Foundation::Collections::IObservableVector<winrt::Microsoft::Terminal::Settings::Editor::ColorTableEntry>, CurrentColorTable, nullptr); | ||
| GETSET_PROPERTY(Windows::Foundation::Collections::IObservableVector<winrt::hstring>, ColorSchemeList, nullptr); | ||
|
|
||
| WINRT_CALLBACK(PropertyChanged, Windows::UI::Xaml::Data::PropertyChangedEventHandler); | ||
| OBSERVABLE_GETSET_PROPERTY(winrt::Microsoft::Terminal::Settings::Model::ColorScheme, CurrentColorScheme, _PropertyChangedHandlers, nullptr); | ||
|
|
||
| private: | ||
| void _UpdateColorTable(const winrt::Microsoft::Terminal::Settings::Model::ColorScheme& colorScheme); | ||
| void _UpdateColorSchemeList(); | ||
| }; | ||
|
|
||
| struct ColorTableEntry : ColorTableEntryT<ColorTableEntry> | ||
| { | ||
| public: | ||
| ColorTableEntry(uint8_t index, Windows::UI::Color color); | ||
|
|
||
| WINRT_CALLBACK(PropertyChanged, Windows::UI::Xaml::Data::PropertyChangedEventHandler); | ||
| OBSERVABLE_GETSET_PROPERTY(winrt::hstring, Name, _PropertyChangedHandlers); | ||
| OBSERVABLE_GETSET_PROPERTY(IInspectable, Index, _PropertyChangedHandlers); | ||
| OBSERVABLE_GETSET_PROPERTY(Windows::UI::Color, Color, _PropertyChangedHandlers); | ||
| }; | ||
| } | ||
|
|
||
| namespace winrt::Microsoft::Terminal::Settings::Editor::factory_implementation | ||
| { | ||
| BASIC_FACTORY(ColorSchemes); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| namespace Microsoft.Terminal.Settings.Editor | ||
| { | ||
| runtimeclass ColorSchemesPageNavigationState | ||
| { | ||
| Microsoft.Terminal.Settings.Model.GlobalAppSettings Globals; | ||
| }; | ||
|
|
||
| [default_interface] runtimeclass ColorSchemes : Windows.UI.Xaml.Controls.Page, Windows.UI.Xaml.Data.INotifyPropertyChanged | ||
| { | ||
| ColorSchemes(); | ||
| ColorSchemesPageNavigationState State { get; }; | ||
|
|
||
| Microsoft.Terminal.Settings.Model.ColorScheme CurrentColorScheme { get; }; | ||
| Windows.Foundation.Collections.IObservableVector<ColorTableEntry> CurrentColorTable; | ||
| Windows.Foundation.Collections.IObservableVector<String> ColorSchemeList { get; }; | ||
| } | ||
|
|
||
| [default_interface] runtimeclass ColorTableEntry : Windows.UI.Xaml.Data.INotifyPropertyChanged | ||
| { | ||
| String Name { get; }; | ||
| IInspectable Index; | ||
| Windows.UI.Color Color; | ||
| } | ||
| } |
Oops, something went wrong.