awtk/docs/manual/native_window_t.md
2020-05-24 19:28:22 +08:00

263 lines
7.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## native\_window\_t
### 概述
![image](images/native_window_t_0.png)
原生窗口。
----------------------------------
### 函数
<p id="native_window_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#native_window_t_native_window_center">native\_window\_center</a> | 窗口居中。 |
| <a href="#native_window_t_native_window_create">native\_window\_create</a> | 创建win对象。 |
| <a href="#native_window_t_native_window_get_canvas">native\_window\_get\_canvas</a> | 获取canvas。 |
| <a href="#native_window_t_native_window_invalidate">native\_window\_invalidate</a> | 请求重绘指定区域。 |
| <a href="#native_window_t_native_window_maximize">native\_window\_maximize</a> | 最大化窗口。 |
| <a href="#native_window_t_native_window_minimize">native\_window\_minimize</a> | 最小化窗口。 |
| <a href="#native_window_t_native_window_move">native\_window\_move</a> | 移动窗口。 |
| <a href="#native_window_t_native_window_resize">native\_window\_resize</a> | 调整窗口大小。 |
| <a href="#native_window_t_native_window_restore">native\_window\_restore</a> | 恢复窗口大小。 |
| <a href="#native_window_t_native_window_set_cursor">native\_window\_set\_cursor</a> | 设置鼠标光标。 |
| <a href="#native_window_t_native_window_set_fullscreen">native\_window\_set\_fullscreen</a> | 是否全屏。 |
| <a href="#native_window_t_native_window_show_border">native\_window\_show\_border</a> | 是否显示边框。 |
#### native\_window\_center 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_center">窗口居中。
* 函数原型:
```
ret_t native_window_center (native_window_t* win);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
#### native\_window\_create 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_create">创建win对象。
* 函数原型:
```
native_window_t* native_window_create (const char* params);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | native\_window\_t* | 返回win对象。 |
| params | const char* | 参数。 |
#### native\_window\_get\_canvas 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_get_canvas">获取canvas。
* 函数原型:
```
canvas_t native_window_get_canvas (native_window_t* win);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | canvas\_t | 返回canvas对象。 |
| win | native\_window\_t* | win对象。 |
#### native\_window\_invalidate 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_invalidate">请求重绘指定区域。
* 函数原型:
```
ret_t native_window_invalidate (native_window_t* win, rect_t* r);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
| r | rect\_t* | 重绘区域。 |
#### native\_window\_maximize 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_maximize">最大化窗口。
* 函数原型:
```
ret_t native_window_maximize (native_window_t* win);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
#### native\_window\_minimize 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_minimize">最小化窗口。
* 函数原型:
```
ret_t native_window_minimize (native_window_t* win);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
#### native\_window\_move 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_move">移动窗口。
* 函数原型:
```
ret_t native_window_move (native_window_t* win, xy_t x, xy_t y, bool_t force);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
| x | xy\_t | x坐标。 |
| y | xy\_t | y坐标。 |
| force | bool\_t | 无论是否shared都move。 |
#### native\_window\_resize 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_resize">调整窗口大小。
* 函数原型:
```
ret_t native_window_resize (native_window_t* win, wh_t w, wh_t h, bool_t force);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
| w | wh\_t | 宽。 |
| h | wh\_t | 高。 |
| force | bool\_t | 无论是否shared都resize。 |
#### native\_window\_restore 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_restore">恢复窗口大小。
* 函数原型:
```
ret_t native_window_restore (native_window_t* win);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
#### native\_window\_set\_cursor 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_set_cursor">设置鼠标光标。
* 函数原型:
```
ret_t native_window_set_cursor (native_window_t* win, const char* name, bitmap_t* img);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
| name | const char* | 鼠标光标的名称。 |
| img | bitmap\_t* | 鼠标光标的图片。 |
#### native\_window\_set\_fullscreen 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_set_fullscreen">是否全屏。
* 函数原型:
```
ret_t native_window_set_fullscreen (native_window_t* win, bool_t fullscreen);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
| fullscreen | bool\_t | 是否全屏。 |
#### native\_window\_show\_border 函数
-----------------------
* 函数功能:
> <p id="native_window_t_native_window_show_border">是否显示边框。
* 函数原型:
```
ret_t native_window_show_border (native_window_t* win, bool_t show);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| win | native\_window\_t* | win对象。 |
| show | bool\_t | 是否显示。 |