spiegel-keyman/web/docs/engine/reference/interface/deadkeyMatch.md at 54d7423619be21acee9affb0abeab0aef5cca32c

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-15 21:29:23 +00:00

Marc Durdin 1f82507730 docs(web): deprecate unused and obsolete API endpoints and docs cleanup

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

2026-08-12 16:07:22 +02:00

1.6 KiB

Raw Blame History

title
deadkeyMatch (KDM) (Deprecated)

Summary

(Deprecated) Deadkey matching: Seeks to match the deadkey state dk at the relative caret position n.

Syntax

keyman.interface.deadkeyMatch(n, Pelem, dk);

KeymanWeb.KDM(n, Pelem, dk); // Shorthand

Parameters

n: Type: number; The position to match, relative to the caret's present position.
Pelem: Type: Element; The HTML element receiving input.
dk: Type: number; The deadkey id.

Return Value

boolean: true if the specified deadkey exists at the specified input location, otherwise false.

Description

Deadkeys are useful for tracking hidden state information used to modify future keystrokes. For example, rather than using

"`" + "a" = "à"

to combine two visible characters, certain applications may desire to keep the "`" character hidden with a rule such as

+ '`' > dk(backquote)

...

dk(backquote) + "a" > "à"

The Developer compiler then generates a unique id for the deadkey state - say, 0, and in order to detect the deadkey associated with the '`' character, compiles the dk(backquote) check to

keyman.interface.deadkeyMatch(0, Pelem, 0)

which detects the existing deadkey (the second zero above) at the caret's present position (the first zero above).

For versions 10.0 and later, please consider use of fullContextMatch() instead.

1.6 KiB Raw Blame History