test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-02 03:58:33 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
72ce04a828
awtk/docs/manual/children_layouter_t.md

241 lines
6.4 KiB
Markdown
Raw Normal View History

update docs
2018-12-20 17:33:31 +08:00
## children\_layouter\_t
### 概述
子控件排版布局器的接口。
update docs
2019-01-17 15:48:41 +08:00
按特定算法对子控件进行排版布局，子类需要实现vtable中的函数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-15 14:34:05 +08:00
----------------------------------
update docs
2018-12-20 17:33:31 +08:00
### 函数
<p id="children_layouter_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
update docs
2018-12-21 12:11:40 +08:00
| <a href="#children_layouter_t_children_layouter_destroy">children\_layouter\_destroy</a> | 销毁layouter对象。 |
| <a href="#children_layouter_t_children_layouter_get_param">children\_layouter\_get\_param</a> | 获取指定的参数。 |
| <a href="#children_layouter_t_children_layouter_get_param_float">children\_layouter\_get\_param\_float</a> | 获取指定的浮点格式的参数。 |
| <a href="#children_layouter_t_children_layouter_get_param_int">children\_layouter\_get\_param\_int</a> | 获取指定的整数格式的参数。 |
| <a href="#children_layouter_t_children_layouter_is_valid">children\_layouter\_is\_valid</a> | 判断layouter对象是否有效。 |
update docs
2019-01-17 16:06:37 +08:00
| <a href="#children_layouter_t_children_layouter_layout">children\_layouter\_layout</a> | 对控件的子控件进行布局。 |
update docs
2018-12-21 12:11:40 +08:00
| <a href="#children_layouter_t_children_layouter_set_param">children\_layouter\_set\_param</a> | 获取指定的参数。 |
| <a href="#children_layouter_t_children_layouter_set_param_str">children\_layouter\_set\_param\_str</a> | 设置字符串格式的参数。 |
| <a href="#children_layouter_t_children_layouter_to_string">children\_layouter\_to\_string</a> | 获取全部参数。 |
update docs
2018-12-20 17:33:31 +08:00
#### children\_layouter\_destroy 函数
update docs
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能：
> <p id="children_layouter_t_children_layouter_destroy"> 销毁layouter对象。
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_destroy (children_layouter_t* layouter);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| layouter | children\_layouter\_t* | layouter对象。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_get\_param 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="children_layouter_t_children_layouter_get_param"> 获取指定的参数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_get_param (children_layouter_t* layouter, const char* name, value_t* v);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| layouter | children\_layouter\_t* | layouter对象。 |
| name | const char* | 参数名。 |
| v | value\_t* | 返回参数的值。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_get\_param\_float 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="children_layouter_t_children_layouter_get_param_float"> 获取指定的浮点格式的参数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_get_param_float (children_layouter_t* layouter, const char* name, float_t defval);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 成功返回参数的值，失败返回缺省值。 |
| layouter | children\_layouter\_t* | layouter对象。 |
| name | const char* | 参数名。 |
| defval | float\_t | 缺省值。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_get\_param\_int 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="children_layouter_t_children_layouter_get_param_int"> 获取指定的整数格式的参数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_get_param_int (children_layouter_t* layouter, const char* name, int32_t defval);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 成功返回参数的值，失败返回缺省值。 |
| layouter | children\_layouter\_t* | layouter对象。 |
| name | const char* | 参数名。 |
| defval | int32\_t | 缺省值。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_is\_valid 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="children_layouter_t_children_layouter_is_valid"> 判断layouter对象是否有效。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
bool_t children_layouter_is_valid (children_layouter_t* layouter);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | bool\_t | 返回TRUE表示有效，否则表示无效。 |
| layouter | children\_layouter\_t* | layouter对象。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_layout 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2019-01-17 16:06:37 +08:00
> <p id="children_layouter_t_children_layouter_layout"> 对控件的子控件进行布局。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_layout (children_layouter_t* layouter, widget_t* widget);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| layouter | children\_layouter\_t* | layouter对象。 |
| widget | widget\_t* | 控件。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_set\_param 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="children_layouter_t_children_layouter_set_param"> 获取指定的参数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_set_param (children_layouter_t* layouter, const char* name, const value_t* v);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| layouter | children\_layouter\_t* | layouter对象。 |
| name | const char* | 参数名。 |
| v | const value\_t* | 参数的值。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_set\_param\_str 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="children_layouter_t_children_layouter_set_param_str"> 设置字符串格式的参数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2019-01-17 15:48:41 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_set_param_str (children_layouter_t* layouter, const char* name, const char* value);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| layouter | children\_layouter\_t* | layouter对象。 |
| name | const char* | 参数名。 |
| value | const char* | 参数值。 |
update docs
2018-12-21 18:29:29 +08:00
#### children\_layouter\_to\_string 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="children_layouter_t_children_layouter_to_string"> 获取全部参数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t children_layouter_to_string (children_layouter_t* layouter);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回字符串格式的参数。 |
| layouter | children\_layouter\_t* | layouter对象。 |
Reference in New Issue Copy Permalink