erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/web/docs/engine/reference/osk/index.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo 
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

1.4 KiB
Raw Blame History

title
On-Screen Keyboard Module

The On-Screen Keyboard module is exposed to the developer as window.keyman.osk.

addEventListener Function
Adds an event listener for user-handling of On-Screen keyboard events.
getRect Function
Get absolute position and size of OSK window.
hide Function
Hide the OSK.
isEnabled Function
Return the user-defined OSK visibility as set by prior calls to show or hide.
isVisible Function
Return the actual visibility of the On-Screen Keyboard.
removeEventListener Function
Removes a user-defined event handler.
restorePosition Function
Move OSK back to default position, floating under active input element.
setPos Function
Set absolute position and size of desktop OSK window, limited to screen.
setRect Function
Set absolute position and size of desktop OSK window.
show Function
Display, hide or toggle OSK visibility.
userLocated Function
Determine whether or not the OSK has been moved from its default position by the user.
Class Names and Identifiers for On-Screen Keyboard and Other KeymanWeb Elements
The appearance of the KeymanWeb on-screen keyboard, menu amd other elements can be customized by a web designer by redefining (or adding to) the default styles.