Treeland personalization manager

treeland_personalization_manager_v1

版本 1

个性化管理器

此接口允许客户端自定义显示效果。

警告！此文件中描述的协议目前处于测试阶段。可能会在相应的接口版本更新中添加向后兼容的更改。向后不兼容的更改只能通过创建新的扩展主版本来完成。

treeland_personalization_manager_v1::get_window_context

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

参数	类型	描述
id	new_id<treeland_personalization_window_context_v1>
surface	object<wl_surface>

获取个性化窗口上下文

根据上下文设置窗口背景和阴影

treeland_personalization_manager_v1::get_wallpaper_context

get_wallpaper_context(id: new_id<treeland_personalization_wallpaper_context_v1>)

参数	类型	描述
id	new_id<treeland_personalization_wallpaper_context_v1>

自定义壁纸上下文

自定义用户壁纸

treeland_personalization_manager_v1::get_cursor_context

get_cursor_context(id: new_id<treeland_personalization_cursor_context_v1>)

参数	类型	描述
id	new_id<treeland_personalization_cursor_context_v1>

自定义光标上下文

自定义用户光标

treeland_personalization_manager_v1::get_font_context

get_font_context(id: new_id<treeland_personalization_font_context_v1>)

参数	类型	描述
id	new_id<treeland_personalization_font_context_v1>

自定义 treeland 和窗口全局字体上下文

treeland_personalization_manager_v1::get_appearance_context

get_appearance_context(id: new_id<treeland_personalization_appearance_context_v1>)

参数	类型	描述
id	new_id<treeland_personalization_appearance_context_v1>

自定义 treeland 窗口全局设置上下文

自定义用户 treeland 窗口外观全局设置

treeland_personalization_wallpaper_context_v1

版本 1

客户端自定义壁纸上下文

此接口允许客户端个性化壁纸。

treeland_personalization_wallpaper_context_v1::set_fd

set_fd(fd: fd, metadata: string)

参数	类型	描述
fd	fd	wallpaper file fd
metadata	string	file related metadata information

设置当前用户的壁纸文件描述符

treeland_personalization_wallpaper_context_v1::set_identifier

set_identifier(identifier: string)

参数	类型	描述
identifier	string	Identifier for the application window

应用程序窗口的标识符

treeland_personalization_wallpaper_context_v1::set_output

set_output(output: string)

参数	类型	描述
output	string	system output name

配置 xdg desktop portal 选项

treeland_personalization_wallpaper_context_v1::set_on

set_on(options: uint<treeland_personalization_wallpaper_context_v1.options>)

参数	类型	描述
options	uint<treeland_personalization_wallpaper_context_v1.options>	xdg desktop portal options

配置 xdg desktop portal 选项

treeland_personalization_wallpaper_context_v1::set_isdark

set_isdark(isdark: uint)

参数	类型	描述
isdark	uint	is dark

设置当前壁纸是否为暗色

treeland_personalization_wallpaper_context_v1::commit

commit()

提交配置

treeland_personalization_wallpaper_context_v1::get_metadata

get_metadata()

获取用户保存的元数据

获取当前用户的壁纸

treeland_personalization_wallpaper_context_v1::destroy

类型: destructor

destroy()

销毁上下文对象

销毁上下文对象。

treeland_personalization_wallpaper_context_v1::metadata

metadata(metadata: string)

参数	类型	描述
metadata	string	user meta data

获取元数据事件

获取用户壁纸后发送此信号。

treeland_personalization_wallpaper_context_v1::options

options { preview, background, lockscreen }

参数	值	描述
preview	1	是否显示图片预览
background	2	配置屏幕背景
lockscreen	4	配置锁屏壁纸

xdg desktop portal 支持的键

treeland_personalization_cursor_context_v1

版本 1

客户端自定义光标上下文

此接口允许客户端个性化光标。

treeland_personalization_cursor_context_v1::set_theme

set_theme(name: string)

参数	类型	描述
name	string	cursor theme name

设置系统光标主题

treeland_personalization_cursor_context_v1::get_theme

get_theme()

获取系统光标主题

treeland_personalization_cursor_context_v1::set_size

set_size(size: uint)

参数	类型	描述
size	uint	cursor size

设置系统光标大小

treeland_personalization_cursor_context_v1::get_size

get_size()

获取系统光标大小

treeland_personalization_cursor_context_v1::commit

