awtk/docs/manual/scroll_view_t.md

scroll_view_t

概述

滚动视图。

函数

函数名称	说明
scroll_view_cast	转换为scroll_view对象(供脚本语言使用)。
scroll_view_create	创建scroll_view对象
scroll_view_scroll_to	滚动到指定的偏移量。
scroll_view_set_offset	设置偏移量。
scroll_view_set_virtual_h	设置虚拟高度。
scroll_view_set_virtual_w	设置虚拟宽度。
scroll_view_set_xslidable	设置是否允许x方向滑动。
scroll_view_set_yslidable	设置是否允许y方向滑动。

属性

名属性称	类型	说明
virtual_h	wh_t	虚拟高度。
virtual_w	wh_t	虚拟宽度。
xoffset	int32_t	x偏移量。
xslidable	bool_t	是否允许x方向滑动。
yoffset	int32_t	y偏移量。
yslidable	bool_t	是否允许y方向滑动。

scroll_view_cast 函数

---

• 函数功能：

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

• 函数原型：

widget_t* scroll_view_cast (widget_t* widget);

• 参数说明：

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

scroll_view_create 函数

---

• 函数功能：

创建scroll_view对象

• 函数原型：

widget_t* scroll_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	高度

scroll_view_scroll_to 函数

---

• 函数功能：

滚动到指定的偏移量。

• 函数原型：

ret_t scroll_view_scroll_to (widget_t* widget, int32_t xoffset_end, int32_t yoffset_end, int32_t duration);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
xoffset_end	int32_t	x偏移量。
yoffset_end	int32_t	y偏移量。
duration	int32_t	时间。

scroll_view_set_offset 函数

---

• 函数功能：

设置偏移量。

• 函数原型：

ret_t scroll_view_set_offset (widget_t* widget, int32_t xoffset, int32_t yoffset);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
xoffset	int32_t	x偏移量。
yoffset	int32_t	y偏移量。

scroll_view_set_virtual_h 函数

---

• 函数功能：

设置虚拟高度。

• 函数原型：

ret_t scroll_view_set_virtual_h (widget_t* widget, wh_t h);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
h	wh_t	虚拟高度。

scroll_view_set_virtual_w 函数

---

• 函数功能：

设置虚拟宽度。

• 函数原型：

ret_t scroll_view_set_virtual_w (widget_t* widget, wh_t w);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
w	wh_t	虚拟宽度。

scroll_view_set_xslidable 函数

---

• 函数功能：

设置是否允许x方向滑动。

• 函数原型：

ret_t scroll_view_set_xslidable (widget_t* widget, bool_t xslidable);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
xslidable	bool_t	是否允许滑动。

scroll_view_set_yslidable 函数

---

• 函数功能：

设置是否允许y方向滑动。

• 函数原型：

ret_t scroll_view_set_yslidable (widget_t* widget, bool_t yslidable);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
yslidable	bool_t	是否允许滑动。

virtual_h 属性

---

虚拟高度。

• 类型：wh_t

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

virtual_w 属性

---

虚拟宽度。

• 类型：wh_t

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

xoffset 属性

---

x偏移量。

• 类型：int32_t

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

xslidable 属性

---

是否允许x方向滑动。

• 类型：bool_t

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

yoffset 属性

---

y偏移量。

• 类型：int32_t

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

yslidable 属性

---

是否允许y方向滑动。

• 类型：bool_t

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