Warning, /libraries/plasma-wayland-protocols/src/protocols/org-kde-plasma-virtual-desktop.xml is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" encoding="UTF-8"?> 0002 <protocol name="org_kde_plasma_virtual_desktop"> 0003 <copyright><![CDATA[ 0004 SPDX-FileCopyrightText: 2018 Marco Martin 0005 0006 SPDX-License-Identifier: LGPL-2.1-or-later 0007 ]]></copyright> 0008 0009 <interface name="org_kde_plasma_virtual_desktop_management" version="2"> 0010 <request name="get_virtual_desktop"> 0011 <description summary="get the org_kde_plasma_virtual_desktop interface for a desktop"> 0012 Given the id of a particular virtual desktop, get the corresponding org_kde_plasma_virtual_desktop which represents only the desktop with that id. 0013 </description> 0014 <arg name="id" type="new_id" interface="org_kde_plasma_virtual_desktop"/> 0015 <arg name="desktop_id" type="string" summary="Unique id of the desktop"/> 0016 </request> 0017 0018 <request name="request_create_virtual_desktop"> 0019 <description summary="ask for the creation of a new desktop at a specified position"> 0020 Ask the server to create a new virtual desktop, and position it at a specified position. If the position is zero or less, it will be positioned at the beginning, if the position is the count or more, it will be positioned at the end. 0021 </description> 0022 <arg name="name" type="string" summary="The user readable name we want for the desktop"/> 0023 <arg name="position" type="uint" summary="The position we want for the desktop"/> 0024 </request> 0025 0026 <request name="request_remove_virtual_desktop"> 0027 <description summary="ask for a desktop removal identified by id"> 0028 Ask the server to get rid of a virtual desktop, the server may or may not acconsent to the request. 0029 </description> 0030 <arg name="desktop_id" type="string" summary="Unique id of the desktop"/> 0031 </request> 0032 0033 <event name="desktop_created"> 0034 <description summary="Emitted when a new desktop has been created"></description> 0035 <arg name="desktop_id" type="string" summary="Unique id of the desktop"/> 0036 <arg name="position" type="uint" summary="Position of this desktop, to ensure the client and the server will see desktops in the same order"/> 0037 </event> 0038 0039 <!--TODO: maybe the removed signal of the desktop object is enough?--> 0040 <event name="desktop_removed"> 0041 <description summary="Emitted when a desktop has been removed"></description> 0042 <arg name="desktop_id" type="string" summary="Unique id of the desktop"/> 0043 </event> 0044 0045 <event name="done"> 0046 <description summary="sent all information about desktops"> 0047 This event is sent after all other properties has been 0048 sent after binding to the desktop manager object and after any 0049 other property changes done after that. This allows 0050 changes to the org_kde_plasma_virtual_desktop_management properties to be seen as 0051 atomic, even if they happen via multiple events. 0052 </description> 0053 </event> 0054 0055 <event name="rows" since="2"> 0056 <arg name="rows" type="uint" summary="Number of rows the virtual desktops are laid out into."/> 0057 </event> 0058 </interface> 0059 0060 0061 <interface name="org_kde_plasma_virtual_desktop" version="1"> 0062 <request name="request_activate"> 0063 <description summary="Requests this desktop to be activated"> 0064 Request the server to set the status of this desktop to active: The server is free to consent or deny the request. This will be the new "current" virtual desktop of the system. 0065 </description> 0066 </request> 0067 0068 <event name="desktop_id"> 0069 <description summary="The desktop got an id"> 0070 The format of the id is decided by the compositor implementation. A desktop id univocally identifies a virtual desktop and must be guaranteed to never exist two desktops with the same id. The format of the string id is up to the server implementation. 0071 </description> 0072 <arg name="desktop_id" type="string" summary="Unique id of the desktop"/> 0073 </event> 0074 0075 <event name="name"> 0076 <arg name="name" type="string" summary="User readable descriptive name for the desktop"/> 0077 </event> 0078 0079 <event name="activated"> 0080 <description summary="The desktop has been activated"> 0081 The desktop will be the new "current" desktop of the system. The server may support either one virtual desktop active at a time, or other combinations such as one virtual desktop active per screen. 0082 Windows associated to this virtual desktop will be shown. 0083 </description> 0084 </event> 0085 0086 <event name="deactivated"> 0087 <description summary="This desktop is no longer active"> 0088 Windows that were associated only to this desktop will be hidden. 0089 </description> 0090 </event> 0091 0092 <event name="done"> 0093 <description summary="sent all information about desktops"> 0094 This event is sent after all other properties has been 0095 sent after binding to the desktop object and after any 0096 other property changes done after that. This allows 0097 changes to the org_kde_plasma_virtual_desktop properties to be seen as 0098 atomic, even if they happen via multiple events. 0099 </description> 0100 </event> 0101 0102 <event name="removed"> 0103 <description summary="This desktop has been removed"> 0104 This virtual desktop has just been removed by the server: 0105 All windows will lose the association to this desktop. 0106 </description> 0107 </event> 0108 </interface> 0109 0110 </protocol>