awtk/docs/manual/pages_t.md

135 lines
3.3 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## pages\_t
### 概述
![image](images/pages_t_0.png)
2018-12-21 11:39:05 +08:00
Pages。只有一个Page处于active状态处于active状态的Page才能显示并接收事件。
2018-12-20 17:33:31 +08:00
### 函数
<p id="pages_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2018-12-21 12:11:40 +08:00
| <a href="#pages_t_pages_cast">pages\_cast</a> | 转换为pages对象(供脚本语言使用)。 |
| <a href="#pages_t_pages_create">pages\_create</a> | 创建pages对象 |
| <a href="#pages_t_pages_set_active">pages\_set\_active</a> | 设置当前的Page。 |
| <a href="#pages_t_pages_set_active_by_name">pages\_set\_active\_by\_name</a> | 通过页面的名字设置当前的Page。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="pages_t_properties">
| 名属性称 | 类型 | 说明 |
| -------- | ----- | ------------ |
2018-12-21 18:29:29 +08:00
| <a href="#pages_t_active">active</a> | uint32\_t | 当前活跃的page。 |
2018-12-20 17:33:31 +08:00
### 事件
<p id="pages_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(当前页)即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值(当前页)改变事件。 |
#### pages\_cast 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
> <p id="pages_t_pages_cast"> 转换为pages对象(供脚本语言使用)。
2018-12-21 11:39:05 +08:00
* 函数原型:
```
widget_t* pages_cast (widget_t* widget);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | pages对象。 |
| widget | widget\_t* | pages对象。 |
2018-12-21 18:29:29 +08:00
#### pages\_create 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-21 18:29:29 +08:00
> <p id="pages_t_pages_create"> 创建pages对象
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
widget_t* pages_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 | 高度 |
2018-12-21 18:29:29 +08:00
#### pages\_set\_active 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-21 18:29:29 +08:00
> <p id="pages_t_pages_set_active"> 设置当前的Page。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t pages_set_active (widget_t* widget, uint32_t index);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| index | uint32\_t | 当前Page的序号。 |
2018-12-21 18:29:29 +08:00
#### pages\_set\_active\_by\_name 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2018-12-21 18:29:29 +08:00
> <p id="pages_t_pages_set_active_by_name"> 通过页面的名字设置当前的Page。
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t pages_set_active_by_name (widget_t* widget, char* name);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| name | char* | 当前Page的名字。 |
#### active 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="pages_t_active"> 当前活跃的page。
2018-12-20 17:33:31 +08:00
* 类型uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
2018-12-26 15:51:37 +08:00
| 支通过widget\_get\_prop读取 | 是 |
| 支通过widget\_set\_prop修改 | 是 |