awtk/docs/manual/window_manager_t.md

window_manager_t

概述

窗口管理器。

---

函数

函数名称	说明
window_manager	获取全局window_manager对象
window_manager_back	请求关闭顶层窗口。
window_manager_back_to_home	回到主窗口，关闭之上的全部窗口。
window_manager_cast	转换为window_manager对象(供脚本语言使用)。
window_manager_create	创建窗口管理器。
window_manager_get_top_main_window	获取最上面的主窗口。
window_manager_init	初始化窗口管理器。
window_manager_set	设置缺省的窗口管理器。
window_manager_set_cursor	设置鼠标指针。
window_manager_set_screen_saver_time	设置屏保时间。
window_manager_set_show_fps	设置是否显示FPS。

属性

属性名称	类型	说明
show_fps	bool_t	是否显示fps。

window_manager 函数

---

• 函数功能：

获取全局window_manager对象

• 函数原型：

widget_t* window_manager ();

• 参数说明：

参数	类型	说明
返回值	widget_t*	对象。

window_manager_back 函数

---

• 函数功能：

请求关闭顶层窗口。

• 函数原型：

ret_t window_manager_back (widget_t* widget);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	窗口管理器对象。

window_manager_back_to_home 函数

---

• 函数功能：

回到主窗口，关闭之上的全部窗口。

由于dialog通常需要用户确认，顶层窗口为dialog时调用会失败。

• 函数原型：

ret_t window_manager_back_to_home (widget_t* widget);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	窗口管理器对象。

window_manager_cast 函数

---

• 函数功能：

转换为window_manager对象(供脚本语言使用)。

• 函数原型：

widget_t* window_manager_cast (widget_t* widget);

• 参数说明：

参数	类型	说明
返回值	widget_t*	window_manager对象。
widget	widget_t*	window_manager对象。

window_manager_create 函数

---

• 函数功能：

创建窗口管理器。

• 函数原型：

window_manager_t* window_manager_create ();

• 参数说明：

参数	类型	说明
返回值	window_manager_t*	返回窗口管理器对象。

window_manager_get_top_main_window 函数

---

• 函数功能：

获取最上面的主窗口。

• 函数原型：

widget_t* window_manager_get_top_main_window (widget_t* widget);

• 参数说明：

参数	类型	说明
返回值	widget_t*	返回窗口对象。
widget	widget_t*	窗口管理器对象。

window_manager_init 函数

---

• 函数功能：

初始化窗口管理器。

• 函数原型：

widget_t* window_manager_init (window_manager_t* widget);

• 参数说明：

参数	类型	说明
返回值	widget_t*	返回窗口管理器对象。
widget	window_manager_t*	窗口管理器对象。

window_manager_set 函数

---

• 函数功能：

设置缺省的窗口管理器。

• 函数原型：

ret_t window_manager_set (window_manager_t* widget);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	window_manager_t*	窗口管理器对象。

window_manager_set_cursor 函数

---

• 函数功能：

设置鼠标指针。

• 函数原型：

ret_t window_manager_set_cursor (widget_t* widget, const char* cursor);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	窗口管理器对象。
cursor	const char*	图片名称(从图片管理器中加载)。

window_manager_set_screen_saver_time 函数

---

• 函数功能：

设置屏保时间。

• 函数原型：

ret_t window_manager_set_screen_saver_time (widget_t* widget, uint32_t screen_saver_time);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	窗口管理器对象。
screen_saver_time	uint32_t	屏保时间(单位毫秒)。

window_manager_set_show_fps 函数

---

• 函数功能：

设置是否显示FPS。

• 函数原型：

ret_t window_manager_set_show_fps (widget_t* widget, bool_t show_fps);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	窗口管理器对象。
show_fps	bool_t	是否显示FPS。

show_fps 属性

---

是否显示fps。

• 类型：bool_t

特性	是否支持
可直接读取	是
可直接修改	否
可脚本化	是