awtk/docs/manual/pointer_event_t.md

183 lines
4.3 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## pointer\_event\_t
### 概述
![image](images/pointer_event_t_0.png)
2019-09-30 17:11:53 +08:00
指针事件。
2019-08-24 10:35:53 +08:00
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-20 17:33:31 +08:00
### 函数
<p id="pointer_event_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2018-12-21 12:11:40 +08:00
| <a href="#pointer_event_t_pointer_event_cast">pointer\_event\_cast</a> | 把event对象转pointer_event_t对象主要给脚本语言使用。 |
2019-04-09 09:57:16 +08:00
| <a href="#pointer_event_t_pointer_event_init">pointer\_event\_init</a> | 初始化事件。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="pointer_event_t_properties">
2019-01-17 15:56:15 +08:00
| 属性名称 | 类型 | 说明 |
2018-12-20 17:33:31 +08:00
| -------- | ----- | ------------ |
2018-12-21 18:29:29 +08:00
| <a href="#pointer_event_t_alt">alt</a> | bool\_t | alt键是否按下。 |
| <a href="#pointer_event_t_button">button</a> | uint8\_t | button。 |
2019-07-04 10:05:59 +08:00
| <a href="#pointer_event_t_cmd">cmd</a> | bool\_t | cmd键是否按下。 |
2018-12-21 18:29:29 +08:00
| <a href="#pointer_event_t_ctrl">ctrl</a> | bool\_t | ctrl键是否按下。 |
2019-07-04 10:05:59 +08:00
| <a href="#pointer_event_t_menu">menu</a> | bool\_t | menu键是否按下。 |
2018-12-21 18:29:29 +08:00
| <a href="#pointer_event_t_pressed">pressed</a> | bool\_t | 指针是否按下。 |
| <a href="#pointer_event_t_shift">shift</a> | bool\_t | shift键是否按下。 |
| <a href="#pointer_event_t_x">x</a> | xy\_t | x坐标。 |
| <a href="#pointer_event_t_y">y</a> | xy\_t | y坐标。 |
2018-12-20 17:33:31 +08:00
#### pointer\_event\_cast 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_pointer_event_cast"> 把event对象转pointer_event_t对象主要给脚本语言使用。
2018-12-21 18:29:29 +08:00
2019-08-24 10:35:53 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
pointer_event_t* pointer_event_cast (event_t* event);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | pointer\_event\_t* | 对象。 |
| event | event\_t* | event对象。 |
2019-04-09 09:57:16 +08:00
#### pointer\_event\_init 函数
-----------------------
* 函数功能:
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_pointer_event_init"> 初始化事件。
2019-04-09 09:57:16 +08:00
2019-08-24 10:35:53 +08:00
2019-04-09 09:57:16 +08:00
* 函数原型:
```
event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type, int32_t x, int32_t y);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | event\_t* | event对象。 |
| event | pointer\_event\_t* | event对象。 |
| target | void* | 事件目标。 |
| type | uint32\_t | 事件类型。 |
| x | int32\_t | x的值。 |
| y | int32\_t | y的值。 |
2018-12-20 17:33:31 +08:00
#### alt 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_alt"> alt键是否按下。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### button 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_button"> button。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型uint8\_t
2019-07-04 10:05:59 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### cmd 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_cmd"> cmd键是否按下。
2019-07-04 10:05:59 +08:00
2019-08-24 10:35:53 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
2018-12-20 17:33:31 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### ctrl 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_ctrl"> ctrl键是否按下。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### menu 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_menu"> menu键是否按下。
2019-07-04 10:05:59 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### pressed 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_pressed"> 指针是否按下。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### shift 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_shift"> shift键是否按下。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### x 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_x"> x坐标。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### y 属性
-----------------------
2019-09-30 17:11:53 +08:00
> <p id="pointer_event_t_y"> y坐标。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |