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

[PR #2989] Attach UiaRenderer and Fire Selection Changed Events #25185

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

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

State: closed
Merged: Yes

Summary of the Pull Request

I recommend looking at this PR by commit.

This PR makes use of the UiaRenderer by attaching it to the TerminalControl and setting up selectionChanged events for accessibility.

References

#2447

PR Checklist

  • Closes none
  • CLA signed.
  • Tests added/passed
  • Requires documentation to be updated

Detailed Description of the Pull Request / Additional comments

Commit 1: attaching the UiaRenderer

The uiaRenderer is treated very similarly to the dxRenderer. We have a unique_ptr ref to it in the TermControl. This gets populated when the TermControlAutomationPeer is created (thus enabling accessibility).

To prevent every TermControl from sending signals simultaneously, we specifically only enable whichever one is in an active pane.

The UiaRenderer needs to send encoded events to the automation provider (in this case, TermControlAutomationPeer). We needed our own automation events so that we can reuse this model for ConHost. This is the purpose of IUiaEventDispatcher.

We need a dispatcher for the UiaRenderer. Otherwise, we would do a lot of work to find out when to fire an event, but we wouldn't have a way of doing that.

Commit 2: hooking up selection events

This provides a little bit of polish to hooking it up before. Primarily to actually make it work. This includes returning S_FALSE instead of E_NOTIMPL.

The main thing here really is just how to detect if a selection has changed. This also shows how clean adding more events will be in the future!

Validation Steps Performed

  1. Launch Windows Terminal
  2. Launch Narrator (WIN+CTRL+Enter)

Scenario 1: cell selection

click on a cell with text in it
Narrator should read it out

Scenario 2a: expand selection

Click on a cell with text in it and drag it over more text (extending the selection)
Narrator shouild read the first cell, then read either...

  • the entire selection
  • what was appended to the selection
    (this is still unclear to me when it does which one)

Scenario 2b: reduce selection

Make a selection of an entire word (i.e.: "Powershell")
Reduce the selection to the first character
Narrator should read what got unselected

Scenario 3: Double click

double click on a word
Narrator should read the entire selection

Scenario 4: Triple click

Triple click on a line
Narrator should read the entire selection

**Original Pull Request:** https://github.com/microsoft/terminal/pull/2989 **State:** closed **Merged:** Yes --- ## Summary of the Pull Request I recommend looking at this PR by commit. This PR makes use of the UiaRenderer by attaching it to the TerminalControl and setting up selectionChanged events for accessibility. ## References #2447 ## PR Checklist * [x] Closes none * [x] CLA signed. * [x] ~Tests added/passed~ * [x] ~Requires documentation to be updated~ ## Detailed Description of the Pull Request / Additional comments ### Commit 1: attaching the UiaRenderer The `uiaRenderer` is treated very similarly to the `dxRenderer`. We have a unique_ptr ref to it in the `TermControl`. This gets populated when the `TermControlAutomationPeer` is created (thus enabling accessibility). To prevent every TermControl from sending signals simultaneously, we specifically only enable whichever one is in an active pane. The `UiaRenderer` needs to send encoded events to the automation provider (in this case, `TermControlAutomationPeer`). We needed our own automation events so that we can reuse this model for ConHost. This is the purpose of `IUiaEventDispatcher`. We need a dispatcher for the `UiaRenderer`. Otherwise, we would do a lot of work to find out when to fire an event, but we wouldn't have a way of doing that. ### Commit 2: hooking up selection events This provides a little bit of polish to hooking it up before. Primarily to actually make it work. This includes returning `S_FALSE` instead of `E_NOTIMPL`. The main thing here really is just how to detect if a selection has changed. This also shows how clean adding more events will be in the future! ## Validation Steps Performed 1. Launch Windows Terminal 2. Launch Narrator (WIN+CTRL+Enter) ### Scenario 1: cell selection click on a cell with text in it Narrator should read it out ### Scenario 2a: expand selection Click on a cell with text in it and drag it over more text (extending the selection) Narrator shouild read the first cell, then read either... - the entire selection - what was appended to the selection (this is still unclear to me when it does which one) ### Scenario 2b: reduce selection Make a selection of an entire word (i.e.: "Powershell") Reduce the selection to the first character Narrator should read what got unselected ### Scenario 3: Double click double click on a word Narrator should read the entire selection ### Scenario 4: Triple click Triple click on a line Narrator should read the entire selection
claunia added the pull-request label 2026-01-31 09:07:49 +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#25185
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?