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 #5251] Prevent the cursor type being reset when changing the visibility #26213

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

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

State: closed
Merged: Yes

A side effect of the SetConsoleCursorInfo API is that it resets the
cursor type to Legacy. This makes it impossible to change the cursor
visibility via the console APIs without also resetting the user's
preferred cursor type. This PR attempts to fix that limitation, by only
resetting the cursor type if the size has also been changed.

PR Checklist

Detailed Description of the Pull Request / Additional comments

I suspect the reason for the original behaviour was because the
SetConsoleCursorInfo API sets both the visibility and the size, and if
you're setting the size, it's assumed you'd want the Legacy cursor
type, because that's the only style for which the size is applicable.

So my solution was to only reset the cursor type if the requested cursor
size was actually different from the current size. That should be
reasonably backwards compatible with most size-changing code, but also
allow for changing the visibility without resetting the cursor type.

Validation Steps Performed

I've tested the example code from issue #4124, and confirmed that it now
works correctly without resetting the cursor type.

I've also tested the console's mark mode, which temporarily changes
the cursor size while selecting. I've confirmed that the size still
changes, and that the original cursor type is restored afterwards.

**Original Pull Request:** https://github.com/microsoft/terminal/pull/5251 **State:** closed **Merged:** Yes --- A side effect of the `SetConsoleCursorInfo` API is that it resets the cursor type to _Legacy_. This makes it impossible to change the cursor visibility via the console APIs without also resetting the user's preferred cursor type. This PR attempts to fix that limitation, by only resetting the cursor type if the size has also been changed. ## PR Checklist * [x] Closes #4124 * [x] CLA signed * [ ] Tests added/passed * [ ] Requires documentation to be updated ## Detailed Description of the Pull Request / Additional comments I suspect the reason for the original behaviour was because the `SetConsoleCursorInfo` API sets both the visibility and the size, and if you're setting the size, it's assumed you'd want the _Legacy_ cursor type, because that's the only style for which the size is applicable. So my solution was to only reset the cursor type if the requested cursor size was actually different from the current size. That should be reasonably backwards compatible with most size-changing code, but also allow for changing the visibility without resetting the cursor type. ## Validation Steps Performed I've tested the example code from issue #4124, and confirmed that it now works correctly without resetting the cursor type. I've also tested the console's _mark mode_, which temporarily changes the cursor size while selecting. I've confirmed that the size still changes, and that the original cursor type is restored afterwards.
claunia added the pull-request label 2026-01-31 09:14:39 +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#26213
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?