Commit 935e54ce authored by David Edmundson's avatar David Edmundson

[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
parent c25377a4
......@@ -324,14 +324,15 @@ public:
void requestShowAutoHidingPanel();
/**
* Set whether a PlasmaShellSurface with Role Panel should get focus or not.
* Set whether a PlasmaShellSurface should get focus or not.
*
* By default a Panel does not take focus. With this request the compositor
* can be instructed to also pass focus to a panel
* By default some roles do not take focus. With this request the compositor
* can be instructed to also pass focus.
*
* @param takesFocus Set to @c true if the Panel should gain focus.
* @param takesFocus Set to @c true if the surface should gain focus.
* @since 5.28
**/
//KF6 TODO rename to make it generic
void setPanelTakesFocus(bool takesFocus);
Q_SIGNALS:
......
......@@ -365,11 +365,9 @@
<request name="set_panel_takes_focus" since="4">
<description summary="Whether a panel takes focus">
By default a org_kde_plasma_surface with role panel does not take focus and cannot be
By default various org_kde_plasma_surface roles do not take focus and cannot be
activated. With this request the compositor can be instructed to pass focus also to this
org_kde_plasma_surface.
For org_kde_plasma_surface with another role than panel the request does not have any effect.
</description>
<arg name="takes_focus" type="uint" summary="Boolean value that sets whether the panel takes focus"/>
</request>
......
......@@ -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;
/**
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment