Add functionality to open the Settings UI tab through openSettings #7802

leonMSFT · 2020-10-01T19:16:54Z

This PR's goal was to add an option to the OpenSettings keybinding to open the Settings UI in a tab. In order to implement that, a couple of changes had to be made to Tab, specifically:

Introduce a tab interface named ITab
Create/Rename two new Tab classes that implement ITab called SettingsTab and TerminalTab

I've also put some TODOs that I wanted to get some thoughts on - I'll make a follow up PR but perhaps they can be revisited when we flesh out the Settings UI more.

Does a Settings UI tab shutdown need to do anything special for cleanup?
Does a Settings UI tab need to have GetActiveTitle? Maybe depending on which page in the UI is open?
Technically, I can't focus a Grid control, so I'll need to figure out what to Focus when the tab is selected.
The Settings UI tab doesn't have a TermControl, so once focus is moved to that tab, users won't be able to nextTab/prevTab out of it (along with all other keybindings).

References #1564, #5915

…tests

DHowett

note to self: review SettingsTab, TerminalPage::_OpenSettingsUI

src/cascadia/TerminalSettingsEditor/MainPage.idl

src/cascadia/TerminalApp/ITab.idl

src/cascadia/TerminalApp/Utils.h

carlos-zamora

This looks great! I want to download this branch and play around with it for a bit. I also have a few questions:

Is the "Settings" button in the dropdown hookup up? If not, that should be an easy one we can cross of our list.

@zadjii-msft (for when you come back) I'd feel more comfortable if you took a closer look at this PR since you seem pretty familiar with this layer.

NOTE: this targets the feature branch so we're on a "1 approval policy". But we'll do one big review as a team when the Settings UI is ready and the feature branch gets merged into master.

src/cascadia/TerminalApp/Utils.h

src/cascadia/TerminalApp/AppLogic.h

src/cascadia/TerminalApp/TerminalAppLib.vcxproj

src/cascadia/TerminalApp/TerminalPage.cpp

src/cascadia/TerminalApp/SettingsTab.h

src/cascadia/TerminalApp/SettingsTab.cpp

carlos-zamora · 2020-10-02T04:44:41Z

src/cascadia/TerminalApp/SettingsTab.cpp

+        // TODO: Does/Will the settings UI need some shutdown procedures?
+        Content(nullptr);
+        _ClosedHandlers(nullptr, nullptr);


My train of thought 🚂🧠
When the Settings UI is opened, we to create a clone of CascadiaSettings. As the user makes changes, we directly modify that clone. When the user saves the changes, that clone gets promoted to be the real CascadiaSettings. When we close the Settings UI, the Settings UI will own that clone. So the clone dies. All of the Settings UI is also destroyed, so I think that'll be fine.
I think we'll be fine. Would definitely like a second opinion from @DHowett if possible.

carlos-zamora · 2020-10-02T04:49:09Z

src/cascadia/TerminalApp/SettingsTab.cpp

+    // - <none>
+    // Return Value:
+    // - <none>
+    void SettingsTab::_CreateContextMenu()


Hmm... Maybe this context menu should be abstracted differently. I'm looking at #7728 and we would have to duplicate that code here and in TerminalTab. Here's a few ideas:

Could we make ITab an abstract class instead of an interface? That way the context menu gets inherited by both (and all future tabs)

Should we move the responsibility of populating the context menu over to TerminalPage? That way it checks the type of tab we have, and populates it accordingly?

I def agree with wanting to clean up the context menu creation in light of incoming additions in that PR and in the future. Here's another idea - I kinda want to make our own custom control named something like "TabContextFlyout".

Flyout menu items become xaml code - we won't need to have cpp code that creates our menu items.

Each tab type owns one of these controls.

Each tab can hook itself up to the Click events of each of the control's menu items that they wish to use. Then we can turn each menu item's visibility off if the click handler isn't registered.

You got me at "become xaml code" haha.

Alright this might take a little longer than I thought. I'm gonna file a follow up issue for this so that I can get this PR in, work on the issue on the side and unblock myself for some data binding work.

issue filed here: #7841

src/cascadia/TerminalApp/SettingsTab.cpp

carlos-zamora · 2020-10-06T16:37:25Z

/azp run

azure-pipelines · 2020-10-06T16:37:31Z

No pipelines are associated with this pull request.

carlos-zamora

Approving w/ suggestions

src/cascadia/TerminalApp/TerminalPage.cpp

src/cascadia/TerminalApp/Utils.h

ghost · 2020-10-06T22:22:10Z

Hello @leonMSFT!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

