99a28f9e9e
## Summary of the Pull Request This PR will make the existing `Tab` class into a WinRT type. This will allow any XAML to simply bind to the `ObservableVector` of Tabs. This PR will be followed up with a future PR to change our TabView to use the ObservableVector, which will in turn eliminate the need for maintaining two vectors of Tabs. (We currently maintain `_tabs` in `TerminalPage` and we also maintain `TabView().TabViewItems()` at the same time as described here: #2740) ## References #3922 ## PR Checklist * [x] CLA signed. * [x] Tests added/passed ## Detailed Description of the Pull Request / Additional comments I've currently only exposed a Tab's Title and IconPath to keep things simple. I foresee XAML elements that bind to Tabs to only really need these two properties for displaying. I've also converted `TerminalPage`'s `std::vector<std::shared_ptr> _tabs` into a `IObservableVector<winrt::TerminalPage::Tab> _tabs` just so that future PRs will have the ground set for binding to this vector of tabs. ## Validation Steps Performed Played around with Tabs and Panes and all sorts of combinations of keybindings for interacting with tabs and dragging and whatnot, it all seemed fine! Tab Tests also all pass.
188 lines
10 KiB
C++
188 lines
10 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#pragma once
|
|
|
|
#include "TerminalPage.g.h"
|
|
#include "Tab.h"
|
|
#include "CascadiaSettings.h"
|
|
#include "Profile.h"
|
|
|
|
#include <winrt/Microsoft.Terminal.TerminalControl.h>
|
|
|
|
#include "AppCommandlineArgs.h"
|
|
|
|
// fwdecl unittest classes
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
class TabTests;
|
|
};
|
|
|
|
namespace winrt::TerminalApp::implementation
|
|
{
|
|
struct TerminalPage : TerminalPageT<TerminalPage>
|
|
{
|
|
public:
|
|
TerminalPage();
|
|
|
|
void SetSettings(std::shared_ptr<::TerminalApp::CascadiaSettings> settings, bool needRefreshUI);
|
|
|
|
void Create();
|
|
|
|
hstring Title();
|
|
|
|
void ShowOkDialog(const winrt::hstring& titleKey, const winrt::hstring& contentKey);
|
|
|
|
void TitlebarClicked();
|
|
|
|
float CalcSnappedDimension(const bool widthOrHeight, const float dimension) const;
|
|
|
|
void CloseWindow();
|
|
|
|
int32_t SetStartupCommandline(winrt::array_view<const hstring> args);
|
|
winrt::hstring EarlyExitMessage();
|
|
|
|
// -------------------------------- WinRT Events ---------------------------------
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(TitleChanged, _titleChangeHandlers, winrt::Windows::Foundation::IInspectable, winrt::hstring);
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(LastTabClosed, _lastTabClosedHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::LastTabClosedEventArgs);
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(SetTitleBarContent, _setTitleBarContentHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::UIElement);
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(ShowDialog, _showDialogHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::Controls::ContentDialog);
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(ToggleFullscreen, _toggleFullscreenHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFullscreenEventArgs);
|
|
|
|
private:
|
|
// If you add controls here, but forget to null them either here or in
|
|
// the ctor, you're going to have a bad time. It'll mysteriously fail to
|
|
// activate the app.
|
|
// ALSO: If you add any UIElements as roots here, make sure they're
|
|
// updated in App::_ApplyTheme. The roots currently is _tabRow
|
|
// (which is a root when the tabs are in the titlebar.)
|
|
Microsoft::UI::Xaml::Controls::TabView _tabView{ nullptr };
|
|
TerminalApp::TabRowControl _tabRow{ nullptr };
|
|
Windows::UI::Xaml::Controls::Grid _tabContent{ nullptr };
|
|
Microsoft::UI::Xaml::Controls::SplitButton _newTabButton{ nullptr };
|
|
|
|
std::shared_ptr<::TerminalApp::CascadiaSettings> _settings{ nullptr };
|
|
|
|
Windows::Foundation::Collections::IObservableVector<TerminalApp::Tab> _tabs;
|
|
winrt::com_ptr<Tab> _GetStrongTabImpl(const uint32_t index) const;
|
|
winrt::com_ptr<Tab> _GetStrongTabImpl(const ::winrt::TerminalApp::Tab& tab) const;
|
|
|
|
bool _isFullscreen{ false };
|
|
|
|
bool _rearranging;
|
|
std::optional<int> _rearrangeFrom;
|
|
std::optional<int> _rearrangeTo;
|
|
|
|
winrt::com_ptr<ShortcutActionDispatch> _actionDispatch{ winrt::make_self<ShortcutActionDispatch>() };
|
|
|
|
::TerminalApp::AppCommandlineArgs _appArgs;
|
|
int _ParseArgs(winrt::array_view<const hstring>& args);
|
|
fire_and_forget _ProcessNextStartupAction();
|
|
|
|
void _ShowAboutDialog();
|
|
void _ShowCloseWarningDialog();
|
|
|
|
void _CreateNewTabFlyout();
|
|
void _OpenNewTabDropdown();
|
|
void _OpenNewTab(const winrt::TerminalApp::NewTerminalArgs& newTerminalArgs);
|
|
void _CreateNewTabFromSettings(GUID profileGuid, winrt::Microsoft::Terminal::Settings::TerminalSettings settings);
|
|
winrt::Microsoft::Terminal::TerminalConnection::ITerminalConnection _CreateConnectionFromSettings(GUID profileGuid, winrt::Microsoft::Terminal::Settings::TerminalSettings settings);
|
|
|
|
void _SettingsButtonOnClick(const IInspectable& sender, const Windows::UI::Xaml::RoutedEventArgs& eventArgs);
|
|
void _FeedbackButtonOnClick(const IInspectable& sender, const Windows::UI::Xaml::RoutedEventArgs& eventArgs);
|
|
void _AboutButtonOnClick(const IInspectable& sender, const Windows::UI::Xaml::RoutedEventArgs& eventArgs);
|
|
void _CloseWarningPrimaryButtonOnClick(Windows::UI::Xaml::Controls::ContentDialog sender, Windows::UI::Xaml::Controls::ContentDialogButtonClickEventArgs eventArgs);
|
|
|
|
void _HookupKeyBindings(TerminalApp::AppKeyBindings bindings) noexcept;
|
|
void _RegisterActionCallbacks();
|
|
|
|
void _UpdateTitle(const Tab& tab);
|
|
void _UpdateTabIcon(Tab& tab);
|
|
void _UpdateTabView();
|
|
void _UpdateTabWidthMode();
|
|
void _DuplicateTabViewItem();
|
|
void _RemoveTabViewItem(const Microsoft::UI::Xaml::Controls::TabViewItem& tabViewItem);
|
|
void _RemoveTabViewItemByIndex(uint32_t tabIndex);
|
|
|
|
void _RegisterTerminalEvents(Microsoft::Terminal::TerminalControl::TermControl term, Tab& hostingTab);
|
|
|
|
void _SelectNextTab(const bool bMoveRight);
|
|
bool _SelectTab(const uint32_t tabIndex);
|
|
void _MoveFocus(const Direction& direction);
|
|
|
|
winrt::Microsoft::Terminal::TerminalControl::TermControl _GetActiveControl();
|
|
std::optional<uint32_t> _GetFocusedTabIndex() const noexcept;
|
|
winrt::fire_and_forget _SetFocusedTabIndex(const uint32_t tabIndex);
|
|
void _CloseFocusedTab();
|
|
void _CloseFocusedPane();
|
|
void _CloseAllTabs();
|
|
|
|
winrt::fire_and_forget _RemoveOnCloseRoutine(Microsoft::UI::Xaml::Controls::TabViewItem tabViewItem, winrt::com_ptr<TerminalPage> page);
|
|
|
|
// Todo: add more event implementations here
|
|
// MSFT:20641986: Add keybindings for New Window
|
|
void _Scroll(int delta);
|
|
void _SplitPane(const winrt::TerminalApp::SplitState splitType, const winrt::TerminalApp::NewTerminalArgs& newTerminalArgs = nullptr);
|
|
void _ResizePane(const Direction& direction);
|
|
void _ScrollPage(int delta);
|
|
void _SetAcceleratorForMenuItem(Windows::UI::Xaml::Controls::MenuFlyoutItem& menuItem, const winrt::Microsoft::Terminal::Settings::KeyChord& keyChord);
|
|
|
|
winrt::fire_and_forget _CopyToClipboardHandler(const IInspectable sender, const winrt::Microsoft::Terminal::TerminalControl::CopyToClipboardEventArgs copiedData);
|
|
winrt::fire_and_forget _PasteFromClipboardHandler(const IInspectable sender,
|
|
const Microsoft::Terminal::TerminalControl::PasteFromClipboardEventArgs eventArgs);
|
|
bool _CopyText(const bool trimTrailingWhitespace);
|
|
void _PasteText();
|
|
static fire_and_forget PasteFromClipboard(winrt::Microsoft::Terminal::TerminalControl::PasteFromClipboardEventArgs eventArgs);
|
|
|
|
fire_and_forget _LaunchSettings(const bool openDefaults);
|
|
|
|
void _OnTabClick(const IInspectable& sender, const Windows::UI::Xaml::Input::PointerRoutedEventArgs& eventArgs);
|
|
void _OnTabSelectionChanged(const IInspectable& sender, const Windows::UI::Xaml::Controls::SelectionChangedEventArgs& eventArgs);
|
|
void _OnTabItemsChanged(const IInspectable& sender, const Windows::Foundation::Collections::IVectorChangedEventArgs& eventArgs);
|
|
void _OnContentSizeChanged(const IInspectable& /*sender*/, Windows::UI::Xaml::SizeChangedEventArgs const& e);
|
|
void _OnTabCloseRequested(const IInspectable& sender, const Microsoft::UI::Xaml::Controls::TabViewTabCloseRequestedEventArgs& eventArgs);
|
|
|
|
void _Find();
|
|
|
|
winrt::fire_and_forget _RefreshUIForSettingsReload();
|
|
|
|
void _ToggleFullscreen();
|
|
|
|
#pragma region ActionHandlers
|
|
// These are all defined in AppActionHandlers.cpp
|
|
void _HandleOpenNewTabDropdown(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleDuplicateTab(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleCloseTab(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleClosePane(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleScrollUp(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleScrollDown(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleNextTab(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandlePrevTab(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleSplitPane(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleScrollUpPage(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleScrollDownPage(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleOpenSettings(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandlePasteText(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleNewTab(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleSwitchToTab(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleResizePane(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleMoveFocus(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleCopyText(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleCloseWindow(const IInspectable&, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleAdjustFontSize(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleFind(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleResetFontSize(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
void _HandleToggleFullscreen(const IInspectable& sender, const TerminalApp::ActionEventArgs& args);
|
|
#pragma endregion
|
|
|
|
friend class TerminalAppLocalTests::TabTests;
|
|
};
|
|
}
|
|
|
|
namespace winrt::TerminalApp::factory_implementation
|
|
{
|
|
struct TerminalPage : TerminalPageT<TerminalPage, implementation::TerminalPage>
|
|
{
|
|
};
|
|
}
|