commit()

提交配置

如果仅有一个提交未通过验证，该提交将失败

treeland_personalization_cursor_context_v1::destroy

类型: destructor

destroy()

销毁上下文对象

销毁上下文对象。

treeland_personalization_cursor_context_v1::verfity

verfity(success: int)

参数	类型	描述
success	int	check whether the configuration is successful

验证事件

提交光标配置后发送此信号。

treeland_personalization_cursor_context_v1::theme

theme(name: string)

参数	类型	描述
name	string	cursor theme name

光标主题变更事件

系统光标主题更改后发送此信号。

treeland_personalization_cursor_context_v1::size

size(size: uint)

参数	类型	描述
size	uint	cursor size

光标大小变更事件

系统光标大小更改后发送此信号。

treeland_personalization_window_context_v1

版本 1

客户端自定义窗口上下文

此接口允许客户端个性化窗口。

treeland_personalization_window_context_v1::set_blend_mode

set_blend_mode(mode: int<treeland_personalization_window_context_v1.blend_mode>)

参数	类型	描述
mode	int<treeland_personalization_window_context_v1.blend_mode>

设置窗口背景混合模式

treeland_personalization_window_context_v1::set_round_corner_radius

set_round_corner_radius(radius: int)

参数	类型	描述
radius	int

设置窗口圆角半径

此请求设置窗口圆角半径，调用此请求表示用户希望自行管理窗口圆角半径。如果未调用，窗口圆角半径将由合成器决定。

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)

参数	类型	描述
radius	int
offset_x	int
offset_y	int
r	int
g	int
b	int
a	int

设置窗口阴影

设置窗口阴影的半径、偏移和颜色，调用此请求表示客户端希望自行管理窗口阴影。如果未调用，窗口阴影将由合成器决定。

treeland_personalization_window_context_v1::set_border

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

参数	类型	描述
width	int
r	int
g	int
b	int
a	int

设置窗口边框

设置窗口边框宽度和颜色

treeland_personalization_window_context_v1::set_titlebar

set_titlebar(mode: int<treeland_personalization_window_context_v1.enable_mode>)

参数	类型	描述
mode	int<treeland_personalization_window_context_v1.enable_mode>

设置是否启用系统标题栏

treeland_personalization_window_context_v1::destroy

类型: destructor

destroy()

销毁上下文对象

销毁上下文对象。

treeland_personalization_window_context_v1::blend_mode

blend_mode { transparent, wallpaper, blur }

参数	值	描述
transparent	0	普通混合模式，仅使用 alpha 通道将窗口合成到背景之上
wallpaper	1	将窗口合成到壁纸之上
blur	2	模糊窗口背景的内容

窗口混合模式

窗口混合模式定义合成器如何将窗口表面合成到其他表面之上。

treeland_personalization_window_context_v1::enable_mode

enable_mode { enable, disable }

参数	值	描述
enable	0	强制启用标题栏
disable	1	强制禁用标题栏

窗口启用模式

设置窗口启用模式

treeland_personalization_font_context_v1

版本 1

treeland 窗口全局字体设置

此接口允许设置 treeland 窗口全局字体设置。

treeland_personalization_font_context_v1::set_font_size

set_font_size(size: uint)

参数	类型	描述
size	uint	font size

设置系统字体大小

treeland_personalization_font_context_v1::get_font_size

get_font_size()

获取系统字体大小

treeland_personalization_font_context_v1::set_font

set_font(font_name: string)

参数	类型	描述
font_name	string	font name

设置系统字体

treeland_personalization_font_context_v1::get_font

get_font()

获取系统字体

treeland_personalization_font_context_v1::set_monospace_font

set_monospace_font(font_name: string)

参数	类型	描述
font_name	string	monospace font name

设置系统等宽字体

treeland_personalization_font_context_v1::get_monospace_font

get_monospace_font()

获取系统等宽字体

treeland_personalization_font_context_v1::destroy

类型: destructor

destroy()

销毁上下文对象

销毁上下文对象。

treeland_personalization_font_context_v1::font

font(font_name: string)

参数	类型	描述
font_name	string	font name

字体事件

设置系统字体后发送此信号。

treeland_personalization_font_context_v1::monospace_font

monospace_font(font_name: string)

参数	类型	描述
font_name	string	monospace font name

等宽字体事件

