awtk/docs/manual/list_view_t.md

list_view_t

概述

列表视图控件。

列表视图控件是一个可以垂直滚动的列表控件。

如果不需要滚动，可以用view控件配置适当的layout参数作为列表控件。

列表视图中的列表项可以固定高度，也可以使用不同高度。请参考变高列表项

列表视图控件的中可以有滚动条，也可以没有滚动条。 可以使用移动设备风格的滚动条，也可以使用桌面风格的滚动条。

list_view_t是widget_t的子类控件，widget_t的函数均适用于list_view_t控件。

在xml中使用"list_view"标签创建列表视图控件。如：

<list_view x="0"  y="30" w="100%" h="-80" item_height="60">
<scroll_view name="view" x="0"  y="0" w="100%" h="100%">
<list_item style="odd" children_layout="default(rows=1,cols=0)">
<image draw_type="icon" w="30" image="earth"/>
<label w="-30" text="1.Hello AWTK !">
<switch x="r:10" y="m" w="60" h="20"/>
</label>
</list_item>
...
</scroll_view>
</list_view>

注意：列表项不是作为列表视图控件的直接子控件，而是作为滚动视图的子控件。

更多用法请参考：list_view_m.xml

在c代码中使用函数list_view_create创建列表视图控件。如：

widget_t* list_view = list_view_create(win, 0, 0, 0, 0);

用代码构造列表视图是比较繁琐的事情，最好用XML来构造。 如果需要动态修改，可以使用widget_clone来增加列表项，使用widget_remove_child来移出列表项。

可用通过style来设置控件的显示风格，如背景颜色和边框颜色等(一般情况不需要)。

备注：list_view 下的 scroll_view 控件不支持遍历所有子控件的效果。

下面是针对 scroll_bar_d （桌面版）有效果，scroll_bar_m（移动版）没有效果。 如果 floating_scroll_bar 属性为 TRUE 和 auto_hide_scroll_bar 属性为 TRUE， 如果 scroll_view 的高比虚拟高要小的话，鼠标在 list_view 上滚动条才显示，鼠标移开的就自动隐藏，scroll_view 宽为控件宽度。 如果 floating_scroll_bar 属性为 TRUE 和 auto_hide_scroll_bar 属性为 FALSE ，如果 scroll_view 的高比虚拟高要大的话，滚动条变成不可见，如果 scroll_view 的高比虚拟高要小的话，滚动条固定显示（不管鼠标是否悬停），scroll_view 宽为控件宽度。 如果 floating_scroll_bar 属性为 FALSE 和 auto_hide_scroll_bar 属性为 FALSE，如果 scroll_view 的高比虚拟高要大的话，滚动条变成不可用（滚动条固定显示，不管鼠标是否悬停），scroll_view 宽不会变。 如果 floating_scroll_bar 属性为 FALSE 和 auto_hide_scroll_bar 属性为 TRUE，如果 scroll_view 的高比虚拟高要大的话，滚动条变成不可见，scroll_view 宽会合并原来滚动条的宽，如果 scroll_view 的高比虚拟高要小的话，滚动条固定显示（不管鼠标是否悬停），scroll_view 宽会变为 list_view 宽度减去滚动条宽度。

函数

函数名称	说明
list_view_cast	转换为list_view对象(供脚本语言使用)。
list_view_create	创建list_view对象
list_view_get_widget_vtable	获取 list_view 虚表。
list_view_reinit	list_view重新初始化。
list_view_set_auto_hide_scroll_bar	设置是否自动隐藏滚动条。
list_view_set_default_item_height	设置列表项的缺省高度。
list_view_set_floating_scroll_bar	设置滚动条是否悬浮在 scroll_view 上面。
list_view_set_item_height	设置列表项的高度。

属性

属性名称	类型	说明
auto_hide_scroll_bar	bool_t	如果不需要滚动条时，自动隐藏滚动条。
default_item_height	int32_t	列表项的缺省高度。如果item_height <= 0 而且列表项自身的高度 <= 0，则使用缺省高度。
floating_scroll_bar	bool_t	滚动条是否悬浮在 scroll_view 上面
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_get_widget_vtable 函数

---

• 函数功能：

获取 list_view 虚表。

• 函数原型：

const widget_vtable_t* list_view_get_widget_vtable ();

• 参数说明：

参数	类型	说明
返回值	const widget_vtable_t*	成功返回 list_view 虚表。

list_view_reinit 函数

---

• 函数功能：

list_view重新初始化。

• 函数原型：

ret_t list_view_reinit (widget_t* widget);

• 参数说明：

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

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_floating_scroll_bar 函数

---

• 函数功能：

设置滚动条是否悬浮在 scroll_view 上面。

• 函数原型：

ret_t list_view_set_floating_scroll_bar (widget_t* widget, bool_t floating_scroll_bar);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	控件对象。
floating_scroll_bar	bool_t	滚动条是否悬浮在 scroll_view 上面。

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修改	是

floating_scroll_bar 属性

---

滚动条是否悬浮在 scroll_view 上面

• 类型：bool_t

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

item_height 属性

---

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

• 类型：int32_t

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