KDE plasma window management

org_kde_plasma_window_management

version 18

application windows 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.

org_kde_plasma_window_management::show_desktop

show_desktop(state: uint)

Argument	Type	Description
state	uint	requested state

show/hide the desktop

Tell the compositor to show/hide the desktop.

org_kde_plasma_window_management::get_window

get_window(id: new_id<org_kde_plasma_window>, internal_window_id: uint)

Argument	Type	Description
id	new_id<org_kde_plasma_window>
internal_window_id	uint	The internal window id of the window to create

deprecated

Deprecated: use get_window_by_uuid

org_kde_plasma_window_management::get_window_by_uuid

since 12

get_window_by_uuid(id: new_id<org_kde_plasma_window>, internal_window_uuid: string)

Argument	Type	Description
id	new_id<org_kde_plasma_window>
internal_window_uuid	string	The internal window uuiid of the window to create

org_kde_plasma_window_management::get_stacking_order

since 17

get_stacking_order(stacking_order: new_id<org_kde_plasma_stacking_order>)

Argument	Type	Description
stacking_order	new_id<org_kde_plasma_stacking_order>

get the stacking order

org_kde_plasma_window_management::show_desktop_changed

show_desktop_changed(state: uint)

Argument	Type	Description
state	uint	new state

notify the client when the show desktop mode is entered/left

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.

org_kde_plasma_window_management::window

window(id: uint)

Argument	Type	Description
id	uint	Deprecated: internal window Id

notify the client that a window was mapped

This event will be sent immediately after a window is mapped.

org_kde_plasma_window_management::stacking_order_changed

since 11

stacking_order_changed(ids: array)

Argument	Type	Description
ids	array	internal windows id array

notify the client when stacking order changed

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.

org_kde_plasma_window_management::stacking_order_uuid_changed

since 12

stacking_order_uuid_changed(uuids: string)

Argument	Type	Description
uuids	string	internal windows id ;-separated

notify the client when stacking order changed

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.

org_kde_plasma_window_management::window_with_uuid

since 13

window_with_uuid(id: uint, uuid: string)

Argument	Type	Description
id	uint	Deprecated: internal window Id
uuid	string	internal window uuid

notify the client that a window was mapped

This event will be sent immediately after a window is mapped.

org_kde_plasma_window_management::stacking_order_changed_2

since 17

stacking_order_changed_2()

notify the client when stacking order changed

This event will be sent when stacking order changed.

org_kde_plasma_window_management::state

state { active, minimized, maximized, fullscreen, keep_above, keep_below, on_all_desktops, demands_attention, closeable, minimizable, maximizable, fullscreenable, skiptaskbar, shadeable, shaded, movable, resizable, virtual_desktop_changeable, skipswitcher }

Argument	Value	Description
active	0x1
minimized	0x2
maximized	0x4
fullscreen	0x8
keep_above	0x10
keep_below	0x20
on_all_desktops	0x40
demands_attention	0x80
closeable	0x100
minimizable	0x200
maximizable	0x400
fullscreenable	0x800
skiptaskbarsince 2	0x1000
shadeablesince 3	0x2000
shadedsince 3	0x4000
movablesince 3	0x8000
resizablesince 3	0x10000
virtual_desktop_changeablesince 3	0x20000
skipswitchersince 9	0x40000

org_kde_plasma_window_management::show_desktop

