org_kde_plasma_virtual_desktop

• # org_kde_plasma_virtual_desktop_management

  Requests

  • #

    get_virtual_desktop

    get the org_kde_plasma_virtual_desktop interface for a desktop
    struct org_kde_plasma_virtual_desktop* org_kde_plasma_virtual_desktop_management_get_virtual_desktop(

    struct org_kde_plasma_virtual_desktop_management* org_kde_plasma_virtual_desktop_management,

    const char* desktop_id /* 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.
  • #

    request_create_virtual_desktop

    ask for the creation of a new desktop at a specified position
    void org_kde_plasma_virtual_desktop_management_request_create_virtual_desktop(

    struct org_kde_plasma_virtual_desktop_management* org_kde_plasma_virtual_desktop_management,

    const char* name, /* The user readable name we want for the desktop */

    uint32_t position /* 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

    ask for a desktop removal identified by id
    void org_kde_plasma_virtual_desktop_management_request_remove_virtual_desktop(

    struct org_kde_plasma_virtual_desktop_management* org_kde_plasma_virtual_desktop_management,

    const char* desktop_id /* 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.

  Events

  • #

    desktop_created

    Emitted when a new desktop has been created
    const char* desktop_id /* Unique id of the desktop */
    uint32_t position /* Position of this desktop, to ensure the client and the server will see desktops in the same order */
  • #

    desktop_removed

    Emitted when a desktop has been removed
    const char* desktop_id /* Unique id of the desktop */
  • #

    done

    sent all information about desktops
    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
    uint32_t rows /* Number of rows the virtual desktops are laid out into. */

• # org_kde_plasma_virtual_desktop

  Requests

  • #

    request_activate

    Requests this desktop to be activated
    void org_kde_plasma_virtual_desktop_request_activate(

    struct org_kde_plasma_virtual_desktop* org_kde_plasma_virtual_desktop

    )
    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

    The desktop got an id
    const char* desktop_id /* 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.
  • #

    name
    const char* name /* User readable descriptive name for the desktop */
  • #

    activated

    The desktop has been 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

    This desktop is no longer active
    Windows that were associated only to this desktop will be hidden.
  • #

    done

    sent all information about desktops
    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 desktop has been removed
    This virtual desktop has just been removed by the server: All windows will lose the association to this desktop.

Copyright Info