german-one · 2020-10-07T11:37:45Z

Ignore me if this was on purpose … The PR has not been merged into master.

zadjii-msft · 2020-10-07T11:38:04Z

Hey uh, was this supposed to get merged? since it wasn't going into master, the bot wasn't going to enforce the two signoff requirement...

EDIT: @german-one ninja'd me

leonMSFT · 2020-10-07T16:11:22Z

Oh yeah this was 100% intended to go into the feature branch for the SUI, not master. I got so scared waking up to these two comments, I thought it accidentally went into master instead 😆

german-one · 2020-10-07T16:26:18Z

To ruin your morning was 100% unintended 😦

carlos-zamora · 2020-10-07T16:35:49Z

We're just doing one sign-off needed for feature/settings-ui. We'll do a full review when that merges into master in preparation for release. So occasionally we'll tag team members for a closer look or some immediate feedback. We were all surprised that AutoMerge worked hahaha.

zadjii-msft · 2020-10-07T16:42:25Z

Ah okay. I was planning on giving feedback on this part, but nbd. It would have probably boiled down to "I have concerns, but we need to ship the SUI so ". The concerns aren't that important now TBH

DHowett · 2020-10-07T16:44:40Z

@zadjii-msft they’re still worth tracking, so do write them up! Since this will merge to main eventually

@leonMSFT

In preparation for the Settings UI, we needed to make some changes to Tab to abstract out shared, common functionality between different types of tab. This is the result of that work. All code references to the settings have been removed or reverted. Contains changes from #8053, #7802. The messages below only make sense in the context of the Settings UI, which this pull request does not bring in. They do, however, provide valuable information. From #7802 (@leonMSFT): > This PR's goal was to add an option to the `OpenSettings` keybinding to > open the Settings UI in a tab. In order to implement that, a couple of > changes had to be made to `Tab`, specifically: > > - Introduce a tab interface named `ITab` > - Create/Rename two new Tab classes that implement `ITab` called > `SettingsTab` and `TerminalTab` > From #8053: > `TerminalTab` and `SettingsTab` share some implementation details. The > close submenu introduced in #7728 is a good example of functionality > that is consistent across all tabs. This PR transforms `ITab` from an > interface, into an [unsealed runtime class] to de-duplicate some > functionality. Most of the logic from `SettingsTab` was moved there > because I expect the default behavior of a tab to resemble the > `SettingsTab` over a `TerminalTab`. > > ## References > Verified that Close submenu work was transferred over (#7728, #7961, #8010). > > ## Validation Steps Performed > Check close submenu on first/last tab when multiple tabs are open. > > Closes #7969 > > [unsealed runtime class]: https://docs.microsoft.com/en-us/uwp/midl-3/intro#base-classes Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>

@leonMSFT

In preparation for the Settings UI, we needed to make some changes to Tab to abstract out shared, common functionality between different types of tab. This is the result of that work. All code references to the settings have been removed or reverted. Contains changes from #8053, #7802. The messages below only make sense in the context of the Settings UI, which this pull request does not bring in. They do, however, provide valuable information. From #7802 (@leonMSFT): > This PR's goal was to add an option to the `OpenSettings` keybinding to > open the Settings UI in a tab. In order to implement that, a couple of > changes had to be made to `Tab`, specifically: > > - Introduce a tab interface named `ITab` > - Create/Rename two new Tab classes that implement `ITab` called > `SettingsTab` and `TerminalTab` > From #8053: > `TerminalTab` and `SettingsTab` share some implementation details. The > close submenu introduced in #7728 is a good example of functionality > that is consistent across all tabs. This PR transforms `ITab` from an > interface, into an [unsealed runtime class] to de-duplicate some > functionality. Most of the logic from `SettingsTab` was moved there > because I expect the default behavior of a tab to resemble the > `SettingsTab` over a `TerminalTab`. > > ## References > Verified that Close submenu work was transferred over (#7728, #7961, #8010). > > ## Validation Steps Performed > Check close submenu on first/last tab when multiple tabs are open. > > Closes #7969 > > [unsealed runtime class]: https://docs.microsoft.com/en-us/uwp/midl-3/intro#base-classes Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>

@leonMSFT

