plasma_window_management

# org_kde_plasma_window_management

This interface manages application windows. It provides requests to show and hide the desktop and emits an event every time a window is created so that the client can use it to manage the window. Only one client can bind this interface at a time. 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.

Requests
- #
  show_desktop
  
  show/hide the desktop
  
  void org_kde_plasma_window_management_show_desktop(
  struct org_kde_plasma_window_management* org_kde_plasma_window_management,
  
  uint32_t state /* requested state */
  )
  
  Tell the compositor to show/hide the desktop.
- #
  get_window
  
  deprecated
  
  struct org_kde_plasma_window* org_kde_plasma_window_management_get_window(
  struct org_kde_plasma_window_management* org_kde_plasma_window_management,
  
  uint32_t internal_window_id /* The internal window id of the window to create */
  )
  
  Deprecated: use get_window_by_uuid
- #
  get_window_by_uuid
  
  struct org_kde_plasma_window* org_kde_plasma_window_management_get_window_by_uuid(
  struct org_kde_plasma_window_management* org_kde_plasma_window_management,
  
  const char* internal_window_uuid /* The internal window uuiid of the window to create */
  )
- #
  get_stacking_order
  
  get the stacking order
  
  struct org_kde_plasma_stacking_order* org_kde_plasma_window_management_get_stacking_order(
  struct org_kde_plasma_window_management* org_kde_plasma_window_management
  )
Events
- #
  show_desktop_changed
  
  notify the client when the show desktop mode is entered/left
  
  uint32_t state /* new state */
  
  This event will be sent whenever the show desktop mode changes. E.g. when it is entered or left. On binding the interface the current state is sent.
- #
  window
  
  notify the client that a window was mapped
  
  uint32_t id /* Deprecated: internal window Id */
  
  This event will be sent immediately after a window is mapped.
- #
  stacking_order_changed
  
  notify the client when stacking order changed
  
  struct wl_array* ids /* internal windows id array */
  
  This event will be sent when stacking order changed and on bind. With version 17 this event is deprecated and will no longer be sent.
- #
  stacking_order_uuid_changed
  
  notify the client when stacking order changed
  
  const char* uuids /* internal windows id ;-separated */
  
  This event will be sent when stacking order changed and on bind. With version 17 this event is deprecated and will no longer be sent.
- #
  window_with_uuid
  
  notify the client that a window was mapped
  
  uint32_t id /* Deprecated: internal window Id */
  
  const char* uuid /* internal window uuid */
  
  This event will be sent immediately after a window is mapped.
- #
  stacking_order_changed_2
  
  notify the client when stacking order changed
  
  This event will be sent when stacking order changed.
Enums
- #
  state
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_ACTIVE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_MINIMIZED
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_MAXIMIZED
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_FULLSCREEN
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_KEEP_ABOVE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_KEEP_BELOW
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_ON_ALL_DESKTOPS
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_DEMANDS_ATTENTION
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_CLOSEABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_MINIMIZABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_MAXIMIZABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_FULLSCREENABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_SKIPTASKBAR
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_SHADEABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_SHADED
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_MOVABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_RESIZABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_VIRTUAL_DESKTOP_CHANGEABLE
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_STATE_SKIPSWITCHER
- #
  show_desktop
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_SHOW_DESKTOP_DISABLED
  
  ORG_KDE_PLASMA_WINDOW_MANAGEMENT_SHOW_DESKTOP_ENABLED
# org_kde_plasma_window

Manages and control an application window. Only one client can bind this interface at a time.

Requests
- #
  set_state
  
  set window state
  
  void org_kde_plasma_window_set_state(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  uint32_t flags, /* bitfield of set state flags */
  
  uint32_t state /* bitfield of state flags */
  )
  
  Set window state. Values for state argument are described by org_kde_plasma_window_management.state and can be used together in a bitfield. The flags bitfield describes which flags are supposed to be set, the state bitfield the value for the set flags
- #
  set_virtual_desktop
  
  map window on a virtual desktop
  
  void org_kde_plasma_window_set_virtual_desktop(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  uint32_t number /* zero based virtual desktop number */
  )
  
  Deprecated: use enter_virtual_desktop Maps the window to a different virtual desktop. To show the window on all virtual desktops, call the org_kde_plasma_window.set_state request and specify a on_all_desktops state in the bitfield.
- #
  set_minimized_geometry
  
  set the geometry for a taskbar entry
  
  void org_kde_plasma_window_set_minimized_geometry(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  struct wl_surface* panel,
  
  uint32_t x,
  
  uint32_t y,
  
  uint32_t width,
  
  uint32_t height
  )
  
  Sets the geometry of the taskbar entry for this window. The geometry is relative to a panel in particular.
