Treeland DDE shell

treeland_dde_shell_manager_v1

version 1

dde shell manager

This interface allows DDE change some treeland function.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

treeland_dde_shell_manager_v1::get_window_overlap_checker

get_window_overlap_checker(id: new_id<treeland_window_overlap_checker>)

Argument	Type	Description
id	new_id<treeland_window_overlap_checker>

treeland_dde_shell_manager_v1::get_shell_surface

since 1

get_shell_surface(id: new_id<treeland_dde_shell_surface_v1>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<treeland_dde_shell_surface_v1>
surface	object<wl_surface>

create a shell surface from a surface

Create a shell surface for an existing wl_surface.

Only one shell surface can be associated with a given surface.

Recommended for use with xdg_surface.

treeland_dde_shell_manager_v1::get_treeland_dde_active

since 1

get_treeland_dde_active(id: new_id<treeland_dde_active_v1>, seat: object<wl_seat>)

Argument	Type	Description
id	new_id<treeland_dde_active_v1>
seat	object<wl_seat>	seat associated with the dde_active

create a new dde active

Create a new dde active for a given seat.

treeland_dde_shell_manager_v1::get_treeland_multitaskview

since 1

get_treeland_multitaskview(id: new_id<treeland_multitaskview_v1>)

Argument	Type	Description
id	new_id<treeland_multitaskview_v1>

create a new multitaskview context

Create a new multitaskview context for toggle.

treeland_dde_shell_manager_v1::get_treeland_window_picker

since 1

get_treeland_window_picker(id: new_id<treeland_window_picker_v1>)

Argument	Type	Description
id	new_id<treeland_window_picker_v1>

create a new window picker

Create a new window picker to pick window.

treeland_dde_shell_manager_v1::get_treeland_lockscreen

since 1

get_treeland_lockscreen(id: new_id<treeland_lockscreen_v1>)

Argument	Type	Description
id	new_id<treeland_lockscreen_v1>

create a new lockscreen context

Create a new lockscreen context for toggle.

treeland_window_overlap_checker

version 1

An opened toplevel

A treeland_dde_shell_handle_v1 object represents an opened toplevel window. Each app may have multiple opened toplevels.

treeland_window_overlap_checker::update

update(width: int, height: int, anchor: uint<treeland_window_overlap_checker.anchor>, output: object<wl_output>)

Argument	Type	Description
width	int
height	int
anchor	uint<treeland_window_overlap_checker.anchor>
output	object<wl_output>allow null

This interface is used to receive the detected surface. When the xdgshell window in the workspace overlaps with the detected window, an event will be sent to notify the client to process it. The window position will only be recorded when this interface is called. If the window moves, this interface needs to be called again.

treeland_window_overlap_checker::destroy

Type: destructor

destroy()

destroy the treeland_window_overlap_checker object

Destroys the treeland_window_overlap_checker object.

This request should be called either when the client does not want to use the toplevel anymore or after the closed event to finalize the destruction of the object.

treeland_window_overlap_checker::enter

enter()

Window has overlapped

This event is sent when windows overlapped. This event is sent only once.

treeland_window_overlap_checker::leave

leave()

Window not has overlapped

This event is sent when windows not overlapped. This event is sent only once.

treeland_window_overlap_checker::anchor

bitfield

anchor { top, bottom, left, right }

Argument	Value	Description
top	1	the top edge of the anchor rectangle
bottom	2	the bottom edge of the anchor rectangle
left	4	the left edge of the anchor rectangle
right	8	the right edge of the anchor rectangle

same layershell

treeland_dde_shell_surface_v1

version 1

metadata interface

An interface that may be implemented by a wl_surface, for implementations that provide the shell user interface.

It provides requests to set surface role, set skip, set the position set auto placement in output coordinates.

On the server side the object is automatically destroyed when the related wl_surface is destroyed. On client side, treeland_dde_shell_surface_v1.destroy() must be called before destroying the wl_surface object.

treeland_dde_shell_surface_v1::destroy

Type: destructorsince 1

destroy()

destroy the treeland_dde_shell_surface_v1 object

The treeland_dde_shell_surface_v1 interface is removed from the wl_surface object that was turned into a shell surface with the treeland_shell_v1.get_treeland_dde_shell_surface request.

The shell surface role is lost and wl_surface is unmapped.

treeland_dde_shell_surface_v1::set_surface_position

since 1

set_surface_position(x: int, y: int)

Argument	Type	Description
x	int	x coordinate in global space
y	int	y coordinate in global space

change the shell surface position

Move the surface to new coordinates.

Coordinates are global, for example 50,50 for a 1920,0+1920x1080 output is 1970,50 in global coordinates space.

treeland_dde_shell_surface_v1::set_role

since 1

set_role(role: uint<treeland_dde_shell_surface_v1.role>)

Argument	Type	Description
role	uint<treeland_dde_shell_surface_v1.role>

assign a role to this surface

Assign a role to a shell surface.

treeland_dde_shell_surface_v1::set_auto_placement

since 1

set_auto_placement(y_offset: uint)

Argument	Type	Description
y_offset	uint	y position is relative to the cursor bottom

Place the surface at the bottom of the cursor area

Set the vertical alignment of the surface within the cursor width.

Do not use it together with set_surface_position to avoid exceptions.

The position of the surface will be controlled by the compositor after the request, including preventing it from being displayed beyond the edge of the output.

treeland_dde_shell_surface_v1::set_skip_switcher

since 1

set_skip_switcher(skip: uint)

Argument	Type	Description
skip	uint	Boolean value that sets whether to skip the window switcher.

make the window not appear in a switcher

Setting this bit will indicate that the window prefers not to be listed in a switcher.

treeland_dde_shell_surface_v1::set_skip_dock_preview

since 1

set_skip_dock_preview(skip: uint)

Argument	Type	Description
skip	uint	Boolean value that sets whether to skip the dock preview.

make the window not appear in a dock preview

Setting this bit will indicate that the window prefers not to be listed in a dock preview.

treeland_dde_shell_surface_v1::set_skip_muti_task_view

since 1

set_skip_muti_task_view(skip: uint)

Argument	Type	Description
skip	uint	Boolean value that sets whether to skip the mutitask view.

make the window not appear in a mutitask view

Setting this bit will indicate that the window prefers not to be listed in a mutitask view.

treeland_dde_shell_surface_v1::set_accept_keyboard_focus

since 1

set_accept_keyboard_focus(accept: uint)

Argument	Type	Description
accept	uint	Boolean value that sets whether to accept keyboard focus

control whether the surface accepts keyboard focus

Setting this will determine whether the surface can receive keyboard focus. When set to 0, the surface will not receive keyboard focus even when clicked or activated. When set to 1 (default), the surface will receive keyboard focus normally.

treeland_dde_shell_surface_v1::role

role { overlay }

Argument	Value	Description
overlaysince 1	1

available roles for surfaces

These values indicate which roles a surface can be rendered in, They are ordered by z depth.

Displayed below wlr-layer-shell, at the overlay level of the workspace.

Multiple surfaces can share a single role, and ordering within a single role is undefined.

treeland_dde_active_v1

version 1

metadata interface

An interface used to monitor special events.

treeland_dde_active_v1::destroy

Type: destructorsince 1

destroy()

destroy the treeland_dde_active_v1 object

treeland_dde_active_v1::active_in

since 1

active_in(reason: uint<treeland_dde_active_v1.reason>)

Argument	Type	Description
reason	uint<treeland_dde_active_v1.reason>

activeIn event

treeland_dde_active_v1::active_out

since 1

active_out(reason: uint<treeland_dde_active_v1.reason>)

Argument	Type	Description
reason	uint<treeland_dde_active_v1.reason>

activeOut event

treeland_dde_active_v1::start_drag

since 1

start_drag()

sent when the compositor starts a drag operation

treeland_dde_active_v1::drop

since 1

drop()

sent when the compositor drop operation

treeland_dde_active_v1::reason

reason { mouse, wheel }

Argument	Value	Description
mousesince 1	0
wheelsince 1	1

event reason

treeland_multitaskview_v1

version 1

multitaskview context interface

An interface used to control multitaskview.

treeland_multitaskview_v1::destroy

Type: destructorsince 1

destroy()

destroy the treeland_multitaskview_v1 object

treeland_multitaskview_v1::toggle

since 1

toggle()

toggle multitaskview

Show or hide the multitaskview.

treeland_window_picker_v1

version 1

window picker interface

An interface used to pick window and return credentials.

treeland_window_picker_v1::destroy

Type: destructorsince 1

destroy()

destroy the treeland_window_picker_v1 object

treeland_window_picker_v1::pick

since 1

pick(hint: string)

Argument	Type	Description
hint	string	Hint of pick process

pick a window

Pick a window to get information.

treeland_window_picker_v1::window

since 1

window(pid: int)

Argument	Type	Description
pid	int	Pid of picked window

window picked

Picked window information.

treeland_lockscreen_v1

version 1

lockscreen interface

An interface used to operate lockscreen.

treeland_lockscreen_v1::destroy

Type: destructorsince 1

destroy()

destroy the treeland_lockscreen_v1 object

treeland_lockscreen_v1::lock

since 1

lock()

lock screen

Lock the screen.

treeland_lockscreen_v1::shutdown

since 1

shutdown()

show shutdown

Show shutdown.

treeland_lockscreen_v1::switch_user

since 1

switch_user()

switch user

Switch user.

Compositor Support

	Mutter 47.3	KWin 6.3	Sway 1.10	COSMIC 0.1	Hyprland 0.44	niri 25.01	Weston 14	Mir 2.19	GameScope 3.15.14	Jay 1.9.0	Labwc 0.8.2	Wayfire 0.9.0	Treeland 0.5.17	Louvre 2.14.1
treeland_dde_shell_manager_v1	x	x	x	x	x	x	x	x	x	x	x	x	1	x

Copyright

SPDX-FileCopyrightText: 2024 UnionTech Software Technology Co., Ltd. SPDX-License-Identifier: MIT