1# oh_window_comm.h 2 3## 概述 4 5提供窗口的公共枚举、公共定义等。 6 7**引用文件：** <window_manager/oh_window_comm.h> 8 9**库：** libnative_window_manager.so 10 11**系统能力：** SystemCapability.Window.SessionManager 12 13**起始版本：** 12 14 15**相关模块：** [WindowManager](capi-windowmanager.md) 16 17## 汇总 18 19### 结构体 20 21| 名称 | typedef关键字 | 描述 | 22| -- | -- | -- | 23| [WindowManager_Rect](capi-windowmanager-rect.md) | WindowManager_Rect | 定义窗口矩形结构体，包含窗口位置和宽高信息。 | 24| [OH_PixelmapNative](capi-struct.md) | OH_PixelmapNative | 定义像素图片信息。 | 25| [WindowManager_WindowProperties](capi-windowmanager-windowproperties.md) | WindowManager_WindowProperties | 窗口属性。 | 26| [WindowManager_AvoidArea](capi-windowmanager-avoidarea.md) | WindowManager_AvoidArea | 定义避让区域结构体。 | 27 28### 枚举 29 30| 名称 | typedef关键字 | 描述 | 31| -- | -- | -- | 32| [WindowManager_ErrorCode](#windowmanager_errorcode) | WindowManager_ErrorCode | 窗口管理接口返回状态码枚举。 | 33| [WindowManager_AvoidAreaType](#windowmanager_avoidareatype) | WindowManager_AvoidAreaType | 避让区域枚举类型。 | 34| [WindowManager_WindowType](#windowmanager_windowtype) | WindowManager_WindowType | 窗口类型。 | 35 36## 枚举类型说明 37 38### WindowManager_ErrorCode 39 40``` 41enum WindowManager_ErrorCode 42``` 43 44**描述** 45 46窗口管理接口返回状态码枚举。 47 48**起始版本：** 12 49 50| 枚举项 | 描述 | 51| -- | -- | 52| OK = 0 | 成功。 | 53| WINDOW_MANAGER_ERRORCODE_NO_PERMISSION = 201 | 无权限。<br/>**起始版本：** 15 | 54| WINDOW_MANAGER_ERRORCODE_INVALID_PARAM = 401 | 非法参数。<br/>**起始版本：** 15 | 55| WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED = 801 | 设备不支持。<br/>**起始版本：** 15 | 56| INVAILD_WINDOW_ID = 1000 | 非法窗口ID。 | 57| SERVICE_ERROR = 2000 | 服务异常。 | 58| WINDOW_MANAGER_ERRORCODE_STATE_ABNORMAL = 1300002 | 窗口状态异常。<br/>**起始版本：** 15 | 59| WINDOW_MANAGER_ERRORCODE_SYSTEM_ABNORMAL = 1300003 | 窗口管理器服务异常。<br/>**起始版本：** 15 | 60| WINDOW_MANAGER_ERRORCODE_PIP_DESTROY_FAILED = 1300011 | 画中画销毁失败。<br/>**起始版本：** 20 | 61| WINDOW_MANAGER_ERRORCODE_PIP_STATE_ABNORMAL = 1300012 | 画中画状态异常。<br/>**起始版本：** 20 | 62| WINDOW_MANAGER_ERRORCODE_PIP_CREATE_FAILED = 1300013 | 画中画创建失败。<br/>**起始版本：** 20 | 63| WINDOW_MANAGER_ERRORCODE_PIP_INTERNAL_ERROR = 1300014 | 画中画内部错误。可能原因：<br/>1.画中画依赖的窗口异常，可能窗口为空；2.画中画控制器异常。<br/>**起始版本：** 20 | 64| WINDOW_MANAGER_ERRORCODE_PIP_REPEATED_OPERATION = 1300015 | 画中画重复操作。<br/>**起始版本：** 20 | 65| WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM = 1300016 | 参数错误。 可能原因：<br/>1.参数取值范围非法；2.参数数量非法；3.参数类型非法。<br/>**起始版本：** 20 | 66 67### WindowManager_AvoidAreaType 68 69``` 70enum WindowManager_AvoidAreaType 71``` 72 73**描述** 74 75避让区域枚举类型。 76 77**起始版本：** 15 78 79| 枚举项 | 描述 | 80| -- | -- | 81| WINDOW_MANAGER_AVOID_AREA_TYPE_SYSTEM = 0 | 系统避让区域。 | 82| WINDOW_MANAGER_AVOID_AREA_TYPE_CUTOUT = 1 | 刘海屏避让。 | 83| WINDOW_MANAGER_AVOID_AREA_TYPE_SYSTEM_GESTURE = 2 | 系统手势区域。 | 84| WINDOW_MANAGER_AVOID_AREA_TYPE_KEYBOARD = 3 | 键盘区域。 | 85| WINDOW_MANAGER_AVOID_AREA_TYPE_NAVIGATION_INDICATOR = 4 | 导航条区域。 | 86 87### WindowManager_WindowType 88 89``` 90enum WindowManager_WindowType 91``` 92 93**描述** 94 95窗口类型。 96 97**起始版本：** 15 98 99| 枚举项 | 描述 | 100| -- | -- | 101| WINDOW_MANAGER_WINDOW_TYPE_APP = 0 | 子窗口。 | 102| WINDOW_MANAGER_WINDOW_TYPE_MAIN = 1 | 主窗口。 | 103| WINDOW_MANAGER_WINDOW_TYPE_FLOAT = 8 | 悬浮窗口。 | 104| WINDOW_MANAGER_WINDOW_TYPE_DIALOG = 16 | 模态窗口。 | 105 106 107