- #
  unset_minimized_geometry
  
  set the geometry for a taskbar entry
  
  void org_kde_plasma_window_unset_minimized_geometry(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  struct wl_surface* panel
  )
  
  Remove the task geometry information for a particular panel.
- #
  close
  
  close window
  
  void org_kde_plasma_window_close(
  struct org_kde_plasma_window* org_kde_plasma_window
  )
  
  Close this window.
- #
  request_move
  
  request move
  
  void org_kde_plasma_window_request_move(
  struct org_kde_plasma_window* org_kde_plasma_window
  )
  
  Request an interactive move for this window.
- #
  request_resize
  
  request resize
  
  void org_kde_plasma_window_request_resize(
  struct org_kde_plasma_window* org_kde_plasma_window
  )
  
  Request an interactive resize for this window.
- #
  destroy
  
  remove resource for the org_kde_plasma_window
  
  void org_kde_plasma_window_destroy(
  struct org_kde_plasma_window* org_kde_plasma_window
  )
  
  Removes the resource bound for this org_kde_plasma_window.
- #
  get_icon
  
  Requests to get the window icon
  
  void org_kde_plasma_window_get_icon(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  int32_t fd /* file descriptor for the icon */
  )
  
  The compositor will write the window icon into the provided file descriptor. The data is a serialized QIcon with QDataStream.
- #
  request_enter_virtual_desktop
  
  map window on a virtual desktop
  
  void org_kde_plasma_window_request_enter_virtual_desktop(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  const char* id /* desktop id */
  )
  
  Make the window enter a virtual desktop. A window can enter more than one virtual desktop. if the id is empty or invalid, no action will be performed.
- #
  request_enter_new_virtual_desktop
  
  map window on a virtual desktop
  
  void org_kde_plasma_window_request_enter_new_virtual_desktop(
  struct org_kde_plasma_window* org_kde_plasma_window
  )
  
  RFC: do this with an empty id to request_enter_virtual_desktop? Make the window enter a new virtual desktop. If the server consents the request, it will create a new virtual desktop and assign the window to it.
- #
  request_leave_virtual_desktop
  
  remove a window from a virtual desktop
  
  void org_kde_plasma_window_request_leave_virtual_desktop(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  const char* id /* desktop id */
  )
  
  Make the window exit a virtual desktop. If it exits all desktops it will be considered on all of them.
- #
  request_enter_activity
  
  map window on an activity
  
  void org_kde_plasma_window_request_enter_activity(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  const char* id /* activity id */
  )
  
  Make the window enter an activity. A window can enter more activity. If the id is empty or invalid, no action will be performed.
- #
  request_leave_activity
  
  remove a window from an activity
  
  void org_kde_plasma_window_request_leave_activity(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  const char* id /* activity id */
  )
  
  Make the window exit a an activity. If it exits all activities it will be considered on all of them.
- #
  send_to_output
  
  send window to specified output
  
  void org_kde_plasma_window_send_to_output(
  struct org_kde_plasma_window* org_kde_plasma_window,
  
  struct wl_output* output
  )
  
  Requests this window to be displayed in a specific output.
Events
- #
  title_changed
  
  window title has been changed
  
  const char* title /* window title */
  
  This event will be sent as soon as the window title is changed.
- #
  app_id_changed
  
  application identifier has been changed
  
  const char* app_id
  
  This event will be sent as soon as the application identifier is changed.
- #
  state_changed
  
  window state has been changed
  
  uint32_t flags /* bitfield of state flags */
  
  This event will be sent as soon as the window state changes. Values for state argument are described by org_kde_plasma_window_management.state.
- #
  virtual_desktop_changed
  
  window was moved to another workspace
  
  int32_t number /* zero based virtual desktop number */
  
  DEPRECATED: use virtual_desktop_entered and virtual_desktop_left instead This event will be sent when a window is moved to another virtual desktop. It is not sent if it becomes visible on all virtual desktops though.
- #
  themed_icon_name_changed
  
  window's icon name changed
  
  const char* name /* the new themed icon name */
  
  This event will be sent whenever the themed icon name changes. May be null.
- #
  unmapped
  
  window's surface was unmapped
  
  This event will be sent immediately after the window is closed and its surface is unmapped.
- #
  initial_state
  
  All initial known state is submitted
  
  This event will be sent immediately after all initial state been sent to the client. If the Plasma window is already unmapped, the unmapped event will be sent before the initial_state event.
- #
  parent_window
  
  The parent window changed
  
  struct org_kde_plasma_window* parent /* The parent window */
  
  This event will be sent whenever the parent window of this org_kde_plasma_window changes. The passed parent is another org_kde_plasma_window and this org_kde_plasma_window is a transient window to the parent window. If the parent argument is null, this org_kde_plasma_window does not have a parent window.
