awtk/docs/manual/guage_pointer_t.md

219 lines
7.0 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## guage\_pointer\_t
### 概述
![image](images/guage_pointer_t_0.png)
2019-12-14 13:25:56 +08:00
仪表指针控件。
仪表指针就是一张旋转的图片图片可以是普通图片也可以是SVG图片。
在嵌入式平台上对于旋转的图片SVG图片的效率比位图高数倍所以推荐使用SVG图片。
guage\_pointer\_t是[widget\_t](widget_t.md)的子类控件widget\_t的函数均适用于guage\_pointer\_t控件。
在xml中使用"guage\_pointer"标签创建仪表指针控件。如:
```xml
<guage_pointer x="c" y="50" w="24" h="140" value="-128" image="guage_pointer" />
```
> 更多用法请参考:
[guage.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/guage.xml)
在c代码中使用函数guage\_pointer\_create创建仪表指针控件。如
```c
widget_t* guage_pointer = guage_pointer_create(guage, 10, 10, 100, 30);
guage_pointer_set_image(guage_pointer, "guage_pointer");
```
> 创建之后需要用guage\_pointer\_set\_image设置仪表指针图片。
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-20 17:33:31 +08:00
### 函数
<p id="guage_pointer_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2018-12-21 12:11:40 +08:00
| <a href="#guage_pointer_t_guage_pointer_cast">guage\_pointer\_cast</a> | 转换为guage_pointer对象(供脚本语言使用)。 |
| <a href="#guage_pointer_t_guage_pointer_create">guage\_pointer\_create</a> | 创建guage_pointer对象 |
2019-07-04 10:05:59 +08:00
| <a href="#guage_pointer_t_guage_pointer_set_anchor">guage\_pointer\_set\_anchor</a> | 设置指针的旋转锚点。 |
2018-12-21 12:11:40 +08:00
| <a href="#guage_pointer_t_guage_pointer_set_angle">guage\_pointer\_set\_angle</a> | 设置指针角度。12点钟方向为0度顺时钟方向为正单位为度。 |
| <a href="#guage_pointer_t_guage_pointer_set_image">guage\_pointer\_set\_image</a> | 设置指针的图片。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="guage_pointer_t_properties">
2019-01-17 15:56:15 +08:00
| 属性名称 | 类型 | 说明 |
2018-12-20 17:33:31 +08:00
| -------- | ----- | ------------ |
2020-01-03 15:48:06 +08:00
| <a href="#guage_pointer_t_anchor_x">anchor\_x</a> | char* | 图片旋转锚点x坐标。(后面加上px为像素点不加px为相对百分比坐标0.0f到1.0f) |
| <a href="#guage_pointer_t_anchor_y">anchor\_y</a> | char* | 图片旋转锚点x坐标。(后面加上px为像素点不加px为相对百分比坐标0.0f到1.0f) |
2018-12-21 18:29:29 +08:00
| <a href="#guage_pointer_t_angle">angle</a> | int32\_t | 指针角度。12点钟方向为0度顺时钟方向为正单位为度。 |
2019-12-14 13:25:56 +08:00
| <a href="#guage_pointer_t_image">image</a> | char* | 指针图片。 |
2018-12-20 17:33:31 +08:00
#### guage\_pointer\_cast 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="guage_pointer_t_guage_pointer_cast">转换为guage_pointer对象(供脚本语言使用)。
2019-10-16 09:02:32 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
widget_t* guage_pointer_cast (widget_t* widget);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | guage\_pointer对象。 |
| widget | widget\_t* | guage\_pointer对象。 |
2018-12-21 18:29:29 +08:00
#### guage\_pointer\_create 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="guage_pointer_t_guage_pointer_create">创建guage_pointer对象
2019-10-16 09:02:32 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
widget_t* guage_pointer_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
2019-07-04 10:05:59 +08:00
#### guage\_pointer\_set\_anchor 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="guage_pointer_t_guage_pointer_set_anchor">设置指针的旋转锚点。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 函数原型:
```
ret_t guage_pointer_set_anchor (widget_t* widget, const char* anchor_x, const char* anchor_y);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| anchor\_x | const char* | 指针的锚点坐标x。(后面加上px为像素点不加px为相对百分比坐标) |
| anchor\_y | const char* | 指针的锚点坐标y。(后面加上px为像素点不加px为相对百分比坐标) |
2018-12-21 18:29:29 +08:00
#### guage\_pointer\_set\_angle 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="guage_pointer_t_guage_pointer_set_angle">设置指针角度。12点钟方向为0度顺时钟方向为正单位为度。
2019-10-16 09:02:32 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t guage_pointer_set_angle (widget_t* widget, int32_t angle);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| angle | int32\_t | 指针角度。 |
2018-12-21 18:29:29 +08:00
#### guage\_pointer\_set\_image 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="guage_pointer_t_guage_pointer_set_image">设置指针的图片。
2019-10-16 09:02:32 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t guage_pointer_set_image (widget_t* widget, const char* image);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| image | const char* | 指针的图片。 |
2019-07-04 10:05:59 +08:00
#### anchor\_x 属性
-----------------------
2020-01-03 15:48:06 +08:00
> <p id="guage_pointer_t_anchor_x">图片旋转锚点x坐标。(后面加上px为像素点不加px为相对百分比坐标0.0f到1.0f)
2019-10-16 09:02:32 +08:00
2020-01-03 15:48:06 +08:00
* 类型char*
2019-07-04 10:05:59 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### anchor\_y 属性
-----------------------
2020-01-03 15:48:06 +08:00
> <p id="guage_pointer_t_anchor_y">图片旋转锚点x坐标。(后面加上px为像素点不加px为相对百分比坐标0.0f到1.0f)
2019-10-16 09:02:32 +08:00
2020-01-03 15:48:06 +08:00
* 类型char*
2019-07-04 10:05:59 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
2018-12-20 17:33:31 +08:00
#### angle 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="guage_pointer_t_angle">指针角度。12点钟方向为0度顺时钟方向为正单位为度。
2019-10-16 09:02:32 +08:00
2018-12-20 17:33:31 +08:00
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
2019-01-02 16:13:02 +08:00
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
2018-12-20 17:33:31 +08:00
#### image 属性
-----------------------
2019-12-14 13:25:56 +08:00
> <p id="guage_pointer_t_image">指针图片。
图片须垂直向上,图片的中心点为旋转方向。
2018-12-20 17:33:31 +08:00
* 类型char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
2019-01-02 16:13:02 +08:00
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |