awtk/docs/manual/list_view_t.md

list_view_t

概述

ListView控件。

函数

函数名称	说明
list_view_cast	转换为list_view对象(供脚本语言使用)。
list_view_create	创建list_view对象
list_view_set_auto_hide_scroll_bar	设置是否自动隐藏滚动条。
list_view_set_default_item_height	设置列表项的缺省高度。
list_view_set_item_height	设置列表项的高度。

属性

名属性称	类型	说明
auto_hide_scroll_bar	bool_t	如果不需要滚动条时，自动隐藏滚动条。
default_item_height	int32_t	列表项的缺省高度。如果item_height <= 0 而且列表项自身的高度 <= 0，则使用缺省高度。
item_height	int32_t	列表项的高度。如果 item_height > 0，所有列表项使用固定高度，否则使用列表项自身的高度。

事件

事件名称	类型	说明

list_view_cast 函数

---

• 函数功能：

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

• 函数原型：

widget_t* list_view_cast (widget_t* widget);

• 参数说明：

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

list_view_create 函数

---

• 函数功能：

创建list_view对象

• 函数原型：

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

list_view_set_auto_hide_scroll_bar 函数

---

• 函数功能：

设置是否自动隐藏滚动条。

• 函数原型：

ret_t list_view_set_auto_hide_scroll_bar (widget_t* widget, bool_t auto_hide_scroll_bar);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
auto_hide_scroll_bar	bool_t	列表项的高度。

list_view_set_default_item_height 函数

---

• 函数功能：

设置列表项的缺省高度。

• 函数原型：

ret_t list_view_set_default_item_height (widget_t* widget, int32_t default_item_height);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
default_item_height	int32_t	列表项的高度。

list_view_set_item_height 函数

---

• 函数功能：

设置列表项的高度。

• 函数原型：

ret_t list_view_set_item_height (widget_t* widget, int32_t item_height);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
item_height	int32_t	列表项的高度。

auto_hide_scroll_bar 属性

---

如果不需要滚动条时，自动隐藏滚动条。

• 类型：bool_t

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

default_item_height 属性

---

列表项的缺省高度。如果item_height <= 0 而且列表项自身的高度 <= 0，则使用缺省高度。

• 类型：int32_t

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

item_height 属性

---

列表项的高度。如果 item_height > 0，所有列表项使用固定高度，否则使用列表项自身的高度。

• 类型：int32_t

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