org_kde_plasma_virtual_desktop protocol

org_kde_plasma_virtual_desktop_management interface version 2

Requests

get_virtual_desktop since version 0

Given the id of a particular virtual desktop, get the corresponding org_kde_plasma_virtual_desktop which represents only the desktop with that id;

Arguments
id (new_id) (org_kde_plasma_virtual_desktop)
desktop_id (string)

Unique id of the desktop


request_create_virtual_desktop since version 0

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 cosition is the count or more, it will be positioned at the end.

Arguments
name (string)

The user readable name we want for the desktop

position (uint)

The position we want for the desktop


request_remove_virtual_desktop since version 0

Ask the server to get rid of a virtual desktop, the server may or may not acconsent to the request.

Arguments
desktop_id (string)

Unique id of the desktop


Events

desktop_created since version 0
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 since version 0
desktop_id (string)

Unique id of the desktop


done since version 0

This event is sent after all other properties has been sent after binding to the desktop manager object and after any other property changes done after that. This allows changes to the org_kde_plasma_virtual_desktop_management properties to be seen as atomic, even if they happen via multiple events.


rows since version 2
rows (uint)

Number of rows the virtual desktops are laid out into.




org_kde_plasma_virtual_desktop interface version 1

Requests

request_activate since version 0

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.


Events

desktop_id since version 0

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.

desktop_id (string)

Unique id of the desktop


name since version 0
name (string)

User readable descriptive name for the desktop


activated since version 0

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 since version 0

Windows that were associated only to this desktop will be hidden.


done since version 0

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 since version 0

This virtual desktop has just been removed by the server: All windows will lose the association to this desktop.




SPDX-FileCopyrightText: 2018 Marco Martin SPDX-License-Identifier: LGPL-2.1-or-later