Treeland personalization manager

treeland_personalization_manager_v1

version 1

personalization manager

This interface allows a client to customized display effects.

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_personalization_manager_v1::get_window_context

get_window_context(id: new_id<treeland_personalization_window_context_v1>, surface: object<wl_surface>)

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

get personalization window context

set window background, shadow based on context

treeland_personalization_manager_v1::get_wallpaper_context

get_wallpaper_context(id: new_id<treeland_personalization_wallpaper_context_v1>)

Argument	Type	Description
id	new_id<treeland_personalization_wallpaper_context_v1>

custom wallpaper context

custom user wallpaper

treeland_personalization_manager_v1::get_cursor_context

get_cursor_context(id: new_id<treeland_personalization_cursor_context_v1>)

Argument	Type	Description
id	new_id<treeland_personalization_cursor_context_v1>

custom wallpaper context

custom user cursor

treeland_personalization_manager_v1::get_font_context

get_font_context(id: new_id<treeland_personalization_font_context_v1>)

Argument	Type	Description
id	new_id<treeland_personalization_font_context_v1>

custom treeland and window global font context

treeland_personalization_manager_v1::get_appearance_context

get_appearance_context(id: new_id<treeland_personalization_appearance_context_v1>)

Argument	Type	Description
id	new_id<treeland_personalization_appearance_context_v1>

custom treeland window global settings context

custom user treeland window appearance global

treeland_personalization_wallpaper_context_v1

version 1

client custom wallpaper context

This interface allows a client personalization wallpaper.

treeland_personalization_wallpaper_context_v1::set_fd

set_fd(fd: fd, metadata: string)

Argument	Type	Description
fd	fd	wallpaper file fd
metadata	string	file related metadata information

set the current user's wallpaper fd

treeland_personalization_wallpaper_context_v1::set_identifier

set_identifier(identifier: string)

Argument	Type	Description
identifier	string	Identifier for the application window

identifier for the application window

treeland_personalization_wallpaper_context_v1::set_output

set_output(output: string)

Argument	Type	Description
output	string	system output name

configure xdg desktop portal options

treeland_personalization_wallpaper_context_v1::set_on

set_on(options: uint<treeland_personalization_wallpaper_context_v1.options>)

Argument	Type	Description
options	uint<treeland_personalization_wallpaper_context_v1.options>	xdg desktop portal options

configure xdg desktop portal options

treeland_personalization_wallpaper_context_v1::set_isdark

set_isdark(isdark: uint)

Argument	Type	Description
isdark	uint	is dark

Set whether the current wallpaper is dark

treeland_personalization_wallpaper_context_v1::commit

commit()

commit configuration

treeland_personalization_wallpaper_context_v1::get_metadata

get_metadata()

get user save meta data

get the current user's wallpaper

treeland_personalization_wallpaper_context_v1::destroy

Type: destructor

destroy()

destroy the context object

Destroy the context object.

treeland_personalization_wallpaper_context_v1::metadata

metadata(metadata: string)

Argument	Type	Description
metadata	string	user meta data

get metadata event

Send this signal after getting the user's wallpaper.

treeland_personalization_wallpaper_context_v1::options

options { preview, background, lockscreen }

Argument	Value	Description
preview	1	whether to show a preview of the picture
background	2	configure screen background
lockscreen	4	configure screen wallpaper

xdg desktop portal supported keys

treeland_personalization_cursor_context_v1

version 1

client custom cursor context

This interface allows a client personalization cursor.

treeland_personalization_cursor_context_v1::set_theme

set_theme(name: string)

Argument	Type	Description
name	string	cursor theme name

set system cursor theme

treeland_personalization_cursor_context_v1::get_theme

get_theme()

get system cursor theme

treeland_personalization_cursor_context_v1::set_size

set_size(size: uint)

Argument	Type	Description
size	uint	cursor size

set system cursor size

treeland_personalization_cursor_context_v1::get_size

get_size()

get system cursor size

treeland_personalization_cursor_context_v1::commit

commit()

commit configure

if only one commit fails validation, the commit will fail

treeland_personalization_cursor_context_v1::destroy

Type: destructor

destroy()

destroy the context object

Destroy the context object.

treeland_personalization_cursor_context_v1::verfity

verfity(success: int)

Argument	Type	Description
success	int	check whether the configuration is successful

