KDE plasma virtual desktop
get_virtual_desktop(id: new_id<org_kde_plasma_virtual_desktop>, desktop_id: string)
Argument | Type | Description |
|---|---|---|
| id | new_id<org_kde_plasma_virtual_desktop> | |
| desktop_id | string | Unique id of the desktop |
Given the id of a particular virtual desktop, get the corresponding org_kde_plasma_virtual_desktop which represents only the desktop with that id.
Warning! The protocol described in this file is a desktop environment implementation detail. Regular clients must not use this protocol. Backward incompatible changes may be added without bumping the major version of the extension.
Argument | Type | Description |
|---|---|---|
| name | string | The user readable name we want for the desktop |
| position | uint | The position we want for the desktop |
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.
request_remove_virtual_desktop(desktop_id: string)
Argument | Type | Description |
|---|---|---|
| desktop_id | string | Unique id of the desktop |
Ask the server to get rid of a virtual desktop, the server may or may not acconsent to the request.
desktop_created(desktop_id: string, position: uint)
Argument | Type | Description |
|---|---|---|
| desktop_id | string | Unique id of the desktop |
| position | uint | Position of this desktop, to ensure the client and the server will see desktops in the same order |
desktop_removed(desktop_id: string)
Argument | Type | Description |
|---|---|---|
| desktop_id | string | Unique id of the desktop |
done()
This event is sent after all other properties have been sent after binding to the desktop manager global and after all changes to org_kde_plasma_virtual_desktop_management and org_kde_plasma_virtual_desktop properties have been sent.
This allows changes to org_kde_plasma_virtual_desktop_management and org_kde_plasma_virtual_desktop properties to be seen as atomic, even if they happen via multiple events.
org_kde_plasma_virtual_desktop
request_activate()
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.
desktop_id(desktop_id: string)
Argument | Type | Description |
|---|---|---|
| desktop_id | string | Unique id of the desktop |
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.
activated()
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. Windows associated to this virtual desktop will be shown.
deactivated()
Windows that were associated only to this desktop will be hidden.
done()
This event is sent after all other properties has been sent after binding to the desktop object and after any other property changes done after that. This allows changes to the org_kde_plasma_virtual_desktop properties to be seen as atomic, even if they happen via multiple events.
removed()
This virtual desktop has just been removed by the server: All windows will lose the association to this desktop.
Compositor Support
Cage  | COSMIC  | GameScope  | Hyprland  | Jay | KWin  | Labwc  | Louvre  | Mir  | Muffin  | Mutter  | niri  | river  | Sway  | Treeland  | Wayfire  | Weston  | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| org_kde_plasma_virtual_desktop_management | x | x | x | x | x | 2 | x | x | x | x | x | x | x | x | x | x | x |