awtk/docs/manual/slide_view_t.md

slide_view_t

概述

slide view。

函数

函数名称	说明
slide_view_cast	转换为slide_view对象(供脚本语言使用)。
slide_view_create	创建slide_view对象
slide_view_set_active	设置当前页的序号。
slide_view_set_auto_play	设置为自动播放模式。
slide_view_set_vertical	设置为上下滑动(缺省为左右滑动)。

属性

名属性称	类型	说明
auto_play	uint16_t	自动播放。0表示禁止自动播放，非0表示自动播放时每一页播放的时间。
vertical	bool_t	是否为上下滑动模式。

事件

事件名称	类型	说明
EVT_VALUE_WILL_CHANGE	event_t	值(当前页)即将改变事件。
EVT_VALUE_CHANGED	event_t	值(当前页)改变事件。

slide_view_cast 函数

---

• 函数功能：

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

• 函数原型：

widget_t* slide_view_cast (widget_t* widget);

• 参数说明：

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

slide_view_create 函数

---

• 函数功能：

创建slide_view对象

• 函数原型：

widget_t* slide_view_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);

• 参数说明：

参数	类型	说明
返回值	widget_t*	对象。
parent	widget_t*	父控件
x	xy_t	x坐标
y	xy_t	y坐标
w	wh_t	宽度
h	wh_t	高度

slide_view_set_active 函数

---

• 函数功能：

设置当前页的序号。

• 函数原型：

ret_t slide_view_set_active (widget_t* widget, uint32_t index);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	slide_view对象。
index	uint32_t	当前页的序号。

slide_view_set_auto_play 函数

---

• 函数功能：

设置为自动播放模式。

• 函数原型：

ret_t slide_view_set_auto_play (widget_t* widget, uint16_t auto_play);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	slide_view对象。
auto_play	uint16_t	0表示禁止自动播放，非0表示自动播放时每一页播放的时间。

slide_view_set_vertical 函数

---

• 函数功能：

设置为上下滑动(缺省为左右滑动)。

• 函数原型：

ret_t slide_view_set_vertical (widget_t* widget, bool_t vertical);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	slide_view对象。
vertical	bool_t	TRUE表示上下滑动，FALSE表示左右滑动。

auto_play 属性

---

自动播放。0表示禁止自动播放，非0表示自动播放时每一页播放的时间。

• 类型：uint16_t

特性	是否支持
可直接读取	是
可直接修改	否
可持久化	是
可脚本化	是
可在IDE中设置	是
可在XML中设置	是
可通过widget_get_prop读取	是
可通过widget_set_prop修改	是

vertical 属性

---

是否为上下滑动模式。

• 类型：bool_t

特性	是否支持
可直接读取	是
可直接修改	否
可持久化	是
可脚本化	是
可在IDE中设置	是
可在XML中设置	是
可通过widget_get_prop读取	是
可通过widget_set_prop修改	是