- #
  geometry
  
  The geometry of this window in absolute coordinates
  
  int32_t x /* x position of the org_kde_plasma_window */
  
  int32_t y /* y position of the org_kde_plasma_window */
  
  uint32_t width /* width of the org_kde_plasma_window */
  
  uint32_t height /* height of the org_kde_plasma_window */
  
  This event will be sent whenever the window geometry of this org_kde_plasma_window changes. The coordinates are in absolute coordinates of the windowing system.
- #
  icon_changed
  
  The icon of the window changed
  
  This event will be sent whenever the icon of the window changes, but there is no themed icon name. Common examples are Xwayland windows which have a pixmap based icon. The client can request the icon using get_icon.
- #
  pid_changed
  
  process id of application owning the window has changed
  
  uint32_t pid /* process id */
  
  This event will be sent when the compositor has set the process id this window belongs to. This should be set once before the initial_state is sent.
- #
  virtual_desktop_entered
  
  the window entered a new virtual desktop
  
  const char* id /* desktop id */
  
  This event will be sent when the window has entered a new virtual desktop. The window can be on more than one desktop, or none: then is considered on all of them.
- #
  virtual_desktop_left
  
  the window left a virtual desktop
  
  const char* is /* desktop id */
  
  This event will be sent when the window left a virtual desktop. If the window leaves all desktops, it can be considered on all. If the window gets manually added on all desktops, the server has to send virtual_desktop_left for every previous desktop it was in for the window to be really considered on all desktops.
- #
  application_menu
  
  notify the client that the current appmenu changed
  
  const char* service_name
  
  const char* object_path
  
  This event will be sent after the application menu for the window has changed.
- #
  activity_entered
  
  the window entered an activity
  
  const char* id /* activity id */
  
  This event will be sent when the window has entered an activity. The window can be on more than one activity, or none: then is considered on all of them.
- #
  activity_left
  
  the window left an activity
  
  const char* id /* activity id */
  
  This event will be sent when the window left an activity. If the window leaves all activities, it will be considered on all. If the window gets manually added on all activities, the server has to send activity_left for every previous activity it was in for the window to be really considered on all activities.
- #
  resource_name_changed
  
  X11 resource name has changed
  
  const char* resource_name /* resource name */
  
  This event will be sent when the X11 resource name of the window has changed. This is only set for XWayland windows.
- #
  client_geometry
  
  The client geometry (i.e. without decorations etc) of this window in absolute coordinates
  
  int32_t x /* x position of the org_kde_plasma_window */
  
  int32_t y /* y position of the org_kde_plasma_window */
  
  uint32_t width /* width of the org_kde_plasma_window */
  
  uint32_t height /* height of the org_kde_plasma_window */
  
  This event will be sent whenever the window geometry of this org_kde_plasma_window changes. The coordinates are in absolute coordinates of the windowing system.
# org_kde_plasma_activation_feedback

The activation manager interface provides a way to get notified when an application is about to be activated.

Requests
- #
  destroy
  
  destroy the activation manager object
  
  void org_kde_plasma_activation_feedback_destroy(
  struct org_kde_plasma_activation_feedback* org_kde_plasma_activation_feedback
  )
  
  Destroy the activation manager object. The activation objects introduced by this manager object will be unaffected.
Events
- #
  activation
  
  notify that an app is starting
  
  struct org_kde_plasma_activation* id
  
  Will be issued when an app is set to be activated. It offers an instance of org_kde_plasma_activation that will tell us the app_id and the extent of the activation.
# org_kde_plasma_activation

Requests
- #
  destroy
  
  destroy the org_kde_plasma_activation object
  
  void org_kde_plasma_activation_destroy(
  struct org_kde_plasma_activation* org_kde_plasma_activation
  )
  
  Notify the compositor that the org_kde_plasma_activation object will no longer be used.
Events
- #
  app_id
  
  Offers the app_id
  
  const char* app_id /* application id, as described in xdg_activation_v1 */
- #
  finished
  
  Notifies about activation finished, either by activation or because it got invalidated
# org_kde_plasma_stacking_order

When this object is created, the compositor sends a window event for each window in the stacking order, and afterwards sends the done event and destroys this object.

Events
- #
  window
  
  a window in the stacking order list
  
  const char* uuid /* window uuid */
- #
  done
  
  marks the end of the list

Copyright Info

SPDX-FileCopyrightText: 2013-2014 Pier Luigi Fiorini SPDX-License-Identifier: LGPL-2.1-or-later

plasma_window_management

# org_kde_plasma_window_management

Requests

Events

Enums

# org_kde_plasma_window

Requests

Events

# org_kde_plasma_activation_feedback

Requests

Events

# org_kde_plasma_activation

Requests

Events

# org_kde_plasma_stacking_order

Events

Copyright Info