-
Notifications
You must be signed in to change notification settings - Fork 301
API Documentation of heX (Simplified Chinese)
heX API 说明 Home
heX 内置的所有方法及属性均挂载在 window 对象的 hex 对象下。事件可以通过监听 window 对象来响应。
- 方法列表
- restore()
- move()
- size()
- minimize()
- maximize()
- close()
- showSystemMenu(x, y)
- deleteSystemCommand(command)
- enableSystemCommand(command, enabled)
- insertSystemCommand(command, beforeCommand)
- setPopupFormSize(width, height)
- setPopupFormPosition(x, y)
- sizeTo(width, height)
- moveTo(x, y)
- focusForm()
- setAsTitleBarAreas(x, y)
- setAsNonBorderAreas(x, y)
- setAsSystemMenuIconAreas(x, y)
- getSize()
- getPosition()
- getWorkspaceRect()
- setFormIcon(path)
- terminate()
- cancelMode()
- getMaximizedAdjustedBorderWidth()
- updateManifest()
- 属性列表
- 事件列表
恢复当前窗口。
移动当前窗口。
调整当前窗口大小。
最小化当前窗口。
最大化当前窗口。
关闭当前窗口。
在指定位置弹出系统菜单。若菜单成功弹出则返回 true，否则返回 false。
-
x（整型） - 菜单弹出 X 轴位置； -
y（整型） - 菜单弹出 Y 轴位置。若参数个数小于 2 个或者参数不为整型则返回undefined。
删除指定的系统菜单项 command （整型）。若菜单项成功删除则返回 true，否则返回 false。若参数个数小于 2 个或者参数不为整型则返回 undefined。
command 参数：
- 0 = RESTORE 恢复
- 1 = MOVE 移动
- 2 = SIZE 调整大小
- 3 = MINIMIZE 最小化
- 4 = MAXIMIZE 最大化
- 5 = CLOSE 关闭
使能指定的系统菜单项 command （整型） 为 enabled （布尔）。返回上一次的设定值。若参数个数小于 2 个或者参数类型不符则返回 undefined。
在指定的系统菜单项 beforeCommand （整型）前插入系统菜单项 command （整型）。若菜单项成功插入则返回 true，否则返回 false。
设置即将弹出的窗口的初始宽度 width （整型）及高度 height （整型）。此方法需要在 window.open() 之前调用。
设置即将弹出的窗口的初始 X （整型）轴及 Y （整型）轴位置。此方法需要在 window.open() 之前调用。
为窗口设置新的宽度 width （整型）和高度 height （整型）。返回一个对象，属性包含窗口原来的宽度及高度。若参数个数小于 2 个或者参数不为整型则返回 undefined。
为窗口设置新的 X （整型）轴和 Y （整型）轴的位置。返回一个对象，属性包含窗口原来的 X 轴和 Y 轴的位置。若参数个数小于 2 个或者参数不为整型则返回 undefined。
将窗口设置到最前端。若设置成功则返回 true。
将指定坐标 x （整型） y （整型） 位置设置为窗口的非客户区。若设置成功则返回 true。客户区的概念参见：http://msdn.microsoft.com/en-us/library/windows/desktop/dd162743(v=vs.85).aspx。
将指定坐标 x （整型） y （整型） 位置设置为窗口的非边框区域。
将指定坐标 x （整型） y （整型） 位置设置为窗口的系统图标区域。
返回一个对象，包括当前窗口的宽度 width （整型）与高度 height （整型）。
返回一个对象，包括当前窗口的 X （整型）周与 Y （整型）轴位置。还可能是下面的值：
-
SYSTEMDEFAULT(-1) 系统默认 -
PARENTCENTERED(-2) 父窗口中心 -
SCREENCENTERED(-3) 屏幕中心
返回一个对象，包括当前窗口所在屏幕的 RECT 信息—— left （整型） top （整型） right （整型） bottom （整型）。
为当前窗口设置一个 path （字符串）指定路径下的图标。
终结当前应用程序。
触发系统的 CANCELMODE 消息。参见：http://msdn.microsoft.com/en-us/library/windows/desktop/ms632615(v=vs.85).aspx。
返回最大化后溢出屏幕范围的边框宽度。只针对开启了 Aero 的 Windows。
更新修改后的 hex.manifest 对象到 manifest.json 中。
用于 getPosition() 方法返回值。此类属性为只读属性。
-
SYSTEMDEFAULT(-1) 系统默认 -
PARENTCENTERED(-2) 父窗口中心 -
SCREENCENTERED(-3) 屏幕中心
用于 formActivation 属性返回值。此类属性为只读属性。
-
ACTIVATED(0) 激活 -
INACTIVATED(-1) 未激活
用于 formState 属性返回值。此类属性为只读属性。
-
NORMAL(0) 常态 -
MINIMIZED(1) 最小化的 -
MAXIMIZED(2) 最大化的 -
HIDDEN(3) 隐藏 -
FULLSCREEN(4) 全屏
用于 deleteSystemCommand(command) enableSystemCommand(command, enabled) insertSystemCommand(command, beforeCommand) 方法返回值。此类属性为只读属性。
-
RESTORE(0) 恢复 -
MOVE(1) 移动 -
SIZE(2) 调整大小 -
MINIMIZE(3) 最小化 -
MAXIMIZE(4) 最大化 -
CLOSE(5) 关闭
返回当前程序所在目录。此属性为只读属性。
返回当前窗口的显示状态 state。
返回当前窗口的激活状态 activation。此属性为只读属性。
返回当前窗口的使能状态。true 代表窗口可用。
返回当前窗口是否总在最前。true 代表总在最前。
返回当前窗口的透明度。取值范围 0（全透明） - 255（不透明），仅当 manifest.json 中 transparency 不为 none 时有效。
返回当前窗口的最小宽度。若设置为 NONE (-1) 则忽略此设置。
返回当前窗口的最小高度。若设置为 NONE (-1) 则忽略此设置。
返回当前窗口的最大宽度。若设置为 NONE (-1) 则忽略此设置。
返回当前窗口的最大高度。若设置为 NONE (-1) 则忽略此设置。
返回一个对象，包含 manifest.json 内容。此对象可以被修改，但必须通过 hex.updateManifest() 方法将修改保存到文件中。
-
command整型 系统菜单项 在系统菜单命令被执行之前触发。仅 manifest.json 中hook_system_command为true时有效。
-
command整型 系统菜单项 在系统菜单命令被执行之后触发。仅 manifest.json 中hook_system_command为true时有效。
在窗口位置及尺寸发生变化时触发。
-
activated布尔 窗口是否被激活
在窗口激活状态发生变化时触发。
在菜单关闭时触发。
-
aero布尔 Aero 是否开启 在 Aero 状态改变时触发。仅在支持 Aero 的 Windows 下有效。
在鼠标移出窗口时触发。
-
command整型 导致窗口状态改变的系统菜单项 在窗口状态发生变化是触发。