verfity event

Send this signal after commit cursor configure.

treeland_personalization_cursor_context_v1::theme

theme(name: string)

Argument	Type	Description
name	string	cursor theme name

cursor theme changed event

Send this signal after system cursor theme changed.

treeland_personalization_cursor_context_v1::size

size(size: uint)

Argument	Type	Description
size	uint	cursor size

cursor size changed event

Send this signal after system cursor size changed.

treeland_personalization_window_context_v1

version 1

client custom window context

This interface allows a client personalization window.

treeland_personalization_window_context_v1::set_blend_mode

set_blend_mode(mode: int<treeland_personalization_window_context_v1.window_blend_mode>)

Argument	Type	Description
mode	int<treeland_personalization_window_context_v1.window_blend_mode>

set window background blend mode

Set window background blend mode

treeland_personalization_window_context_v1::set_round_corner_radius

set_round_corner_radius(radius: int)

Argument	Type	Description
radius	int

set window round corner radius

This request will set window round corner radius, invoking this request means user want to manage window round corner radius by itself. If not invoked, window round corner radius will be decided by compositor.

treeland_personalization_window_context_v1::set_shadow

set_shadow(radius: int, offset_x: int, offset_y: int, r: int, g: int, b: int, a: int)

Argument	Type	Description
radius	int
offset_x	int
offset_y	int
r	int
g	int
b	int
a	int

set window shadow

Set window shadow's radius, offset and color, invoking this request indicates that client want to manage the window shadow by itself. If not invoked, window shadow will be decided by the compositor

treeland_personalization_window_context_v1::set_border

set_border(width: int, r: int, g: int, b: int, a: int)

Argument	Type	Description
width	int
r	int
g	int
b	int
a	int

set window border

Set window border width and color

treeland_personalization_window_context_v1::set_titlebar

set_titlebar(mode: int<treeland_personalization_window_context_v1.enable_mode>)

Argument	Type	Description
mode	int<treeland_personalization_window_context_v1.enable_mode>

set if system titlebar is enabled

Set if system titlebar is enabled

treeland_personalization_window_context_v1::destroy

Type: destructor

destroy()

destroy the context object

Destroy the context object.

treeland_personalization_window_context_v1::blend_mode

blend_mode { transparent, wallpaper, blur }

Argument	Value	Description
transparent	0	Normal blend mode, just composite over background with alpha channel
wallpaper	1	Composite window over wallpaper
blur	2	Blur the content of the window background

window blend mode

Window blend mode defines how compositor composite window's surface over other surfaces.

treeland_personalization_window_context_v1::enable_mode

enable_mode { enable, disable }

Argument	Value	Description
enable	0	force enable titlebar
disable	1	force disable titlebar

window enable mode

Set window enable mode

treeland_personalization_font_context_v1

version 1

treeland window global font settings

This interface allows set treeland window global font settings.

treeland_personalization_font_context_v1::set_font_size

set_font_size(size: uint)

Argument	Type	Description
size	uint	font size

set system font size

Set the system font size

treeland_personalization_font_context_v1::get_font_size

get_font_size()

get system font size

Get the system font size

treeland_personalization_font_context_v1::set_font

set_font(font_name: string)

Argument	Type	Description
font_name	string	font name

set system font

Set the system font

treeland_personalization_font_context_v1::get_font

get_font()

get system font

Get the system font

treeland_personalization_font_context_v1::set_monospace_font

set_monospace_font(font_name: string)

Argument	Type	Description
font_name	string	monospace font name

set system monospace font

Set the system monospace font

treeland_personalization_font_context_v1::get_monospace_font

get_monospace_font()

get system monospace font

Get the system monospace font

treeland_personalization_font_context_v1::destroy

Type: destructor

destroy()

destroy the context object

Destroy the context object.

treeland_personalization_font_context_v1::font

font(font_name: string)

Argument	Type	Description
font_name	string	font name

font event

Send this signal after setting the system font.

treeland_personalization_font_context_v1::monospace_font

monospace_font(font_name: string)

Argument	Type	Description
font_name	string	monospace font name

monospace font event

Send this signal after setting the system monospace font.

treeland_personalization_font_context_v1::font_size

font_size(font_size: uint)

Argument	Type	Description
font_size	uint	font size

font size

Send this signal after setting the system font size.

treeland_personalization_appearance_context_v1