设置系统等宽字体后发送此信号。

treeland_personalization_font_context_v1::font_size

font_size(font_size: uint)

参数	类型	描述
font_size	uint	font size

字体大小事件

设置系统字体大小后发送此信号。

treeland_personalization_appearance_context_v1

版本 1

treeland 窗口全局外观设置

此接口允许设置 treeland 窗口全局外观设置。

treeland_personalization_appearance_context_v1::set_round_corner_radius

set_round_corner_radius(radius: int)

参数	类型	描述
radius	int

设置窗口圆角半径

treeland_personalization_appearance_context_v1::get_round_corner_radius

get_round_corner_radius()

获取窗口圆角半径

treeland_personalization_appearance_context_v1::set_icon_theme

set_icon_theme(theme: string)

参数	类型	描述
theme	string	icon theme

设置系统图标主题

treeland_personalization_appearance_context_v1::get_icon_theme

get_icon_theme()

获取系统图标主题

treeland_personalization_appearance_context_v1::set_active_color

set_active_color(color: string)

参数	类型	描述
color	string	rgb

设置系统活跃颜色

treeland_personalization_appearance_context_v1::get_active_color

get_active_color()

获取系统活跃颜色

treeland_personalization_appearance_context_v1::set_window_opacity

set_window_opacity(opacity: uint)

参数	类型	描述
opacity	uint	opacity

设置窗口不透明度

treeland_personalization_appearance_context_v1::get_window_opacity

get_window_opacity()

获取窗口不透明度

treeland_personalization_appearance_context_v1::set_window_theme_type

set_window_theme_type(type: uint<treeland_personalization_appearance_context_v1.theme_type>)

参数	类型	描述
type	uint<treeland_personalization_appearance_context_v1.theme_type>	window theme type

设置窗口主题类型

设置窗口主题

treeland_personalization_appearance_context_v1::get_window_theme_type

get_window_theme_type()

获取窗口主题类型

treeland_personalization_appearance_context_v1::set_window_titlebar_height

set_window_titlebar_height(height: uint)

参数	类型	描述
height	uint	window titlebar height

设置窗口标题栏高度

treeland_personalization_appearance_context_v1::get_window_titlebar_height

get_window_titlebar_height()

获取窗口标题栏高度

treeland_personalization_appearance_context_v1::destroy

类型: destructor

destroy()

销毁上下文对象

销毁上下文对象。

treeland_personalization_appearance_context_v1::round_corner_radius

round_corner_radius(radius: int)

参数	类型	描述
radius	int	round corner radius

圆角半径事件

设置圆角半径后发送此信号。

treeland_personalization_appearance_context_v1::icon_theme

icon_theme(theme_name: string)

参数	类型	描述
theme_name	string	icon theme name

图标主题事件

设置系统图标主题后发送此信号。

treeland_personalization_appearance_context_v1::active_color

active_color(active_color: string)

参数	类型	描述
active_color	string	active color

活跃颜色事件

设置系统活跃颜色后发送此信号。

treeland_personalization_appearance_context_v1::window_opacity

window_opacity(opacity: uint)

参数	类型	描述
opacity	uint	window opacity

窗口不透明度事件

设置系统活跃颜色后发送此信号。

treeland_personalization_appearance_context_v1::window_theme_type

window_theme_type(type: uint<treeland_personalization_appearance_context_v1.theme_type>)

参数	类型	描述
type	uint<treeland_personalization_appearance_context_v1.theme_type>	window theme type

窗口主题事件

设置系统主题后发送此信号。

treeland_personalization_appearance_context_v1::window_titlebar_height

window_titlebar_height(height: uint)

参数	类型	描述
height	uint	window titlebar height

窗口标题栏高度事件

设置窗口标题栏高度后发送此信号。

treeland_personalization_appearance_context_v1::theme_type

theme_type { auto, light, dark }

参数	值	描述
auto	1	窗口自动主题
light	2	窗口浅色主题
dark	4	窗口深色主题

窗口主题类型

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 }

参数	值	描述
invalid_round_corner_radius	0	错误的圆角半径
invalid_icon_theme	1	错误的图标主题
invalid_active_color	2	错误的活跃颜色
invalid_window_opacity	4	错误的窗口不透明度
invalid_window_theme_type	8	错误的主题类型
invalid_window_titlebar_height	16	错误的窗口标题栏高度