spiegel-keyman/web/docs/engine/reference/interface/deleteContext.md
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.2 KiB

title
deleteContext (KDC)

Summary

Context deletion - removes the specified number of deadkeys and characters from before the caret.

Syntax

keyman.interface.deleteContext(dn, Pelem);

or

KeymanWeb.KDC(n, Pelem); // Shorthand

Parameters

dn
Type: number
The number of entries (deadkeys, characters) to be deleted from the current context.
Pelem
Type: Element
The element being operated upon.

Return Value

undefined

Description

This is a core element of keyboard input management within KeymanWeb introduced with version 10. It is utilized to manage the deletion of context in a deadkey-aware manner, in parallel to keyman.interface.fullContextMatch. For comparison with Developer 'rules' from keyboard source code...

store(pair_1) 'uU'
store(pair_2) 'lL'

c Lots of keyboard rules...

'nul' dk(nothing) + '.' > nul

would have a rule output as follows:

// Context is length four (three characters + one deadkey), so we delete all four.
keyman.interface.deleteContext(4, element);

See also