In preparation for the Settings UI, we needed to make some changes to Tab to abstract out shared, common functionality between different types of tab. This is the result of that work. All code references to the settings have been removed or reverted. Contains changes from #8053, #7802. The messages below only make sense in the context of the Settings UI, which this pull request does not bring in. They do, however, provide valuable information. From #7802 (@leonMSFT): > This PR's goal was to add an option to the `OpenSettings` keybinding to > open the Settings UI in a tab. In order to implement that, a couple of > changes had to be made to `Tab`, specifically: > > - Introduce a tab interface named `ITab` > - Create/Rename two new Tab classes that implement `ITab` called > `SettingsTab` and `TerminalTab` > From #8053: > `TerminalTab` and `SettingsTab` share some implementation details. The > close submenu introduced in #7728 is a good example of functionality > that is consistent across all tabs. This PR transforms `ITab` from an > interface, into an [unsealed runtime class] to de-duplicate some > functionality. Most of the logic from `SettingsTab` was moved there > because I expect the default behavior of a tab to resemble the > `SettingsTab` over a `TerminalTab`. > > ## References > Verified that Close submenu work was transferred over (#7728, #7961, #8010). > > ## Validation Steps Performed > Check close submenu on first/last tab when multiple tabs are open. > > Closes #7969 > > [unsealed runtime class]: https://docs.microsoft.com/en-us/uwp/midl-3/intro#base-classes Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>

@leonMSFT

In preparation for the Settings UI, we needed to make some changes to Tab to abstract out shared, common functionality between different types of tab. This is the result of that work. All code references to the settings have been removed or reverted. Contains changes from #8053, #7802. The messages below only make sense in the context of the Settings UI, which this pull request does not bring in. They do, however, provide valuable information. From #7802 (@leonMSFT): > This PR's goal was to add an option to the `OpenSettings` keybinding to > open the Settings UI in a tab. In order to implement that, a couple of > changes had to be made to `Tab`, specifically: > > - Introduce a tab interface named `ITab` > - Create/Rename two new Tab classes that implement `ITab` called > `SettingsTab` and `TerminalTab` > From #8053: > `TerminalTab` and `SettingsTab` share some implementation details. The > close submenu introduced in #7728 is a good example of functionality > that is consistent across all tabs. This PR transforms `ITab` from an > interface, into an [unsealed runtime class] to de-duplicate some > functionality. Most of the logic from `SettingsTab` was moved there > because I expect the default behavior of a tab to resemble the > `SettingsTab` over a `TerminalTab`. > > ## References > Verified that Close submenu work was transferred over (#7728, #7961, #8010). > > ## Validation Steps Performed > Check close submenu on first/last tab when multiple tabs are open. > > Closes #7969 > > [unsealed runtime class]: https://docs.microsoft.com/en-us/uwp/midl-3/intro#base-classes Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com> Co-authored-by: Leon Liang <lelian@microsoft.com> Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>

I originally just wanted to close #1104, but then discovered that hey, this event wasn't even used anymore. Excerpts of Teams convo: * [Snap to character grid when resizing window by mcpiroman · Pull Request #3181 · microsoft/terminal (github.com)](https://github.com/microsoft/terminal/pull/3181/files#diff-d7ca72e0d5652fee837c06532efa614191bd5c41b18aa4d3ee6711f40138f04c) added it to Tab.cpp * where it was added * which called `pane->Relayout` which I don't even REMEMBER * By [Add functionality to open the Settings UI tab through openSettings by leonMSFT · Pull Request #7802 · microsoft/terminal (github.com)](https://github.com/microsoft/terminal/pull/7802/files#diff-83d260047bed34d3d9d5a12ac62008b65bd6dc5f3b9642905a007c3efce27efd), there was seemingly no FontSizeChanged in Tab.cpp (when it got moved to terminaltab.cpp) > `Pane::Relayout` functionally did nothing because sizing was switched to `star` sizing at some point in the past, so it was just deleted. From [Misc pane refactoring by Rosefield · Pull Request #11373 · microsoft/terminal](https://github.com/microsoft/terminal/pull/11373/files#r736900998) So, great. We can kill part of it, and convert the rest to a `TypedEvent`, and get rid of `DECLARE_` / `DEFINE_`. `ScrollPositionChangedEventArgs` was ALSO apparently already promoted to a typed event, so kill that too.

leonMSFT added 13 commits September 24, 2020 10:38

ITab, winrtimplements, now i need the tab changes from master

1cfaae9

getting updated with feature

0174020

SettingsTab, building fine, still need hookups to create it

80c0c3d

eGaDs it opens a new tab on keybinding pog

6b82151

give it a fixed font icon, call update title and icon

091ac79

welp it builds in vs, doesn't want to build in cmd tho so i can't run…

8882f66

…tests

goin back to good ol' GetStrongTabImpl

3fdb0f1

changing the name to be a bit more descriptive

cb91b2a

function name updates, revisiting ITab interface

53ca33a

comment updates

ce8458c

runformat

da5bf4f