show_desktop { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

org_kde_plasma_window

version 18

interface to control application windows

Manages and control an application window.

Only one client can bind this interface at a time.

org_kde_plasma_window::set_state

set_state(flags: uint, state: uint)

Argument	Type	Description
flags	uint	bitfield of set state flags
state	uint	bitfield of state flags

set window state

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

org_kde_plasma_window::set_virtual_desktop

set_virtual_desktop(number: uint)

Argument	Type	Description
number	uint	zero based virtual desktop number

map window on a virtual desktop

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.

org_kde_plasma_window::set_minimized_geometry

set_minimized_geometry(panel: object<wl_surface>, x: uint, y: uint, width: uint, height: uint)

Argument	Type	Description
panel	object<wl_surface>
x	uint
y	uint
width	uint
height	uint

set the geometry for a taskbar entry

Sets the geometry of the taskbar entry for this window. The geometry is relative to a panel in particular.

org_kde_plasma_window::unset_minimized_geometry

unset_minimized_geometry(panel: object<wl_surface>)

Argument	Type	Description
panel	object<wl_surface>

set the geometry for a taskbar entry

Remove the task geometry information for a particular panel.

org_kde_plasma_window::close

close()

close window

Close this window.

org_kde_plasma_window::request_move

since 3

request_move()

request move

Request an interactive move for this window.

org_kde_plasma_window::request_resize

since 3

request_resize()

request resize

Request an interactive resize for this window.

org_kde_plasma_window::destroy

Type: destructorsince 4

destroy()

remove resource for the org_kde_plasma_window

Removes the resource bound for this org_kde_plasma_window.

org_kde_plasma_window::get_icon

since 7

get_icon(fd: fd)

Argument	Type	Description
fd	fd	file descriptor for the icon

Requests to get the window icon

The compositor will write the window icon into the provided file descriptor. The data is a serialized QIcon with QDataStream.

org_kde_plasma_window::request_enter_virtual_desktop

since 8

request_enter_virtual_desktop(id: string)

Argument	Type	Description
id	string	desktop id

map window on a virtual desktop

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.

org_kde_plasma_window::request_enter_new_virtual_desktop

since 8

request_enter_new_virtual_desktop()

map window on a virtual desktop

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.

org_kde_plasma_window::request_leave_virtual_desktop

since 8

request_leave_virtual_desktop(id: string)

Argument	Type	Description
id	string	desktop id

remove a window from a virtual desktop

Make the window exit a virtual desktop. If it exits all desktops it will be considered on all of them.

org_kde_plasma_window::request_enter_activity

since 14

request_enter_activity(id: string)

Argument	Type	Description
id	string	activity id

map window on an activity

Make the window enter an activity. A window can enter more activity. If the id is empty or invalid, no action will be performed.

org_kde_plasma_window::request_leave_activity

since 14

request_leave_activity(id: string)

Argument	Type	Description
id	string	activity id

remove a window from an activity

Make the window exit a an activity. If it exits all activities it will be considered on all of them.

org_kde_plasma_window::send_to_output

since 15

send_to_output(output: object<wl_output>)

Argument	Type	Description
output	object<wl_output>

send window to specified output

Requests this window to be displayed in a specific output.

org_kde_plasma_window::title_changed

title_changed(title: string)

Argument	Type	Description
title	string	window title

window title has been changed

This event will be sent as soon as the window title is changed.

org_kde_plasma_window::app_id_changed

app_id_changed(app_id: string)

Argument	Type	Description
app_id	string

application identifier has been changed

This event will be sent as soon as the application identifier is changed.

org_kde_plasma_window::state_changed

state_changed(flags: uint)

Argument	Type	Description
flags	uint	bitfield of state flags

window state has been changed

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.

org_kde_plasma_window::virtual_desktop_changed

virtual_desktop_changed(number: int)

Argument	Type	Description
number	int	zero based virtual desktop number

window was moved to another workspace

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.

org_kde_plasma_window::themed_icon_name_changed

themed_icon_name_changed(name: string)

Argument	Type	Description
name	string	the new themed icon name

window's icon name changed

This event will be sent whenever the themed icon name changes. May be null.

org_kde_plasma_window::unmapped

unmapped()

window's surface was unmapped

This event will be sent immediately after the window is closed and its surface is unmapped.

org_kde_plasma_window::initial_state

since 4

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.

org_kde_plasma_window::parent_window

since 5

parent_window(parent: object<org_kde_plasma_window>)

Argument	Type	Description
parent	object<org_kde_plasma_window>allow null	The parent window

The parent window changed

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.

org_kde_plasma_window::geometry

since 6

geometry(x: int, y: int, width: uint, height: uint)

Argument	Type	Description
x	int	x position of the org_kde_plasma_window
y	int	y position of the org_kde_plasma_window
width	uint	width of the org_kde_plasma_window
height	uint	height of the org_kde_plasma_window

The geometry of this window in absolute coordinates

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_window::icon_changed

since 7

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.

org_kde_plasma_window::pid_changed

pid_changed(pid: uint)

Argument	Type	Description
pid	uint	process id

process id of application owning the window has changed

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.

org_kde_plasma_window::virtual_desktop_entered

since 8

virtual_desktop_entered(id: string)

Argument	Type	Description
id	string	desktop id

the window entered a new virtual desktop

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.

org_kde_plasma_window::virtual_desktop_left

since 8

virtual_desktop_left(is: string)

Argument	Type	Description
is	string	desktop id

the window left a virtual desktop

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.

org_kde_plasma_window::application_menu

since 10

application_menu(service_name: string, object_path: string)

Argument	Type	Description
service_name	string
object_path	string

notify the client that the current appmenu changed

This event will be sent after the application menu for the window has changed.

org_kde_plasma_window::activity_entered

since 14

activity_entered(id: string)

Argument	Type	Description
id	string	activity id

the window entered an activity

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.

org_kde_plasma_window::activity_left

since 14

activity_left(id: string)

Argument	Type	Description
id	string	activity id

the window left an activity

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.

org_kde_plasma_window::resource_name_changed

since 16

resource_name_changed(resource_name: string)

Argument	Type	Description
resource_name	string	resource name

X11 resource name has changed

This event will be sent when the X11 resource name of the window has changed. This is only set for XWayland windows.

org_kde_plasma_window::client_geometry

since 18

client_geometry(x: int, y: int, width: uint, height: uint)

Argument	Type	Description
x	int	x position of the org_kde_plasma_window
y	int	y position of the org_kde_plasma_window
width	uint	width of the org_kde_plasma_window
height	uint	height of the org_kde_plasma_window

The client geometry (i.e. without decorations etc) of this window in absolute coordinates

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

version 1

activation feedback

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

org_kde_plasma_activation_feedback::destroy

Type: destructor

destroy()

destroy the activation manager object

Destroy the activation manager object. The activation objects introduced by this manager object will be unaffected.

org_kde_plasma_activation_feedback::activation

activation(id: new_id<org_kde_plasma_activation>)

Argument	Type	Description
id	new_id<org_kde_plasma_activation>

notify that an app is starting

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

version 1

org_kde_plasma_activation::destroy

Type: destructor

destroy()

destroy the org_kde_plasma_activation object

Notify the compositor that the org_kde_plasma_activation object will no longer be used.

org_kde_plasma_activation::app_id

app_id(app_id: string)

Argument	Type	Description
app_id	string	application id, as described in xdg_activation_v1

Offers the app_id

org_kde_plasma_activation::finished

finished()

Notifies about activation finished, either by activation or because it got invalidated

org_kde_plasma_stacking_order

version 17

helper object for sending the 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.

org_kde_plasma_stacking_order::window

window(uuid: string)

Argument	Type	Description
uuid	string	window uuid

a window in the stacking order list

org_kde_plasma_stacking_order::done

Type: destructor

done()

marks the end of the list

Compositor Support

No compositor support found

Copyright

SPDX-FileCopyrightText: 2013-2014 Pier Luigi Fiorini

SPDX-License-Identifier: LGPL-2.1-or-later