Added Close Pane to Context Menu

[joadoumie]

Summary of the Pull Request

Adding a 'Close Pane' menu item in the context menu.

References and Relevant Issues

#13580

Detailed Description of the Pull Request / Additional comments

If a user decides to split a tab to create multiple panes through the context menu, they should be able to then close the pane via the context menu too. This PR introduces a new context menu item, 'Close Pane', that only appears when a user has 2 or more panes in a tab. When a user clicks close pane, the _active_pane will be closed.

Validation Steps Performed

As it's my first PR, I still need to understand how to go through the testing suite.

PR Checklist

• Closes Add close pane to the tab context menu (when there are multiple panes) #13580
• Tests added/passed
• Documentation updated
  • If checked, please file a pull request on our docs repo and link it here: #xxx
• Schema updated (if necessary)

[zadjii-msft]

I still need to understand how to go through the testing suite.

You're in luck! For better or worse, this part of the code actually doesn't have any tests! So don't worry too much ☺️

You will likely need to run tools\runformat.cmd though, to get the automatic code-formatter to run 😄

[joadoumie]

I get this error when I try to run the code formatter - any suggestions for how to fix?

[joadoumie]

Also - any suggestions on what the icon should be @zadjii-msft - https://learn.microsoft.com/en-us/windows/apps/design/style/segoe-ui-symbol-font?

[joadoumie]

For whatever reason the cmd script wasn't working for me, but is this equivalent?

[zadjii-msft]

but is this equivalent

Yep looks like it! I bet the cmd version wasn't robust enough to be run from outside the solution root directory 🤷

[zadjii-msft]

As far as icons, maybe e89f, "ClosePane"? That's not great, since like, you could have a horizontal split, or be closing the left one... Honestly, I think it's okay without one for now.

[zadjii-msft]

Sorry, yea, this is an admittedly crazy obscure feature I don't think most folks have ever used:

[joadoumie]

Is there any place where we would know that there's only one pane left?

Update to this comment: The below suggestion I made does not work as ctl + shift + w uses ClosePane --> back to the drawing board :).

Does it make sense to call DetachPane instead of ClosePane in the menu item click?

closePaneMenuItem.Click([weakThis](auto&&, auto&&) { if (auto tab{ weakThis.get() }) { tab->DetachPane(); } });

Then in DetachPane it makes sense to me that we would know that only one pane is left.

std::shared_ptr<Pane>` TerminalTab::DetachPane()
    {
        // if we only have one pane, or the focused pane is the root, remove it
        // entirely and close this tab
        if (_rootPane == _activePane)
        {
            return DetachRoot();
        }
        // Attempt to remove the active pane from the tree
        if (const auto pane = _rootPane->DetachPane(_activePane))
        {
            // Just make sure that the remaining pane is marked active
            _UpdateActivePane(_rootPane->GetActivePane());

            if (_rootPane->GetLeafPaneCount() == 1)
            {
                this->_closePaneMenuItem.Visibility(WUX::Visibility::Collapsed);
            }

            return pane;
        }

        return nullptr;
    }

With these changes it seems like it resolves the edge case you mentioned. I'm very new to the codebase so if this is not quite the way you were thinking this should be implemented let me know :)

Not really sure what DetachPane vs. ClosePane does.

[joadoumie]

Is there any place where we would know that there's only one pane?

I'm not sure if this is what you were thinking but seems to work ok if the check is in _UpdateActivePane().

[carlos-zamora]

Personally, I think we should...

1. remove the tooltip (doesn't seem useful)
2. make the menu item always visible/active (regardless of number of open panes)

Thoughts? Open to discussion/disagreement on this one.

[zadjii-msft]

I love this. This is exactly what I'd've done. Thanks for bearing with us!

[zadjii-msft]

this is infinitely better than before ☺️

[joadoumie]

Yay! Completely new to the project and really appreciate the support and guidance from both you and @carlos-zamora. Excited to try out some new issues too.

FYI, I LOVE the walkthroughs. Makes it way easier to get started for people who aren't as experienced in C++ or the Terminal project :)

[carlos-zamora]

Love it. Thanks so much!

[DHowett]

Love it, thanks for the contribution @joadoumie !