awtk/docs/manual/style_t.md

155 lines
3.4 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## style\_t
### 概述
控件风格。
### 函数
<p id="style_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2018-12-21 12:11:40 +08:00
| <a href="#style_t_style_destroy">style\_destroy</a> | 销毁style对象 |
2018-12-26 11:38:15 +08:00
| <a href="#style_t_style_get_color">style\_get\_color</a> | 获取指定name的颜色值。 |
| <a href="#style_t_style_get_int">style\_get\_int</a> | 获取指定name的整数格式的值。 |
| <a href="#style_t_style_get_str">style\_get\_str</a> | 获取指定name的字符串格式的值。 |
2018-12-21 12:11:40 +08:00
| <a href="#style_t_style_is_valid">style\_is\_valid</a> | 检查style对象是否有效 |
| <a href="#style_t_style_notify_widget_state_changed">style\_notify\_widget\_state\_changed</a> | widget状态改变时通知style更新数据。 |
2018-12-20 17:33:31 +08:00
#### style\_destroy 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
> <p id="style_t_style_destroy"> 销毁style对象
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t style_destroy (style_t* s);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| s | style\_t* | style对象。 |
2018-12-21 18:29:29 +08:00
#### style\_get\_color 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-26 11:38:15 +08:00
> <p id="style_t_style_get_color"> 获取指定name的颜色值。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
2018-12-26 11:38:15 +08:00
color_t style_get_color (style_t* s, const char* name, color_t defval);
2018-12-21 11:39:05 +08:00
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | color\_t | 返回颜色值。 |
| s | style\_t* | style对象。 |
2018-12-26 11:38:15 +08:00
| name | const char* | 属性名。 |
2018-12-20 17:33:31 +08:00
| defval | color\_t | 缺省值。 |
2018-12-21 18:29:29 +08:00
#### style\_get\_int 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-26 11:38:15 +08:00
> <p id="style_t_style_get_int"> 获取指定name的整数格式的值。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
2018-12-26 11:38:15 +08:00
int32_t style_get_int (style_t* s, const char* name, int32_t defval);
2018-12-21 11:39:05 +08:00
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回整数格式的值。 |
| s | style\_t* | style对象。 |
2018-12-26 11:38:15 +08:00
| name | const char* | 属性名。 |
2018-12-20 17:33:31 +08:00
| defval | int32\_t | 缺省值。 |
2018-12-21 18:29:29 +08:00
#### style\_get\_str 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-26 11:38:15 +08:00
> <p id="style_t_style_get_str"> 获取指定name的字符串格式的值。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
2018-12-26 11:38:15 +08:00
const char* style_get_str (style_t* s, const char* name, const char* defval);
2018-12-21 11:39:05 +08:00
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const char* | 返回字符串格式的值。 |
| s | style\_t* | style对象。 |
2018-12-26 11:38:15 +08:00
| name | const char* | 属性名。 |
2018-12-20 17:33:31 +08:00
| defval | const char* | 缺省值。 |
2018-12-21 18:29:29 +08:00
#### style\_is\_valid 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-21 18:29:29 +08:00
> <p id="style_t_style_is_valid"> 检查style对象是否有效
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
bool_t style_is_valid (style_t* s);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | bool\_t | 返回是否有效。 |
| s | style\_t* | style对象。 |
2018-12-21 18:29:29 +08:00
#### style\_notify\_widget\_state\_changed 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-21 18:29:29 +08:00
> <p id="style_t_style_notify_widget_state_changed"> widget状态改变时通知style更新数据。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t style_notify_widget_state_changed (style_t* s, widget_t* widget);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| s | style\_t* | style对象。 |
| widget | widget\_t* | 控件对象。 |