Warning, /libraries/plasma-wayland-protocols/src/protocols/kde-lockscreen-overlay-v1.xml is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <protocol name="kde_lockscreen_overlay_v1">
0003   <copyright><![CDATA[
0004     SPDX-FileCopyrightText: 2022 Aleix Pol Gonzalez <aleixpol@kde.org>
0005 
0006     SPDX-License-Identifier: LGPL-2.1-or-later
0007   ]]></copyright>
0008 
0009   <interface  name="kde_lockscreen_overlay_v1" version="1">
0010       <description summary="Allow surfaces over the lockscreen">
0011         Allows a client to request a surface to be visible when the system is locked.
0012 
0013         This is meant to be used for specific high urgency cases like phone calls or alarms.
0014       </description>
0015 
0016       <enum name="error">
0017           <entry name="invalid_surface_state" value="0" summary="the client provided an invalid surface state"/>
0018       </enum>
0019 
0020       <request name="allow">
0021         <description summary="Tell about which surface could be raised above the lockscreen">
0022           Informs the compositor that the surface could be shown when the screen is locked. This request should be called while the surface is unmapped.
0023         </description>
0024         <arg name="surface" type="object" interface="wl_surface"/>
0025     </request>
0026 
0027     <request name="destroy" type="destructor">
0028         <description summary="Destroy the kde_lockscreen_overlay_v1">
0029           This won't affect the surface previously marked with the allow request.
0030         </description>
0031     </request>
0032   </interface>
0033 </protocol>