version 1

treeland window global appearance settings

This interface allows set treeland window global appearance settings.

treeland_personalization_appearance_context_v1::set_round_corner_radius

set_round_corner_radius(radius: int)

Argument	Type	Description
radius	int

set window round corner radius

Set window round corner radius

treeland_personalization_appearance_context_v1::get_round_corner_radius

get_round_corner_radius()

get window round corner radius

Get window round corner radius

treeland_personalization_appearance_context_v1::set_icon_theme

set_icon_theme(theme: string)

Argument	Type	Description
theme	string	icon theme

set system icon theme

Set the system icon theme

treeland_personalization_appearance_context_v1::get_icon_theme

get_icon_theme()

get system icon theme

Get the system icon theme

treeland_personalization_appearance_context_v1::set_active_color

set_active_color(color: string)

Argument	Type	Description
color	string	rgb

set system active color

Set the system active color

treeland_personalization_appearance_context_v1::get_active_color

get_active_color()

get system active color

Get the system active color

treeland_personalization_appearance_context_v1::set_window_opacity

set_window_opacity(opacity: uint)

Argument	Type	Description
opacity	uint	opacity

set window window opacity

Set the window window opacity

treeland_personalization_appearance_context_v1::get_window_opacity

get_window_opacity()

get window window opacity

Get the window window opacity

treeland_personalization_appearance_context_v1::set_window_theme_type

set_window_theme_type(type: uint<treeland_personalization_appearance_context_v1.theme_type>)

Argument	Type	Description
type	uint<treeland_personalization_appearance_context_v1.theme_type>	window theme type

set window theme type

Set the window theme.

treeland_personalization_appearance_context_v1::get_window_theme_type

get_window_theme_type()

get window theme type

Get the window theme type

treeland_personalization_appearance_context_v1::set_window_titlebar_height

set_window_titlebar_height(height: uint)

Argument	Type	Description
height	uint	window titlebar height

set window titlebar height

Set the window titlebar height

treeland_personalization_appearance_context_v1::get_window_titlebar_height

get_window_titlebar_height()

get window titlebar height

Get the window titlebar height

treeland_personalization_appearance_context_v1::destroy

Type: destructor

destroy()

destroy the context object

Destroy the context object.

treeland_personalization_appearance_context_v1::round_corner_radius

round_corner_radius(radius: int)

Argument	Type	Description
radius	int	round corner radius

round corner radius event

Send this signal after setting the round corner radius.

treeland_personalization_appearance_context_v1::icon_theme

icon_theme(theme_name: string)

Argument	Type	Description
theme_name	string	icon theme name

icon theme event

Send this signal after setting the system icon theme.

treeland_personalization_appearance_context_v1::active_color

active_color(active_color: string)

Argument	Type	Description
active_color	string	active color

active color

Send this signal after setting the system active color

treeland_personalization_appearance_context_v1::window_opacity

window_opacity(opacity: uint)

Argument	Type	Description
opacity	uint	window opacity

window opacity

Send this signal after setting the system active color

treeland_personalization_appearance_context_v1::window_theme_type

window_theme_type(type: uint<treeland_personalization_appearance_context_v1.theme_type>)

Argument	Type	Description
type	uint<treeland_personalization_appearance_context_v1.theme_type>	window theme type

window theme

Send this signal after setting the system theme

treeland_personalization_appearance_context_v1::window_titlebar_height

window_titlebar_height(height: uint)

Argument	Type	Description
height	uint	window titlebar height

window titlebar height

Send this signal after setting the window titlebar height

treeland_personalization_appearance_context_v1::theme_type

theme_type { auto, light, dark }

Argument	Value	Description
auto	1	window auto theme
light	2	window light theme
dark	4	window dark theme

window theme type

treeland_personalization_appearance_context_v1::error

error { invalid_round_corner_radius, invalid_icon_theme, invalid_active_color, invalid_window_opacity, invalid_window_theme_type, invalid_window_titlebar_height }

Argument	Value	Description
invalid_round_corner_radius	0	Wrong round corner radius
invalid_icon_theme	1	Wrong icon theme
invalid_active_color	2	Wrong active color
invalid_window_opacity	4	Wrong window opacity
invalid_window_theme_type	8	Wrong theme type
invalid_window_titlebar_height	16	Wrong window titlebar height