awtk/docs/manual/key_event_t.md

140 lines
3.3 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## key\_event\_t
### 概述
![image](images/key_event_t_0.png)
2018-12-21 11:39:05 +08:00
按键事件。
2018-12-20 17:33:31 +08:00
### 函数
<p id="key_event_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#key_event_t_key_event_cast">key\_event\_cast</a> | 把event对象转key_event_t对象主要给脚本语言使用。 |
### 属性
<p id="key_event_t_properties">
| 名属性称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#key_event_t_alt">alt</a> | bool_t | alt键是否按下。 |
| <a href="#key_event_t_capslock">capslock</a> | bool_t | capslock键是否按下。 |
| <a href="#key_event_t_ctrl">ctrl</a> | bool_t | ctrl键是否按下。 |
| <a href="#key_event_t_key">key</a> | uint32_t | 键值。 |
| <a href="#key_event_t_shift">shift</a> | bool_t | shift键是否按下。 |
### 事件
<p id="key_event_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
#### key\_event\_cast 函数
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
-----------------------
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | key\_event\_t* | 对象。 |
| event | event\_t* | event对象。 |
2018-12-21 11:39:05 +08:00
* 函数功能:
> <p id="key_event_t_key_event_cast"> 把event对象转key_event_t对象主要给脚本语言使用。
2018-12-20 17:33:31 +08:00
#### alt 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="key_event_t_alt"> alt键是否按下。
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 否 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 否 |
| 可在XML中设置 | 否 |
| 支通过widget_get_prop读取 | 否 |
| 支通过widget_set_prop修改 | 否 |
#### capslock 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="key_event_t_capslock"> capslock键是否按下。
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 否 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 否 |
| 可在XML中设置 | 否 |
| 支通过widget_get_prop读取 | 否 |
| 支通过widget_set_prop修改 | 否 |
#### ctrl 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="key_event_t_ctrl"> ctrl键是否按下。
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 否 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 否 |
| 可在XML中设置 | 否 |
| 支通过widget_get_prop读取 | 否 |
| 支通过widget_set_prop修改 | 否 |
#### key 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="key_event_t_key"> 键值。
2018-12-20 17:33:31 +08:00
* 类型uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 否 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 否 |
| 可在XML中设置 | 否 |
| 支通过widget_get_prop读取 | 否 |
| 支通过widget_set_prop修改 | 否 |
#### shift 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="key_event_t_shift"> shift键是否按下。
2018-12-20 17:33:31 +08:00
* 类型bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 否 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 否 |
| 可在XML中设置 | 否 |
| 支通过widget_get_prop读取 | 否 |
| 支通过widget_set_prop修改 | 否 |