[plasmashell] Update docs for panelTakesFocus to make it generic

Summary:
We want surfaces with a notification role to be able to switch ability
to take focus or not on the fly. The semantics are identical as the
panel
taking focus, we may as well re-use what exists and remove the implicit
limitation than re-invent the wheel and complicate things.

Test Plan: Docs

Reviewers: #kwin, romangg

Reviewed By: #kwin, romangg

Subscribers: romangg, apol, kde-frameworks-devel

Tags: #frameworks

Differential Revision: https://phabricator.kde.org/D26175
This commit is contained in:
David Edmundson 2019-12-30 15:44:15 +00:00
parent 95956415c6
commit 6896e96014

View file

@ -168,13 +168,14 @@ public:
void showAutoHidingPanel();
/**
* Whether a PlasmaShellSurfaceInterface with Role Panel wants to have focus.
* Whether a PlasmaShellSurfaceInterface wants to have focus.
*
* By default a Panel does not get focus, but the PlasmaShellSurfaceInterface can
* By default some PlasmaShell roles do not get focus, but the PlasmaShellSurfaceInterface can
* request that it wants to have focus. The compositor can use this information to
* pass focus to the panel.
* pass focus to the surface.
* @since 5.28
**/
//TODO KF6 rename to something generic
bool panelTakesFocus() const;
/**