spiegel-keyman/web/docs/engine/reference/interface/context.md at 06768ee2a5a2cc31e3ddacb4c4b9d74ab957e036

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00

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
context (KC) (Deprecated)

Summary

(Deprecated) Gets context for an ongoing keyboard operation relative to the caret's present position.

Syntax

keyman.interface.context(n, ln, Pelem);

KeymanWeb.KC(n, ln, Pelem); // Shorthand

Parameters

n: Type: number; Relative position of the caret for the context retrieval operation.
ln: Type: number; Number of characters of text context to retrieve.
Pelem: Type: Element; The element being operated upon.

Return Value

string: The requested context text.

Description

For an example from Developer 'rules', a keyboard might implement the following rule

"abc" + "d" > context(2) "D"

by first checking that the initial context ("abc") matches and then using the following to fulfill the rule:

keyman.interface.output(3, Pelem, keyman.interface.context(2, 1, Pelem));
keyman.interface.output(0, Pelem, "D");

This operates by first replacing the original context "abc" with the requested subset of context(2), then outputting the character ("D") corresponding to the new keystroke.

1.4 KiB Raw Blame History