Bug 492936 - Make it easier to figure out how to activate KWin effects that require keyboard shortcuts to turn on and off
Summary: Make it easier to figure out how to activate KWin effects that require keyboa...
Status: RESOLVED FIXED
Alias: None
Product: kwin
Classification: Plasma
Component: effects-various (show other bugs)
Version: 6.1.4
Platform: Arch Linux Linux
: NOR wishlist
Target Milestone: ---
Assignee: KWin default assignee
URL:
Keywords: usability
Depends on:
Blocks:
 
Reported: 2024-09-10 09:07 UTC by filip.kendes1
Modified: 2024-09-28 19:47 UTC (History)
2 users (show)

See Also:
Latest Commit:
Version Fixed In: 6.3.0
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description filip.kendes1 2024-09-10 09:07:13 UTC
SUMMARY
Currently, when user enables Mouse Click Animation in the Desktop Effects KCM, the effect is still disabled by default until user enables it using the Meta+* shortcut.

I propose that the effect gets enabled immediately when user enables it through the Desktop Effects KCM

STEPS TO REPRODUCE
1. Open Desktop Effects KCM
2. Check the Mouse Click Animation effect and click the Apply button
3. Try to click anywhere -> Effect is not enabled

OBSERVED RESULT
Mouse Click Animation is not enabled when user checks the Mouse Click Animation effect and clicks the Apply button

EXPECTED RESULT
User is required to do an additional step of executing a keyboard shortcut to enable the Click effect  

SOFTWARE/OS VERSIONS
Operating System: Arch Linux 
KDE Plasma Version: 6.1.4
KDE Frameworks Version: 6.5.0
Qt Version: 6.7.2
Kernel Version: 6.10.8-arch1-1 (64-bit)
Graphics Platform: Wayland
Comment 1 Nate Graham 2024-09-19 20:31:56 UTC
Hmm, if that happened, I think we would be teaching the user the wrong thing: they would learn that the way to turn the effect on and off is by checking and unchecking the checkbox (and pressing the Apply button) rather than learning the keyboard shortcut.

I don't think this is a good idea, sorry. If anything, I would propose something different: that all effects that are turned on and off by keyboard shortcut have this information listed in their subtitles/descriptions. And maybe they should also all be enabled by default too.

I'm changing the title of the bug report to be about that; hope you don't mind!
Comment 2 filip.kendes1 2024-09-20 11:20:38 UTC
Yeah, it makes sense. I'd still like them to be enabled by default since the user wants the feature because they checked it. Having a note that it can be/ should be controlled using shortcuts would be helpful.

I'm also ok with not change, not a huge deal breaker.
Comment 3 Nate Graham 2024-09-23 23:17:44 UTC
Effects that need their descriptions tweaked:

Hide Cursor
Invert
Mouse Click animation
Track Mouse
Magnifier/Zoom

Mouse Mark
Thumbnail Aside

Show Paint

Cube
Overview
Comment 4 Bug Janitor Service 2024-09-23 23:46:58 UTC
A possibly relevant merge request was started @ https://invent.kde.org/plasma/kwin/-/merge_requests/6478
Comment 5 Bug Janitor Service 2024-09-23 23:50:40 UTC
A possibly relevant merge request was started @ https://invent.kde.org/plasma/kdeplasma-addons/-/merge_requests/629
Comment 6 Nate Graham 2024-09-27 14:24:52 UTC
Git commit 12f03df605fed18d2e1a3bab41d8077688bcf4ed by Nate Graham.
Committed on 27/09/2024 at 14:15.
Pushed by ngraham into branch 'master'.

plugins: make it easier to figure out how to toggle activatable effects

Many KWin effects require a two-step process to activate: first enable
them in the KCM, and activate them using a keyboard shortcut — either
the default one or a custom one. But this may not be obvious to users,
who can think that simply enabling the effects in the KCM is enough.

To improve this, mention the need for manual activation using a keyboard
shortcut in the captions of effects that have this requirement.
FIXED-IN: 6.3.0

M  +1    -1    src/plugins/invert/metadata.json
M  +1    -1    src/plugins/magnifier/metadata.json
M  +1    -1    src/plugins/mouseclick/metadata.json
M  +1    -1    src/plugins/mousemark/metadata.json
M  +1    -1    src/plugins/overview/metadata.json
M  +1    -1    src/plugins/showpaint/metadata.json
M  +1    -1    src/plugins/thumbnailaside/metadata.json
M  +1    -1    src/plugins/trackmouse/metadata.json
M  +1    -1    src/plugins/zoom/metadata.json

https://invent.kde.org/plasma/kwin/-/commit/12f03df605fed18d2e1a3bab41d8077688bcf4ed
Comment 7 Nate Graham 2024-09-27 14:30:35 UTC
Git commit 6e0024aba5c072ad22b4b421dd6484a5511f43bb by Nate Graham.
Committed on 27/09/2024 at 14:19.
Pushed by ngraham into branch 'master'.

kwin/effects: Mention the cube effect's need for manual activation

The Cube effect requires a two-step process to activate: first enable
it in the KCM, and activate it using a keyboard shortcut — either the
default one or a custom one. But this may not be obvious to users,
who can think that simply enabling it in the KCM is enough.

To improve this, mention the need for manual activation using a keyboard
shortcut.

M  +1    -1    kwin/effects/cube/package/metadata.json

https://invent.kde.org/plasma/kdeplasma-addons/-/commit/6e0024aba5c072ad22b4b421dd6484a5511f43bb
Comment 8 Zayed Al-Saidi 2024-09-28 14:58:03 UTC
Could you make it more clear?
 "...,activated with a keyboard shortcut" 
To
"..., it will be activated with a keyboard shortcut"  or something similar. 

Thank you for helping translators.
Comment 9 Nate Graham 2024-09-28 19:47:40 UTC
Maybe I can phrase it in the imperative:

"; activate it with a keyboard shortcut"

But then I feel it begs the question of "which one?" The current phrasing doesn't suggest that to me.