awtk/docs/manual/key_event_t.md

230 lines
5.8 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## key\_event\_t
### 概述
![image](images/key_event_t_0.png)
2019-11-15 11:33:43 +08:00
按键事件。
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-20 17:33:31 +08:00
### 函数
<p id="key_event_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2023-06-29 10:56:20 +08:00
| <a href="#key_event_t_key_event_cast">key\_event\_cast</a> | 把event对象转key_event_t对象。 |
2019-04-09 09:57:16 +08:00
| <a href="#key_event_t_key_event_init">key\_event\_init</a> | 初始化事件。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="key_event_t_properties">
2019-01-17 15:56:15 +08:00
| 属性名称 | 类型 | 说明 |
2018-12-20 17:33:31 +08:00
| -------- | ----- | ------------ |
2019-08-24 10:35:53 +08:00
| <a href="#key_event_t_alt">alt</a> | bool\_t | alt键是否按下。 |
2018-12-21 18:29:29 +08:00
| <a href="#key_event_t_capslock">capslock</a> | bool\_t | capslock键是否按下。 |
2019-12-14 13:25:56 +08:00
| <a href="#key_event_t_cmd">cmd</a> | bool\_t | left shift键是否按下。 |
| <a href="#key_event_t_ctrl">ctrl</a> | bool\_t | right alt键是否按下。 |
2018-12-21 18:29:29 +08:00
| <a href="#key_event_t_key">key</a> | uint32\_t | 键值。 |
2019-07-04 10:05:59 +08:00
| <a href="#key_event_t_lalt">lalt</a> | bool\_t | left alt键是否按下。 |
| <a href="#key_event_t_lctrl">lctrl</a> | bool\_t | left ctrl键是否按下。 |
| <a href="#key_event_t_lshift">lshift</a> | bool\_t | left shift键是否按下。 |
| <a href="#key_event_t_menu">menu</a> | bool\_t | menu键是否按下。 |
2023-06-29 10:44:29 +08:00
| <a href="#key_event_t_numlock">numlock</a> | bool\_t | numlock键是否按下。 |
2019-07-04 10:05:59 +08:00
| <a href="#key_event_t_ralt">ralt</a> | bool\_t | right alt键是否按下。 |
| <a href="#key_event_t_rctrl">rctrl</a> | bool\_t | right ctrl键是否按下。 |
| <a href="#key_event_t_rshift">rshift</a> | bool\_t | right shift键是否按下。 |
2018-12-21 18:29:29 +08:00
| <a href="#key_event_t_shift">shift</a> | bool\_t | shift键是否按下。 |
2018-12-20 17:33:31 +08:00
#### key\_event\_cast 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
2023-06-29 10:56:20 +08:00
> <p id="key_event_t_key_event_cast">把event对象转key_event_t对象。
2019-10-16 09:02:32 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
key_event_t* key_event_cast (event_t* event);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
2019-12-09 11:51:36 +08:00
| 返回值 | key\_event\_t* | event对象。 |
2018-12-20 17:33:31 +08:00
| event | event\_t* | event对象。 |
2019-04-09 09:57:16 +08:00
#### key\_event\_init 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_key_event_init">初始化事件。
2019-10-16 09:02:32 +08:00
2019-04-09 09:57:16 +08:00
* 函数原型:
```
2023-06-29 10:44:29 +08:00
event_t* key_event_init (key_event_t* event, uint32_t type, void* target, int32_t key);
2019-04-09 09:57:16 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | event\_t* | event对象。 |
| event | key\_event\_t* | event对象。 |
| type | uint32\_t | 事件类型。 |
2023-06-29 10:44:29 +08:00
| target | void* | 事件目标。 |
2019-04-09 09:57:16 +08:00
| key | int32\_t | key的值。 |
2018-12-20 17:33:31 +08:00
#### alt 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_alt">alt键是否按下。
2019-10-16 09:02:32 +08:00
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### capslock 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_capslock">capslock键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### cmd 属性
-----------------------
2019-12-14 13:25:56 +08:00
> <p id="key_event_t_cmd">left shift键是否按下。
cmd/win键是否按下。
2019-07-04 10:05:59 +08:00
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### ctrl 属性
-----------------------
2019-12-14 13:25:56 +08:00
> <p id="key_event_t_ctrl">right alt键是否按下。
ctrl键是否按下。
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### key 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_key">键值。
2019-10-16 09:02:32 +08:00
2018-12-20 17:33:31 +08:00
* 类型uint32\_t
2019-07-04 10:05:59 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### lalt 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_lalt">left alt键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### lctrl 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_lctrl">left ctrl键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### lshift 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_lshift">left shift键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### menu 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_menu">menu键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
2023-06-29 10:44:29 +08:00
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### numlock 属性
-----------------------
> <p id="key_event_t_numlock">numlock键是否按下。
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
2019-07-04 10:05:59 +08:00
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### ralt 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_ralt">right alt键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### rctrl 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_rctrl">right ctrl键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### rshift 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_rshift">right shift键是否按下。
2019-10-16 09:02:32 +08:00
2019-07-04 10:05:59 +08:00
* 类型bool\_t
2018-12-20 17:33:31 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### shift 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="key_event_t_shift">shift键是否按下。
2019-10-16 09:02:32 +08:00
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |