mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-11 01:25:06 +08:00
11 KiB
11 KiB
progress_bar_t
概述
进度条控件。
进度条控件可以水平显示也可以垂直显示,由vertical属性决定。
progress_bar_t是widget_t的子类控件,widget_t的函数均适用于progress_bar_t控件。
在xml中使用"progress_bar"标签创建进度条控件。如:
<progress_bar name="bar1" x="10" y="128" w="240" h="30" value="40"/>
<progress_bar name="bar2" x="280" y="128" w="30" h="118" value="20" vertical="true"/>
更多用法请参考: basic demo
在c代码中使用函数progress_bar_create创建进度条控件。如:
widget_t* progress_bar = progress_bar_create(win, 10, 10, 128, 30);
完整示例请参考: progress_bar demo
可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:
<style>
<normal bg_color="#f0f0f0" text_color="gold" fg_color="#c0c0c0" border_color="#a0a0a0" />
</style>
更多用法请参考: theme default
函数
函数名称 | 说明 |
---|---|
progress_bar_cast | 转换为progress_bar对象(供脚本语言使用)。 |
progress_bar_create | 创建progress_bar对象 |
progress_bar_get_percent | 获取进度百分比。 |
progress_bar_get_widget_vtable | 获取 progress_bar 虚表。 |
progress_bar_set_format | 设置格式。 |
progress_bar_set_max | 设置最大值。 |
progress_bar_set_reverse | 设置进度条是否反向。 |
progress_bar_set_show_text | 设置进度条的是否显示文本。 |
progress_bar_set_value | 设置进度条的进度。 |
progress_bar_set_vertical | 设置进度条的方向。 |
属性
属性名称 | 类型 | 说明 |
---|---|---|
format | char* | 数值到字符串转换时的格式,缺省为"%d"。 |
max | double | 最大值(缺省为100)。 |
reverse | bool_t | 是否反向显示。如果为TRUE,水平方向从右向左表示增加,垂直方向从上到下表示增加。 |
show_text | bool_t | 是否显示文本。 |
value | double | 进度条的值[0-max]。 |
vertical | bool_t | 进度条的是否为垂直方向。 |
事件
事件名称 | 类型 | 说明 |
---|---|---|
EVT_VALUE_WILL_CHANGE | value_change_event_t | 值即将改变事件。 |
EVT_VALUE_CHANGED | value_change_event_t | 值改变事件。 |
progress_bar_cast 函数
- 函数功能:
转换为progress_bar对象(供脚本语言使用)。
- 函数原型:
widget_t* progress_bar_cast (widget_t* widget);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | widget_t* | progress_bar对象。 |
widget | widget_t* | progress_bar对象。 |
progress_bar_create 函数
- 函数功能:
创建progress_bar对象
- 函数原型:
widget_t* progress_bar_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 | 高度 |
progress_bar_get_percent 函数
- 函数功能:
获取进度百分比。
当max为100时,percent和value取整后一致。
- 函数原型:
uint32_t progress_bar_get_percent (widget_t* widget);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | uint32_t | 返回百分比。 |
widget | widget_t* | 控件对象。 |
progress_bar_get_widget_vtable 函数
- 函数功能:
获取 progress_bar 虚表。
- 函数原型:
const widget_vtable_t* progress_bar_get_widget_vtable ();
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | const widget_vtable_t* | 成功返回 progress_bar 虚表。 |
progress_bar_set_format 函数
- 函数功能:
设置格式。
- 函数原型:
ret_t progress_bar_set_format (widget_t* widget, const char* format);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | ret_t | 返回RET_OK表示成功,否则表示失败。 |
widget | widget_t* | progress_bar对象。 |
format | const char* | 格式。 |
progress_bar_set_max 函数
- 函数功能:
设置最大值。
- 函数原型:
ret_t progress_bar_set_max (widget_t* widget, double max);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | ret_t | 返回RET_OK表示成功,否则表示失败。 |
widget | widget_t* | 控件对象。 |
max | double | 最大值。 |
progress_bar_set_reverse 函数
- 函数功能:
设置进度条是否反向。
- 函数原型:
ret_t progress_bar_set_reverse (widget_t* widget, bool_t reverse);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | ret_t | 返回RET_OK表示成功,否则表示失败。 |
widget | widget_t* | 控件对象。 |
reverse | bool_t | 是否反向。 |
progress_bar_set_show_text 函数
- 函数功能:
设置进度条的是否显示文本。
- 函数原型:
ret_t progress_bar_set_show_text (widget_t* widget, bool_t show_text);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | ret_t | 返回RET_OK表示成功,否则表示失败。 |
widget | widget_t* | 控件对象。 |
show_text | bool_t | 是否显示文本。 |
progress_bar_set_value 函数
- 函数功能:
设置进度条的进度。
- 函数原型:
ret_t progress_bar_set_value (widget_t* widget, double value);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | ret_t | 返回RET_OK表示成功,否则表示失败。 |
widget | widget_t* | 控件对象。 |
value | double | 进度 |
progress_bar_set_vertical 函数
- 函数功能:
设置进度条的方向。
- 函数原型:
ret_t progress_bar_set_vertical (widget_t* widget, bool_t vertical);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | ret_t | 返回RET_OK表示成功,否则表示失败。 |
widget | widget_t* | 控件对象。 |
vertical | bool_t | 是否为垂直方向。 |
format 属性
数值到字符串转换时的格式,缺省为"%d"。
- 类型:char*
特性 | 是否支持 |
---|---|
可直接读取 | 是 |
可直接修改 | 否 |
可持久化 | 是 |
可脚本化 | 是 |
可在IDE中设置 | 是 |
可在XML中设置 | 是 |
可通过widget_get_prop读取 | 是 |
可通过widget_set_prop修改 | 是 |
max 属性
最大值(缺省为100)。
- 类型:double
特性 | 是否支持 |
---|---|
可直接读取 | 是 |
可直接修改 | 否 |
可持久化 | 是 |
可脚本化 | 是 |
可在IDE中设置 | 是 |
可在XML中设置 | 是 |
可通过widget_get_prop读取 | 是 |
可通过widget_set_prop修改 | 是 |
reverse 属性
是否反向显示。如果为TRUE,水平方向从右向左表示增加,垂直方向从上到下表示增加。
- 类型:bool_t
特性 | 是否支持 |
---|---|
可直接读取 | 是 |
可直接修改 | 否 |
可持久化 | 是 |
可脚本化 | 是 |
可在IDE中设置 | 是 |
可在XML中设置 | 是 |
可通过widget_get_prop读取 | 是 |
可通过widget_set_prop修改 | 是 |
show_text 属性
是否显示文本。
- 类型:bool_t
特性 | 是否支持 |
---|---|
可直接读取 | 是 |
可直接修改 | 否 |
可持久化 | 是 |
可脚本化 | 是 |
可在IDE中设置 | 是 |
可在XML中设置 | 是 |
可通过widget_get_prop读取 | 是 |
可通过widget_set_prop修改 | 是 |
value 属性
进度条的值[0-max]。
- 类型:double
特性 | 是否支持 |
---|---|
可直接读取 | 是 |
可直接修改 | 否 |
可持久化 | 是 |
可脚本化 | 是 |
可在IDE中设置 | 是 |
可在XML中设置 | 是 |
可通过widget_get_prop读取 | 是 |
可通过widget_set_prop修改 | 是 |
vertical 属性
进度条的是否为垂直方向。
- 类型:bool_t
特性 | 是否支持 |
---|---|
可直接读取 | 是 |
可直接修改 | 否 |
可持久化 | 是 |
可脚本化 | 是 |
可在IDE中设置 | 是 |
可在XML中设置 | 是 |
可通过widget_get_prop读取 | 是 |
可通过widget_set_prop修改 | 是 |