mirror of
https://github.com/keymanapp/keyman.git
synced 2026-09-28 10:37:41 +00:00
1f82507730
Deprecate the following obsolete functions and properties: * `keyman.helpURL` * `keyman.util.rgba` * `keyman.util.toFloat` * `keyman.util.toNumber` * `keyman.util.toNzString` Use correct language for code blocks in Keyman Engine for Web documentation. Test-bot: skip
51 lines
769 B
Markdown
51 lines
769 B
Markdown
---
|
|
title: osk.show Event
|
|
---
|
|
|
|
## Summary
|
|
|
|
Called when the OSK is displayed.
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
keyman.osk.addEventListener('show', function(obj) {
|
|
...
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
`obj`
|
|
: Type: `object`
|
|
: An object specifying the osk's display state information.
|
|
|
|
Available display state information:
|
|
|
|
|
|
|
|
`obj.x`
|
|
: `Number`
|
|
: The x-coordinate of the left side of the OSK.
|
|
|
|
`obj.y`
|
|
: `Number`
|
|
: The y-coordinate of the top of the OSK.
|
|
|
|
`obj.userLocated`
|
|
: `boolean`
|
|
: `true` if the OSK has been directly placed by the user.
|
|
|
|
|
|
|
|
### Return Value
|
|
|
|
`boolean`
|
|
: `true` if the event should continue processing, `false` if it should
|
|
not. Your event handler should return `true` aside from exceptional
|
|
circumstances.
|
|
|
|
## See also
|
|
|
|
* [`hide` event](hide)
|
|
|