手册

命令说明

4422
文子
2020-08-21 21:59:17

命令

用途与说明
showicon 让已经隐藏的悬浮图标显示出来
hideicon 隐藏悬浮图标
iconshowing 判断悬浮图标是不是显示中(仅:http、ws,调用方式有效)
disableautoshow 禁止自动弹出功能。(输入法重启后恢复)
disableautohide 禁止自动隐藏功能。(输入法重启后恢复)
enableautoshow 开启自动弹出功能。
enableautohide 开启自动隐藏功能。
clearuserdb 清空记忆数据
sound 播放按键音。可以用于自己行开发的扩展插件。
toFront、toTop 键盘重新置顶
reset 重置输入法的输入状态,即等同于:“重输”、“重写” 按钮。
 
mode(name) 指定输入模式如:拼音py26, 笔画sk26, 手写hw26,英文en26,拼音九宫格py9,拼音全键盘py26,等等。

更多键盘名称请查看安装目录下的layouts文件夹内的.lay文件,.lay文件名就是键盘调用名。

skin(name) 指定当前皮肤
pos(x,y) 指定输入法位置
size(w,h) 指定输入法尺寸,支持百分比如:size(100%, 50%)表示宽度占屏幕宽度的100%即全屏,高度占一半。
autopos 自动获取鼠标位置,把键盘显示在鼠标下方
moffset 指定自动弹出时键盘位置的偏移量
adjust 当键盘超出屏幕时,可以用这个命令使它自动调整过来
setParent(hWnd)
(仅Windows可用)
键盘内嵌入到一个窗口,窗口句柄 hWnd 转成字符串。
  • hWnd 可以是16进制、10进制,16进制用0x开头,如:setParent(0x8498FDED)
  • hWnd 等于0,即还原输入法键盘取消内嵌模式。
setParent(clsName,winName)
(仅Windows可用)
同上,参数为,窗口ClassName 和 WindowName。

注意:使用setParent 后,宿主窗口关闭前一定要还原输入法取消内嵌模式,不然输入法窗口会跟着结束,可能造成错误。

sign(layName, txt, charset) 进入签名模式,使用方法请参考 help\Demo-Windows-C#,C++方法相同。
参数:
  • layName - 用于签名模式的布局文件名。自带有 hwSign.lay
  • txt - 自定义字符串,可以是人名,也可以是其它标记符,signDone通知时会回传
  • charset - 保留

注意:进入签名模式后,手写识别无候选显示。当关闭键盘、或者执行 signEnd 命令才会退出签名模式。

扩展:Linux 平台签名未完成,或者使用者可以自行扩展。重写signSender 插件即可,详细可以联系我们获取帮助。

signDone 签名完成,让输入法生成签名图,并发出消息给应用程序。请参考 Demo。
signEnd 退出签名模式。close 关闭键盘也会退出签名模式。
 
close、hide 关闭输入法界面
show、open 显示输入法
toggle 显示或隐藏键盘。当前状态是显示执行这个命令就是隐藏,当前状态是隐藏执行这个命令就是显示。
termination/exit 结束输入法进程
注意:请尽量避免使用这个命令。
config, option 弹出输入法设置界面
reconf 重新加载输入法设置
reskin 重新加载皮肤
png 设置键盘的背景图,必须是 png文件,并且文件必须在 pngs目录内。
toolbar(param)
  • toolbar(1): 显示Toolbar栏
  • toolbar(0):隐藏Toolbar栏
tbprofile(param) 让输入法加载一个Toolbar配置方案,如:tbprofile(profile1.ini)
capslock 设置拉丁键盘当前大小写状态
confset、wconfig 写配置,参考 Ini设置说明.htm 进行操作,通常用来实现一些比较高级的功能。
moveable(value) 设置键盘是否可以移动。
  • moveable(0) - 不可移动
  • moveable(1) - 可以移动
inputbox(param) 用于显示或隐藏临时输入框。当目标输入框被键盘挡住时可以打开临时输入框方便用户看到输入内容。

可用参数有,多个参数可以组合使用:

  1. ispw,临时框设置为密码模式。
  2. isnum,临时框设置为数字模式,输入内容只能是数字。
  3. max[len],设置最大输入长度。len 为长度,0表示无限制。
  4. row[count],设置临时输入框的行数。
  5. fsize[size],设置字体大小,size 为字体 pointSize。
  6. font[名称],设置字体名称,字符串,可以用十六进制表示,如宋体,可以写成:0x5B8B0x4F53。
  7. hint[提示内容],设置临时框的提示语,如:请输入密码,同样支持用十六进制表示。
  8. done,临时框是否显示 “完成” 按钮,点击完成按钮,就会把临时框的内容输出到目标框,并且关闭键盘。
  9. show,显示临时框。
  10. hide,隐藏临时框。
  11. fix,强制显示临时框,设置一次以后每次打开键盘,临时框都会显示,直到进程结束。
  12. rect[x'y'w'h],设置目标框的位置与大小,由输入法自动判断是不是挡住了目标输入框,如挡住了才显示临时框,x,y 是 左上角坐标,w, h, 是宽度与高度。
  13. sync,显示时同步目标输入框的内容到临时框,完成输入的时候,临时框的内容会同步到目标框。
  14. padding[L,T,R,B],设置临时输入框的四边padding,参数分别是:L 左边,T 上边,R 右边, B 下边

例子:

  1. 直接显示临时框:inputbox(show)
  2. 直接显示临时框,并设置最大长度为10:inputbox(show,max[10])
  3. 同时设置最大长度与提示语:inputbox(show,max[10],hint[请输入密码])
  4. 设置目标输入框的位置与大小,让输入法自动判断是不是要显示临时框:inputbox(rect[10,10,200,200])
moveable(value) 设置键盘是否可以移动。
  • moveable(0) - 不可移动
  • moveable(1) - 可以移动
 
showing 键盘显示返回 true,以下结果都是 json 格式
getpath 返回安装目录
getrect 返回键盘的 Rect 即:左,上,右,下
getsize 返回键盘的大小
getpos 返回键盘的位置坐标
getleft 返回键盘的X坐标
gettop 返回键盘的Y坐标
getwidth 返回键盘的宽度
getheight 返回键盘的高度