teaching mr bot

258cfa9

cleanups, one tab at a time, switch to existing tab

c2f891f

DHowett reviewed Oct 1, 2020

View reviewed changes

leonMSFT mentioned this pull request Oct 1, 2020

Feature Request - Implement Settings UI #1564

Closed

34 tasks

attempting to fix build

ef8922b

leonMSFT marked this pull request as ready for review October 1, 2020 21:29

leonMSFT added 5 commits October 1, 2020 14:31

settingsUI as Page, TabViewItem as Property

9e0a979

make the Content property

96af5a8

SettingsTab's Content property as Page

242b0f2

mimic Control::Focus, move OpenSettingsUI call

35e7920

and that is why i should always build the tests too

bfd66f0

carlos-zamora reviewed Oct 2, 2020

View reviewed changes

leonMSFT added 5 commits October 2, 2020 12:58

remove unnecessary includes, add comments, slim down GetTTImpl

657db06

re-add spaces to TAL.vcxproj

51591d7

hmm i guess there isn't a newline at the end

3d57825

removing unnecessary GetTerminalTabImpl

7f5987a

simplify the Title vs GetActiveTitle dance in TerminalTab

2b250af

leonMSFT added 2 commits October 6, 2020 13:16

move command creation to terminal page

e9e8302

formatting

dcc1125

carlos-zamora approved these changes Oct 6, 2020

View reviewed changes

src/cascadia/TerminalApp/TerminalPage.cpp Show resolved Hide resolved

src/cascadia/TerminalApp/TerminalPage.cpp Show resolved Hide resolved

src/cascadia/TerminalApp/Utils.h Show resolved Hide resolved

leonMSFT added the AutoMerge Marked for automatic merge by the bot when requirements are met label Oct 6, 2020

ghost merged commit bde5d5e into feature/settings-ui Oct 6, 2020

ghost deleted the dev/lelian/tse-keybinding branch October 6, 2020 22:22

DHowett mentioned this pull request Nov 3, 2020

Make Tab an unsealed runtimeclass (and rename it to TabBase) #8153

Merged

zadjii-msft mentioned this pull request Feb 18, 2021

Error in menu #9204

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add functionality to open the Settings UI tab through openSettings #7802

Add functionality to open the Settings UI tab through openSettings #7802

leonMSFT commented Oct 1, 2020 •

edited

Loading

DHowett left a comment

carlos-zamora left a comment

carlos-zamora Oct 2, 2020

carlos-zamora Oct 2, 2020

leonMSFT Oct 3, 2020

carlos-zamora Oct 5, 2020

leonMSFT Oct 5, 2020

leonMSFT Oct 6, 2020

carlos-zamora commented Oct 6, 2020

azure-pipelines bot commented Oct 6, 2020

carlos-zamora left a comment

ghost commented Oct 6, 2020

german-one commented Oct 7, 2020

zadjii-msft commented Oct 7, 2020 •

edited

Loading

leonMSFT commented Oct 7, 2020

german-one commented Oct 7, 2020

carlos-zamora commented Oct 7, 2020

zadjii-msft commented Oct 7, 2020

DHowett commented Oct 7, 2020

Add functionality to open the Settings UI tab through openSettings #7802

Add functionality to open the Settings UI tab through openSettings #7802

Conversation

leonMSFT commented Oct 1, 2020 • edited Loading

DHowett left a comment

Choose a reason for hiding this comment

carlos-zamora left a comment

Choose a reason for hiding this comment

carlos-zamora Oct 2, 2020

Choose a reason for hiding this comment

carlos-zamora Oct 2, 2020

Choose a reason for hiding this comment

leonMSFT Oct 3, 2020

Choose a reason for hiding this comment

carlos-zamora Oct 5, 2020

Choose a reason for hiding this comment

leonMSFT Oct 5, 2020

Choose a reason for hiding this comment

leonMSFT Oct 6, 2020

Choose a reason for hiding this comment

carlos-zamora commented Oct 6, 2020

azure-pipelines bot commented Oct 6, 2020

carlos-zamora left a comment

Choose a reason for hiding this comment

ghost commented Oct 6, 2020

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

german-one commented Oct 7, 2020

zadjii-msft commented Oct 7, 2020 • edited Loading

leonMSFT commented Oct 7, 2020

german-one commented Oct 7, 2020

carlos-zamora commented Oct 7, 2020

zadjii-msft commented Oct 7, 2020

DHowett commented Oct 7, 2020

leonMSFT commented Oct 1, 2020 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

zadjii-msft commented Oct 7, 2020 •

edited

Loading