02ac246807
## Summary of the Pull Request As a part of the Interactivity split, `TermControlAutomationPeer` had to be split into `TermControlAutomationPeer` (TCAP) and `InteractivityAutomationPeer` (IAP). Just about all of the functions in `InterativityAutomationPeer` operate by calling the non-XAML UIA Provider then wrapping the resulting `UIATextRange` into a XAML format (a `XamlUiaTextRange` [XUTR]). As a part of that XUTR constructor, we need a reference to the parent provider. We generally get that via `ProviderFromPeer()`, but IAP's `ProviderFromPeer()` returned null (presumably because IAP isn't in the UI tree, whereas TCAP is directly registered as the automation peer for the `TermControl`). It looks like some screen readers didn't care (like NVDA, though there may be a chance we just didn't encounter an issue just yet), but Narrator definitely did. The fix was to provide XUTR constructors the `ProviderFromPeer` from TCAP, _not_ IAP. To accomplish this, IAP now holds a weak reference to TCAP, and provides the `ProviderFromPeer` when needed. We can't cache this result because there is no guarantee that it won't change. Some miscellaneous changes include: - `TermControl::OnCreateAutomationPeer` now returns the existing auto peer instead of always creating a new one - `TCAP::WrapArrayOfTextRangeProviders` was removed as it was unused (normally, this would be directly affected by the main `ProviderFromPeer` change here) - `XUTR::GetEnclosingElement` is now hooked up to trace logging for debugging purposes ## References Introduced in #10051 Closes #11488 ## Validation Steps Performed ✅ Narrator scan mode now works (verified with character, word, and line navigation) ✅ NVDA movement still works (verified with word and line navigation)
90 lines
4.1 KiB
C++
90 lines
4.1 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- InteractivityAutomationPeer.h
|
|
|
|
Abstract:
|
|
- This module provides UI Automation access to the ControlInteractivity,
|
|
to support both automation tests and accessibility (screen
|
|
reading) applications.
|
|
- See TermControlAutomationPeer for more details on how UIA is implemented.
|
|
- This is the primary implementation of the ITextProvider interface, for the
|
|
TermControlAutomationPeer. The TermControlAutomationPeer will be attached to
|
|
the actual UI tree, via FrameworkElementAutomationPeer. However, the
|
|
ControlInteractivity is totally oblivious to the UI tree that might be hosting
|
|
it. So this class implements the actual text pattern for the buffer, because
|
|
it has access to the buffer. TermControlAutomationPeer can then call the
|
|
methods on this class to expose the implementation in the actual UI tree.
|
|
|
|
Author(s):
|
|
- Mike Griese (migrie), May 2021
|
|
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "ControlInteractivity.h"
|
|
#include "InteractivityAutomationPeer.g.h"
|
|
#include "../types/TermControlUiaProvider.hpp"
|
|
#include "../types/IUiaEventDispatcher.h"
|
|
#include "../types/IControlAccessibilityInfo.h"
|
|
|
|
namespace winrt::Microsoft::Terminal::Control::implementation
|
|
{
|
|
struct InteractivityAutomationPeer :
|
|
public InteractivityAutomationPeerT<InteractivityAutomationPeer>,
|
|
::Microsoft::Console::Types::IUiaEventDispatcher,
|
|
::Microsoft::Console::Types::IControlAccessibilityInfo
|
|
{
|
|
public:
|
|
InteractivityAutomationPeer(Microsoft::Terminal::Control::implementation::ControlInteractivity* owner);
|
|
|
|
void SetControlBounds(const Windows::Foundation::Rect bounds);
|
|
void SetControlPadding(const Core::Padding padding);
|
|
void ParentProvider(Windows::UI::Xaml::Automation::Peers::AutomationPeer parentProvider);
|
|
|
|
#pragma region IUiaEventDispatcher
|
|
void SignalSelectionChanged() override;
|
|
void SignalTextChanged() override;
|
|
void SignalCursorChanged() override;
|
|
#pragma endregion
|
|
|
|
#pragma region ITextProvider Pattern
|
|
Windows::UI::Xaml::Automation::Provider::ITextRangeProvider RangeFromPoint(Windows::Foundation::Point screenLocation);
|
|
Windows::UI::Xaml::Automation::Provider::ITextRangeProvider RangeFromChild(Windows::UI::Xaml::Automation::Provider::IRawElementProviderSimple childElement);
|
|
com_array<Windows::UI::Xaml::Automation::Provider::ITextRangeProvider> GetVisibleRanges();
|
|
com_array<Windows::UI::Xaml::Automation::Provider::ITextRangeProvider> GetSelection();
|
|
Windows::UI::Xaml::Automation::SupportedTextSelection SupportedTextSelection();
|
|
Windows::UI::Xaml::Automation::Provider::ITextRangeProvider DocumentRange();
|
|
#pragma endregion
|
|
|
|
#pragma region IControlAccessibilityInfo Pattern
|
|
// Inherited via IControlAccessibilityInfo
|
|
virtual COORD GetFontSize() const override;
|
|
virtual RECT GetBounds() const override;
|
|
virtual RECT GetPadding() const override;
|
|
virtual double GetScaleFactor() const override;
|
|
virtual void ChangeViewport(SMALL_RECT NewWindow) override;
|
|
virtual HRESULT GetHostUiaProvider(IRawElementProviderSimple** provider) override;
|
|
#pragma endregion
|
|
|
|
TYPED_EVENT(SelectionChanged, IInspectable, IInspectable);
|
|
TYPED_EVENT(TextChanged, IInspectable, IInspectable);
|
|
TYPED_EVENT(CursorChanged, IInspectable, IInspectable);
|
|
|
|
private:
|
|
Windows::UI::Xaml::Automation::Provider::ITextRangeProvider _CreateXamlUiaTextRange(::ITextRangeProvider* returnVal) const;
|
|
|
|
::Microsoft::WRL::ComPtr<::Microsoft::Terminal::TermControlUiaProvider> _uiaProvider;
|
|
winrt::Microsoft::Terminal::Control::implementation::ControlInteractivity* _interactivity;
|
|
weak_ref<Windows::UI::Xaml::Automation::Peers::AutomationPeer> _parentProvider;
|
|
|
|
til::rectangle _controlBounds{};
|
|
til::rectangle _controlPadding{};
|
|
|
|
winrt::com_array<Windows::UI::Xaml::Automation::Provider::ITextRangeProvider> WrapArrayOfTextRangeProviders(SAFEARRAY* textRanges);
|
|
};
|
|
}
|