Teach terminal to hide mouse while typing #8629

Don-Vito · 2020-12-21T00:27:55Z

PR Checklist

Closes Support Mouse Vanish (Hide pointer while typing) #5699
CLA signed.
Tests added/passed
Documentation updated.
Schema updated.
I've discussed this with core contributors already.

Detailed Description of the Pull Request / Additional comments

Use SPI_GETMOUSEVANISH setting
Hide upon CharacterReceived
Unhide upon PointerMoved, PointerMoved, MouseWheel, LoseFocus

…focus

github-actions · 2020-12-21T01:28:01Z

New misspellings found, please review:

GETMOUSEVANISH

To accept these changes, run the following commands

perl -e '
my @expect_files=qw('".github/actions/spell-check/expect/5757ec679b03a4240130c3c53766c91bbc5cd6a7.txt
.github/actions/spell-check/expect/655f007265b351e140d20b3976792523ad689241.txt
.github/actions/spell-check/expect/alphabet.txt
.github/actions/spell-check/expect/expect.txt
.github/actions/spell-check/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"AAAAA Bopomofo Checkboxes CParams cso CSV DOWNSCALE GENERATEPROJECTPRIFILE hhhh Horiz Inlines INPATHROOT intersectors Kode MAKEINTRESOURCEA mousemode msixbundle psin Reserialize reso RETROII rgus sbri scanbri scol SGRXY spe sph spherefunctions tcon UDK UDKs Unfocus Viginetting wz xe xlang XWV xyw yzx "');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
  if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
  next if /^($re)(?:$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spell-check/expect/e1d615aa30d357fac68ac3bcafc560ca222994da.txt";
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"checkboxes csv GETMOUSEVANISH horiz inlines reserialize udk unfocus "');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a) cmp lc($b)} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;'
git add .github/actions/spell-check/expect || echo '... you want to ensure .github/actions/spell-check/expect/e1d615aa30d357fac68ac3bcafc560ca222994da.txt is added to your repository...'

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. You can copy the contents of each perl command excluding the outer ' marks and dropping any '"/"' quotation mark pairs into a file and then run perl file.pl from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:

... misspelled, then please correct them instead of using the command.
... names, please add them to .github/actions/spell-check/dictionary/names.txt.
... APIs, you can add them to a file in .github/actions/spell-check/dictionary/.
... just things you're using, please add them to an appropriate file in .github/actions/spell-check/expect/.
... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spell-check/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The :check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

⚠️ Reviewers

At present, the action that triggered this message will not show its ❌ in this PR unless the branch is within this repository.
Thus, you should make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

carlos-zamora

Implementation is pretty solid. Thanks!

I'm wondering if we should make this a setting? Or maybe we should test this out in WT Preview a bit to see to what level people want to configure it? Either way, I'm ok merging it as-is, then deciding on it's configurability later.

src/cascadia/TerminalControl/TermControl.idl

Don-Vito · 2020-12-24T09:55:59Z

Implementation is pretty solid. Thanks!

I'm wondering if we should make this a setting? Or maybe we should test this out in WT Preview a bit to see to what level people want to configure it? Either way, I'm ok merging it as-is, then deciding on it's configurability later.

I didn't introduce a setting because we already read a system wide one. So I suggest trying this in preview and seeing what happens 😊

zadjii-msft · 2021-01-04T15:13:26Z

You know what, @DHowett has spent a lot of time working on our mouse pointer handling before, so I'm gonna make sure he's the second signoff for this.

@msftbot make sure @DHowett signs off on this

DHowett · 2021-01-04T20:32:34Z

Systemwide setting >>> local one, always.

EDIT: i mean, we do not need a local setting for this

src/cascadia/TerminalApp/TerminalPage.cpp

DHowett

What happens when the cursor is hidden, and then terminal exits (or the pane closes or what-have-you?) Will the next terminal focused properly restore it to visible?

Don-Vito · 2021-01-20T22:12:45Z

What happens when the cursor is hidden, and then terminal exits (or the pane closes or what-have-you?) Will the next terminal focused properly restore it to visible?

If the terminal exits / pane is hidden, the next terminal will not show the cursor until the mouse is moved. This is somewhat inconsistent, as switching between terminals does restore the cursor immediately. I will fix it.

DHowett · 2021-01-20T22:13:57Z

It may be fine if you don't fix it. As long as Windows restores it eventually. 😄

Don-Vito · 2021-01-20T22:25:30Z

It may be fine if you don't fix it. As long as Windows restores it eventually. 😄

Fixed :) Actually it was important: open a terminal tab and settings tab, start typing in the terminal tab, then ctrl+w. Learn how to edit settings without a mouse 😄

DHowett · 2021-01-20T22:30:28Z

src/cascadia/TerminalControl/TermControl.cpp

@@ -2582,6 +2582,8 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
    {
        if (!_closing.exchange(true))
        {
+            _RestorePointerCursorHandlers(*this, nullptr);


hmm.. will this restore the cursor to pointer if a terminal closes while a different one is the one that hid it? The sleep 5; exit scenario, but you go type in a different terminal tab while it's waiting to beef it

Once again this user who wants to destroy terminal? 😄
The restore is managed on the TerminalPage level - so we won't need to remember who hid it.
If I don't miss anything, in the worst case we will get mouse restored.. while typing.. and then it will be hidden again.

Let's leave it like this. This will be okay for now 😄

user who wants to destroy terminal

You'd be surprised! Look for posts by vefatica here 😉 and there's also one Microsoft person who keeps reporting bugs in multibyte character handling because he apparently just runs a stress testing program that emits random code units and then he actively resizes the window while it's doing that

You'd be surprised! Look for posts by vefatica here 😉 and there's also one Microsoft person who keeps reporting bugs in multibyte character handling because he apparently just runs a stress testing program that emits random code units and then he actively resizes the window while it's doing that

After few months following the tracker I am not surprised with anything as the creativity is limitless 😊 And I am a big fan of vefatica quite for a while - even before he found the handle leak.

DHowett · 2021-01-21T01:17:47Z

Thanks again!

ghost · 2021-01-21T01:17:48Z

Hello @DHowett!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

ghost · 2021-01-28T18:07:12Z

🎉Windows Terminal Preview v1.6.10272.0 has been released which incorporates this pull request.:tada:

Handy links:

## PR Checklist * [x] Closes microsoft#5699 * [x] CLA signed. * [ ] Tests added/passed * [ ] Documentation updated. * [ ] Schema updated. * [ ] I've discussed this with core contributors already. ## Detailed Description of the Pull Request / Additional comments * Use SPI_GETMOUSEVANISH setting * Hide upon CharacterReceived * Unhide upon PointerMoved, PointerMoved, MouseWheel, LoseFocus

viral32111 · 2021-03-03T12:31:34Z

Is there a settings/configuration option to disable this beaviour? I preferred it when the mouse pointer stayed visible all the time because it seems to rapidly flash between hidden & showing when typing, which gets very annoying.

Also when the cursor is hidden and you move it up to the minimise/maximise/exit buttons it doesn't reappear.

zadjii-msft · 2021-03-03T13:05:33Z

@viral32111 So, we're already checking the state of the system-wide Mouse vanish setting. So the terminal should be behaving in line with other apps. You could disable that setting if you wanted to have the cursor always visible.

Now that I'm typing this up though, it seems like Edgium doesn't vanish the cursor as I type though. So maybe there should be an additional setting.

notes:

SPI_GETMOUSEVANISH

Teach terminal control to hide mouse while typing

ddfbe78

Don-Vito marked this pull request as draft December 21, 2020 00:31

Don-Vito added 2 commits December 21, 2020 02:46

Teach terminal control to restore cursor upon pointer press and lost …

e1d615a

…focus

Introduce hide and restore cursor methods

5e0e24c

Don-Vito added 2 commits December 21, 2020 04:06

Move the cursor hiding logic to terminal page to ensure consistency

80f648b

Add GETMOUSEVANISH to expected keywords

eb25570

Don-Vito changed the title ~~Teach terminal control to hide mouse while typing~~ Teach terminal to hide mouse while typing Dec 21, 2020

Don-Vito marked this pull request as ready for review December 21, 2020 02:09

carlos-zamora approved these changes Dec 24, 2020

View reviewed changes

src/cascadia/TerminalControl/TermControl.idl Outdated Show resolved Hide resolved

Rename event names to *PointerCursor to avoid confusion

9e90e6a

zadjii-msft assigned zadjii-msft and DHowett and unassigned zadjii-msft Jan 4, 2021

DHowett reviewed Jan 4, 2021

View reviewed changes

src/cascadia/TerminalApp/TerminalPage.cpp Show resolved Hide resolved

Don-Vito requested a review from DHowett January 13, 2021 11:48

DHowett approved these changes Jan 20, 2021

View reviewed changes

Merge branch 'main' into 5699-mouse-vanish

fab5699

Fix terminal control to restore cursor when closing

d6c27f7

DHowett reviewed Jan 20, 2021

View reviewed changes

DHowett approved these changes Jan 21, 2021

View reviewed changes

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Jan 21, 2021

ghost merged commit 9c4950c into microsoft:main Jan 21, 2021

j4james mentioned this pull request Jan 28, 2021

A hidden mouse cursor won't reappear when moved if over a tab #8918

Closed

ghost mentioned this pull request Jan 28, 2021

Support Mouse Vanish (Hide pointer while typing) #5699

Closed

globau mentioned this pull request Mar 1, 2022

Hide the mouse pointer when you start typing warpdotdev/Warp#758

Open

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Teach terminal to hide mouse while typing #8629

Teach terminal to hide mouse while typing #8629

Don-Vito commented Dec 21, 2020 •

edited

Loading

github-actions bot commented Dec 21, 2020

carlos-zamora left a comment

Don-Vito commented Dec 24, 2020 •

edited

Loading

zadjii-msft commented Jan 4, 2021

DHowett commented Jan 4, 2021 •

edited

Loading

DHowett left a comment

Don-Vito commented Jan 20, 2021

DHowett commented Jan 20, 2021

Don-Vito commented Jan 20, 2021 •

edited

Loading

DHowett Jan 20, 2021

Don-Vito Jan 20, 2021 •

edited

Loading

DHowett Jan 20, 2021

DHowett Jan 20, 2021

Don-Vito Jan 20, 2021

DHowett commented Jan 21, 2021

ghost commented Jan 21, 2021

ghost commented Jan 28, 2021

viral32111 commented Mar 3, 2021

zadjii-msft commented Mar 3, 2021 •

edited

Loading

Teach terminal to hide mouse while typing #8629

Teach terminal to hide mouse while typing #8629

Conversation

Don-Vito commented Dec 21, 2020 • edited Loading

PR Checklist

Detailed Description of the Pull Request / Additional comments

github-actions bot commented Dec 21, 2020

New misspellings found, please review:

⚠️ Reviewers

carlos-zamora left a comment

Choose a reason for hiding this comment

Don-Vito commented Dec 24, 2020 • edited Loading

zadjii-msft commented Jan 4, 2021

DHowett commented Jan 4, 2021 • edited Loading

DHowett left a comment

Choose a reason for hiding this comment

Don-Vito commented Jan 20, 2021

DHowett commented Jan 20, 2021

Don-Vito commented Jan 20, 2021 • edited Loading

DHowett Jan 20, 2021

Choose a reason for hiding this comment

Don-Vito Jan 20, 2021 • edited Loading

Choose a reason for hiding this comment

DHowett Jan 20, 2021

Choose a reason for hiding this comment

DHowett Jan 20, 2021

Choose a reason for hiding this comment

Don-Vito Jan 20, 2021

Choose a reason for hiding this comment

DHowett commented Jan 21, 2021

ghost commented Jan 21, 2021

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented Jan 28, 2021

viral32111 commented Mar 3, 2021

zadjii-msft commented Mar 3, 2021 • edited Loading

Don-Vito commented Dec 21, 2020 •

edited

Loading

Don-Vito commented Dec 24, 2020 •

edited

Loading

DHowett commented Jan 4, 2021 •

edited

Loading

Don-Vito commented Jan 20, 2021 •

edited

Loading

Don-Vito Jan 20, 2021 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

zadjii-msft commented Mar 3, 2021 •

edited

Loading