starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #1915] Accessibility: Finalized Shared UIA Tree Model #24712

New Issue
Open
opened 2026-01-31 09:04:54 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:04:54 +00:00
Owner
Copy Link

Original Pull Request: https://github.com/microsoft/terminal/pull/1915

State: closed
Merged: Yes

Summary of the Pull Request

The UIA provider classes are now shared properly. They're hooked up to ConHost and Windows Terminal. You should actually have a UIA Tree when you try to use them.

The actual text buffer UIA element is not hooked up for Windows Terminal, however. That'll be a later PR.

References

Extension of #1691
Please read the description in that PR for background information.

Detailed Description of the Pull Request / Additional comments

Changes to the WindowUiaProvider

As mentioned earlier, the WindowUiaProvider is the top-level UIA provider for our projects. To reuse as much code as possible, I created Microsoft::Console::Types::WindowUiaProviderBase. Any existing functions that reference a ScreenInfoUiaProvider were virtual-ized.

In each project, a WindowUiaProvider : WindowUiaProviderBase was created to define those virtual functions. Note that that will be the main difference between ConHost and Windows Terminal moving forward: how many TextBuffers are on the screen.

So, ConHost should be the same as before, with only one ScreenInfoUiaProvider, whereas Windows Terminal needs to (1) update which one is on the screen and (2) may have multiple on the screen.

🚨 Windows Terminal doesn't have the ScreenInfoUiaProvider hooked up yet. We'll have all the XAML elements in the UIA tree. But, since TermControl is a custom XAML Control, I need to hook up the ScreenInfoUiaProvider to it. This work will be done in a new PR and resolve GitHub Issue #1352.

Moved to Microsoft::Console::Types

These files got moved to a shared area so that they can be used by both ConHost and Windows Terminal.
This means that any references to the ServiceLocator had to be removed.

  • IConsoleWindow
    • Windows Terminal: IslandWindow : IConsoleWindow
  • ScreenInfoUiaProvider
    • all references to ServiceLocator and SCREEN_INFORMATION were removed. IRenderData was used to accomplish this. Refer to next section for more details.
  • UiaTextRange
    • all references to ServiceLocator and SCREEN_INFORMATION were removed. IRenderData was used to accomplish this. Refer to next section for more details.
    • since most of the functions were static, that means that an IRenderData had to be added into most of them.

Changes to IRenderData

Since IRenderData is now being used to abstract out ServiceLocator and SCREEN_INFORMATION, I had to add a few functions here:

  • bool IsAreaSelected()
  • void ClearSelection()
  • void SelectNewRegion(...)
  • HRESULT SearchForText(...)

image

SearchForText() is a problem here. The overall new design is great! But Windows Terminal doesn't have a way to search for text in the buffer yet, whereas ConHost does. So I'm punting on this issue for now. It looks nasty, but just look at all the other pretty things here. :)

Miscellaneous Known Issues

  • Issue #1914 - Tracing needs to be reattached
  • Issue #1352 - Windows Terminal: the ScreenInfoUiaProvider needs to be attached to the TermControl.

Things I'll fix in this PR (just need to add commits on top of it):

  • ConHost: the UIA Rects for the caption buttons are missing. Still investigating this issue.
  • I would be VERY surprised if the tests for ConHost pass.

Validation Steps Performed

  • Deployed ConHost from master and ConHost from this branch. Did some quick validation using inspect.exe.
  • Used inspect.exe to see UIA tree in Windows Terminal.
**Original Pull Request:** https://github.com/microsoft/terminal/pull/1915 **State:** closed **Merged:** Yes --- ## Summary of the Pull Request The UIA provider classes are now shared properly. They're hooked up to ConHost and Windows Terminal. You should actually have a UIA Tree when you try to use them. The actual text buffer UIA element is not hooked up for Windows Terminal, however. That'll be a later PR. ## References Extension of #1691 Please read the description in that PR for background information. ## Detailed Description of the Pull Request / Additional comments ### Changes to the WindowUiaProvider As mentioned earlier, the WindowUiaProvider is the top-level UIA provider for our projects. To reuse as much code as possible, I created `Microsoft::Console::Types::WindowUiaProviderBase`. Any existing functions that reference a `ScreenInfoUiaProvider` were virtual-ized. In each project, a `WindowUiaProvider : WindowUiaProviderBase` was created to define those virtual functions. Note that that will be the main difference between ConHost and Windows Terminal moving forward: how many TextBuffers are on the screen. So, ConHost should be the same as before, with only one `ScreenInfoUiaProvider`, whereas Windows Terminal needs to (1) update which one is on the screen and (2) may have multiple on the screen. 🚨 Windows Terminal doesn't have the `ScreenInfoUiaProvider` hooked up yet. We'll have all the XAML elements in the UIA tree. But, since `TermControl` is a custom XAML Control, I need to hook up the `ScreenInfoUiaProvider` to it. This work will be done in a new PR and resolve GitHub Issue #1352. ### Moved to `Microsoft::Console::Types` These files got moved to a shared area so that they can be used by both ConHost and Windows Terminal. This means that any references to the `ServiceLocator` had to be removed. - `IConsoleWindow` - Windows Terminal: `IslandWindow : IConsoleWindow` - `ScreenInfoUiaProvider` - all references to `ServiceLocator` and `SCREEN_INFORMATION` were removed. `IRenderData` was used to accomplish this. Refer to next section for more details. - `UiaTextRange` - all references to `ServiceLocator` and `SCREEN_INFORMATION` were removed. `IRenderData` was used to accomplish this. Refer to next section for more details. - since most of the functions were `static`, that means that an `IRenderData` had to be added into most of them. ### Changes to IRenderData Since `IRenderData` is now being used to abstract out `ServiceLocator` and `SCREEN_INFORMATION`, I had to add a few functions here: - `bool IsAreaSelected()` - `void ClearSelection()` - `void SelectNewRegion(...)` - `HRESULT SearchForText(...)` ![image](https://user-images.githubusercontent.com/11050425/60994413-52c02980-a305-11e9-8912-2027626b7550.png) `SearchForText()` is a problem here. The overall new design is great! But Windows Terminal doesn't have a way to search for text in the buffer yet, whereas ConHost does. So I'm punting on this issue for now. It looks nasty, but just look at all the other pretty things here. :) ### Miscellaneous Known Issues - [ ] Issue #1914 - `Tracing` needs to be reattached - [ ] Issue #1352 - Windows Terminal: the `ScreenInfoUiaProvider` needs to be attached to the `TermControl`. Things I'll fix in this PR (just need to add commits on top of it): - [ ] ConHost: the UIA Rects for the caption buttons are missing. Still investigating this issue. - [x] I would be VERY surprised if the tests for ConHost pass. <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed - Deployed ConHost from master and ConHost from this branch. Did some quick validation using inspect.exe. - Used inspect.exe to see UIA tree in Windows Terminal.
claunia added the pull-request label 2026-01-31 09:04:54 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#24712
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?