awtk/docs/manual/style_mutable_t.md

235 lines
5.8 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## style\_mutable\_t
### 概述
![image](images/style_mutable_t_0.png)
2018-12-30 11:49:59 +08:00
可变的style(可实时修改并生效主要用于在designer中被编辑的控件或者一些特殊控件)。
style\_mutable也对style\_const进行了包装当用户没修改某个值时便从style\_const中获取。
2018-12-21 11:39:05 +08:00
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-20 17:33:31 +08:00
### 函数
<p id="style_mutable_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2018-12-30 11:49:59 +08:00
| <a href="#style_mutable_t_style_mutable_create">style\_mutable\_create</a> | 创建style\_mutable对象。 |
| <a href="#style_mutable_t_style_mutable_foreach">style\_mutable\_foreach</a> | 遍历。对每项调用回调函数on\_style\_item。 |
2018-12-21 12:11:40 +08:00
| <a href="#style_mutable_t_style_mutable_get_name">style\_mutable\_get\_name</a> | 获取style的名称。 |
2018-12-30 11:49:59 +08:00
| <a href="#style_mutable_t_style_mutable_register">style\_mutable\_register</a> | 将自己注册到style\_factory。 |
2018-12-26 11:38:15 +08:00
| <a href="#style_mutable_t_style_mutable_set_color">style\_mutable\_set\_color</a> | 设置指定name的颜色值。 |
| <a href="#style_mutable_t_style_mutable_set_int">style\_mutable\_set\_int</a> | 设置指定name整数格式的值。 |
2018-12-21 12:11:40 +08:00
| <a href="#style_mutable_t_style_mutable_set_name">style\_mutable\_set\_name</a> | 设置style的名称。 |
2018-12-26 11:38:15 +08:00
| <a href="#style_mutable_t_style_mutable_set_str">style\_mutable\_set\_str</a> | 设置指定name字符串的值。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="style_mutable_t_properties">
| 名属性称 | 类型 | 说明 |
| -------- | ----- | ------------ |
2018-12-21 12:11:40 +08:00
| <a href="#style_mutable_t_name">name</a> | char* | 名称。 |
2018-12-20 17:33:31 +08:00
#### style\_mutable\_create 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
2018-12-30 11:49:59 +08:00
> <p id="style_mutable_t_style_mutable_create"> 创建style\_mutable对象。
> 除了测试程序外不需要直接调用widget会通过style\_factory\_create创建。
2018-12-21 18:29:29 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
style_t* style_mutable_create (widget_t* widget);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | style\_t* | style对象。 |
| widget | widget\_t* | 控件 |
2018-12-21 18:29:29 +08:00
#### style\_mutable\_foreach 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-30 11:49:59 +08:00
> <p id="style_mutable_t_style_mutable_foreach"> 遍历。对每项调用回调函数on\_style\_item。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t style_mutable_foreach (style_t* s, tk_on_style_item_t on_style_item, void* ctx);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| s | style\_t* | style对象。 |
| on\_style\_item | tk\_on\_style\_item\_t | 回调函数。 |
| ctx | void* | 回调函数的上下文。 |
2018-12-21 18:29:29 +08:00
#### style\_mutable\_get\_name 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-21 18:29:29 +08:00
> <p id="style_mutable_t_style_mutable_get_name"> 获取style的名称。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
const char* style_mutable_get_name (style_t* s);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const char* | style的名称。 |
| s | style\_t* | style对象。 |
2018-12-21 18:29:29 +08:00
#### style\_mutable\_register 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-30 11:49:59 +08:00
> <p id="style_mutable_t_style_mutable_register"> 将自己注册到style\_factory。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t style_mutable_register ();
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
2018-12-21 18:29:29 +08:00
#### style\_mutable\_set\_color 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-26 11:38:15 +08:00
> <p id="style_mutable_t_style_mutable_set_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
ret_t style_mutable_set_color (style_t* s, const char* state, const char* name, color_t val);
2018-12-21 11:39:05 +08:00
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| s | style\_t* | style对象。 |
2018-12-26 11:38:15 +08:00
| state | const char* | 控件状态。 |
| name | const char* | 属性名。 |
2018-12-20 17:33:31 +08:00
| val | color\_t | 值。 |
2018-12-21 18:29:29 +08:00
#### style\_mutable\_set\_int 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-26 11:38:15 +08:00
> <p id="style_mutable_t_style_mutable_set_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
ret_t style_mutable_set_int (style_t* s, const char* state, const char* name, int32_t val);
2018-12-21 11:39:05 +08:00
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| s | style\_t* | style对象。 |
2018-12-26 11:38:15 +08:00
| state | const char* | 控件状态。 |
| name | const char* | 属性名。 |
2018-12-20 17:33:31 +08:00
| val | int32\_t | 值。 |
2018-12-21 18:29:29 +08:00
#### style\_mutable\_set\_name 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-21 18:29:29 +08:00
> <p id="style_mutable_t_style_mutable_set_name"> 设置style的名称。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t style_mutable_set_name (style_t* s, const char* name);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| s | style\_t* | style对象。 |
| name | const char* | 名称。 |
2018-12-21 18:29:29 +08:00
#### style\_mutable\_set\_str 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-26 11:38:15 +08:00
> <p id="style_mutable_t_style_mutable_set_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
ret_t style_mutable_set_str (style_t* s, const char* state, const char* name, const char* val);
2018-12-21 11:39:05 +08:00
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| s | style\_t* | style对象。 |
2018-12-26 11:38:15 +08:00
| state | const char* | 控件状态。 |
| name | const char* | 属性名。 |
2018-12-20 17:33:31 +08:00
| val | const char* | 值。 |
#### name 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="style_mutable_t_name"> 名称。
2018-12-20 17:33:31 +08:00
* 类型char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |