awtk/docs/manual/dragger_t.md

182 lines
4.7 KiB
Markdown
Raw Normal View History

2019-10-17 14:23:01 +08:00
## dragger\_t
### 概述
![image](images/dragger_t_0.png)
2019-12-14 13:25:56 +08:00
dragger控件。
目前主要用于scrollbar里的滑块。
2019-10-17 14:23:01 +08:00
----------------------------------
### 函数
<p id="dragger_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#dragger_t_dragger_cast">dragger\_cast</a> | 转换为dragger对象(供脚本语言使用)。 |
| <a href="#dragger_t_dragger_create">dragger\_create</a> | 创建dragger对象。 |
2022-12-05 12:10:53 +08:00
| <a href="#dragger_t_dragger_get_widget_vtable">dragger\_get\_widget\_vtable</a> | 获取 dragger 虚表。 |
2019-10-17 14:23:01 +08:00
| <a href="#dragger_t_dragger_set_range">dragger\_set\_range</a> | 设置拖动的范围。 |
### 属性
<p id="dragger_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#dragger_t_x_max">x\_max</a> | xy\_t | x坐标的最大值。 |
| <a href="#dragger_t_x_min">x\_min</a> | xy\_t | x坐标的最小值。 |
| <a href="#dragger_t_y_max">y\_max</a> | xy\_t | y坐标的最大值。 |
| <a href="#dragger_t_y_min">y\_min</a> | xy\_t | y坐标的最小值。 |
2021-05-11 15:53:22 +08:00
### 事件
<p id="dragger_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_DRAG\_START | event\_t | 开始拖动事件。 |
| EVT\_DRAG | event\_t | 拖动事件。 |
| EVT\_DRAG\_END | event\_t | 结束拖动事件。 |
2019-10-17 14:23:01 +08:00
#### dragger\_cast 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="dragger_t_dragger_cast">转换为dragger对象(供脚本语言使用)。
2019-10-17 14:23:01 +08:00
* 函数原型:
```
widget_t* dragger_cast (widget_t* widget);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dragger对象。 |
| widget | widget\_t* | dragger对象。 |
#### dragger\_create 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="dragger_t_dragger_create">创建dragger对象。
2019-10-17 14:23:01 +08:00
* 函数原型:
```
widget_t* dragger_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
2022-12-05 12:10:53 +08:00
#### dragger\_get\_widget\_vtable 函数
-----------------------
* 函数功能:
> <p id="dragger_t_dragger_get_widget_vtable">获取 dragger 虚表。
* 函数原型:
```
const widget_vtable_t* dragger_get_widget_vtable ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const widget\_vtable\_t* | 成功返回 dragger 虚表。 |
2019-10-17 14:23:01 +08:00
#### dragger\_set\_range 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="dragger_t_dragger_set_range">设置拖动的范围。
2019-10-17 14:23:01 +08:00
* 函数原型:
```
2019-12-14 13:25:56 +08:00
ret_t dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_max, xy_t y_max);
2019-10-17 14:23:01 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
2019-12-14 13:25:56 +08:00
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
2019-10-17 14:23:01 +08:00
| widget | widget\_t* | dragger控件。 |
| x\_min | xy\_t | x坐标最小值。 |
| y\_min | xy\_t | y坐标最小值。 |
| x\_max | xy\_t | x坐标最大值。 |
| y\_max | xy\_t | y坐标最大值。 |
#### x\_max 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="dragger_t_x_max">x坐标的最大值。
2019-10-17 14:23:01 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### x\_min 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="dragger_t_x_min">x坐标的最小值。
2019-10-17 14:23:01 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### y\_max 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="dragger_t_y_max">y坐标的最大值。
2019-10-17 14:23:01 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### y\_min 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="dragger_t_y_min">y坐标的最小值。
2019-10-17 14:23:01 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |