## progress\_circle\_t
### 概述
![image](images/progress_circle_t_0.png)
进度圆环控件。
progress\_circle\_t是[widget\_t](widget_t.md)的子类控件,widget\_t的函数均适用于progress\_circle\_t控件。
在xml中使用"progress\_circle"标签创建进度圆环控件。如:
```xml
| 函数名称 | 说明 | | -------- | ------------ | | progress\_circle\_cast | 转换为progress_circle对象(供脚本语言使用)。 | | progress\_circle\_create | 创建progress_circle对象 | | progress\_circle\_set\_counter\_clock\_wise | 设置是否为逆时针方向。 | | progress\_circle\_set\_line\_width | 设置环线的厚度。 | | progress\_circle\_set\_max | 设置最大值。 | | progress\_circle\_set\_show\_text | 设置是否显示文本。 | | progress\_circle\_set\_start\_angle | 设置起始角度。 | | progress\_circle\_set\_unit | 设置单位。 | | progress\_circle\_set\_value | 设置值。 | ### 属性
| 名属性称 | 类型 | 说明 | | -------- | ----- | ------------ | | counter\_clock\_wise | bool\_t | 是否为逆时针方向(缺省为FALSE)。 | | line\_width | uint32\_t | 环线的厚度(缺省为8)。 | | max | uint32\_t | 最大值(缺省为100)。 | | show\_text | bool\_t | 是否显示文本(缺省为TRUE)。 | | start\_angle | int32\_t | 起始角度(单位为度,缺省-90)。 | | unit | char* | 单元(缺省无)。 | | value | float\_t | 值(缺省为0)。 | ### 事件
| 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 | #### progress\_circle\_cast 函数 ----------------------- * 函数功能: >
转换为progress_circle对象(供脚本语言使用)。 * 函数原型: ``` widget_t* progress_circle_cast (widget_t* widget); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | progress\_circle对象。 | | widget | widget\_t* | progress\_circle对象。 | #### progress\_circle\_create 函数 ----------------------- * 函数功能: >
创建progress_circle对象 * 函数原型: ``` widget_t* progress_circle_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\_circle\_set\_counter\_clock\_wise 函数 ----------------------- * 函数功能: >
设置是否为逆时针方向。 * 函数原型: ``` ret_t progress_circle_set_counter_clock_wise (widget_t* widget, bool_t counter_clock_wise); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | counter\_clock\_wise | bool\_t | 是否为逆时针方向。 | #### progress\_circle\_set\_line\_width 函数 ----------------------- * 函数功能: >
设置环线的厚度。 * 函数原型: ``` ret_t progress_circle_set_line_width (widget_t* widget, uint32_t line_width); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | line\_width | uint32\_t | 环线的厚度。 | #### progress\_circle\_set\_max 函数 ----------------------- * 函数功能: >
设置最大值。 * 函数原型: ``` ret_t progress_circle_set_max (widget_t* widget, uint32_t max); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | max | uint32\_t | 最大值。 | #### progress\_circle\_set\_show\_text 函数 ----------------------- * 函数功能: >
设置是否显示文本。 * 函数原型: ``` ret_t progress_circle_set_show_text (widget_t* widget, bool_t show_text); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | show\_text | bool\_t | 是否显示文本。 | #### progress\_circle\_set\_start\_angle 函数 ----------------------- * 函数功能: >
设置起始角度。 * 函数原型: ``` ret_t progress_circle_set_start_angle (widget_t* widget, int32_t start_angle); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | start\_angle | int32\_t | 起始角度。 | #### progress\_circle\_set\_unit 函数 ----------------------- * 函数功能: >
设置单位。 * 函数原型: ``` ret_t progress_circle_set_unit (widget_t* widget, const char* unit); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | unit | const char* | 单位。 | #### progress\_circle\_set\_value 函数 ----------------------- * 函数功能: >
设置值。 * 函数原型: ``` ret_t progress_circle_set_value (widget_t* widget, float_t value); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | value | float\_t | 值。 | #### counter\_clock\_wise 属性 ----------------------- >
是否为逆时针方向(缺省为FALSE)。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### line\_width 属性 ----------------------- >
环线的厚度(缺省为8)。 * 类型:uint32\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### max 属性 ----------------------- >
最大值(缺省为100)。 * 类型:uint32\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### show\_text 属性 ----------------------- >
是否显示文本(缺省为TRUE)。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### start\_angle 属性 ----------------------- >
起始角度(单位为度,缺省-90)。 * 类型:int32\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### unit 属性 ----------------------- >
单元(缺省无)。 * 类型:char* | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### value 属性 ----------------------- >
值(缺省为0)。 * 类型:float\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 |