awtk/docs/manual/event_t.md

159 lines
3.1 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## event\_t
### 概述
事件基类。
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-20 17:33:31 +08:00
### 函数
<p id="event_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2019-01-14 11:38:31 +08:00
| <a href="#event_t_event_cast">event\_cast</a> | 转换为event对象。 |
| <a href="#event_t_event_create">event\_create</a> | 创建event对象。 |
| <a href="#event_t_event_destroy">event\_destroy</a> | 销毁事件对象。 |
| <a href="#event_t_event_init">event\_init</a> | 初始化事件。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="event_t_properties">
2019-01-17 15:56:15 +08:00
| 属性名称 | 类型 | 说明 |
2018-12-20 17:33:31 +08:00
| -------- | ----- | ------------ |
2018-12-21 12:11:40 +08:00
| <a href="#event_t_target">target</a> | void* | 事件发生的目标对象。 |
2018-12-21 18:29:29 +08:00
| <a href="#event_t_time">time</a> | int32\_t | 事件发生的时间。 |
| <a href="#event_t_type">type</a> | int32\_t | 类型。 |
2018-12-20 17:33:31 +08:00
#### event\_cast 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
2019-01-14 11:38:31 +08:00
> <p id="event_t_event_cast"> 转换为event对象。
> 供脚本语言使用
2018-12-21 18:29:29 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
event_t* event_cast (event_t* event);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
2019-01-14 11:38:31 +08:00
| 返回值 | event\_t* | event对象。 |
| event | event\_t* | event对象。 |
#### event\_create 函数
-----------------------
* 函数功能:
> <p id="event_t_event_create"> 创建event对象。
主要给脚本语言使用。
* 函数原型:
```
event_t* event_create (uint32_t type, void* target);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | event\_t* | 返回事件对象。 |
| type | uint32\_t | 事件类型。 |
| target | void* | 目标对象。 |
#### event\_destroy 函数
-----------------------
* 函数功能:
> <p id="event_t_event_destroy"> 销毁事件对象。
主要给脚本语言使用。
* 函数原型:
```
ret_t event_destroy (event_t* event);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
2018-12-20 17:33:31 +08:00
| event | event\_t* | event对象。 |
#### event\_init 函数
-----------------------
* 函数功能:
> <p id="event_t_event_init"> 初始化事件。
* 函数原型:
```
event_t event_init (uint32_t type, void* target);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | event\_t | 事件对象。 |
| type | uint32\_t | 事件类型。 |
| target | void* | 目标对象。 |
2018-12-20 17:33:31 +08:00
#### target 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="event_t_target"> 事件发生的目标对象。
2018-12-20 17:33:31 +08:00
* 类型void*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### time 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="event_t_time"> 事件发生的时间。
2018-12-20 17:33:31 +08:00
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### type 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="event_t_type"> 类型。
2018-12-20 17:33:31 +08:00
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |