mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-21 07:47:40 +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
31 lines
501 B
Markdown
31 lines
501 B
Markdown
---
|
|
title: osk.helpclick Event
|
|
---
|
|
|
|
## Summary
|
|
|
|
Called upon user request for the UI to present a help page.
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
keyman.osk.addEventListener('helpclick', function() {
|
|
...
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
None.
|
|
|
|
### 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.
|
|
|
|
## Description
|
|
|
|
This event is raised whenever the user wishes to access help
|
|
information.
|