mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-06 17:05:34 +00:00
6c145cb775
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
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
---
|
|
title: On-Screen Keyboard Module
|
|
---
|
|
|
|
The On-Screen Keyboard module is exposed to the developer as `window.keyman.osk`.
|
|
|
|
[`addEventListener` Function](addEventListener)
|
|
: Adds an event listener for user-handling of On-Screen keyboard events.
|
|
|
|
[`getRect` Function](getRect)
|
|
: Get absolute position and size of OSK window.
|
|
|
|
[`hide` Function](hide)
|
|
: Hide the OSK.
|
|
|
|
[`isEnabled` Function](isEnabled)
|
|
: Return the user-defined OSK visibility as set by prior calls to show or hide.
|
|
|
|
[`isVisible` Function](isVisible)
|
|
: Return the actual visibility of the On-Screen Keyboard.
|
|
|
|
[`removeEventListener` Function](removeEventListener)
|
|
: Removes a user-defined event handler.
|
|
|
|
[`restorePosition` Function](restorePosition)
|
|
: Move OSK back to default position, floating under active input element.
|
|
|
|
[`setPos` Function](setPos)
|
|
: Set absolute position and size of desktop OSK window, limited to screen.
|
|
|
|
[`setRect` Function](setRect)
|
|
: Set absolute position and size of desktop OSK window.
|
|
|
|
[`show` Function](show)
|
|
: Display, hide or toggle OSK visibility.
|
|
|
|
[`userLocated` Function](userLocated)
|
|
: 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](classes)
|
|
: 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.
|