Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 18.0Version 17.0 (current version)Version 16.0Version 15.0Version 14.0Version 13.0Version 12.0Version 11.0Version 10.0

On this page

You are viewing an incomplete pre-release version of this documentation. Click here to open the current version, 17.0.

registerStub (KRS)


Summary

Registers the keyboard stub or returns true if already registered.

Syntax

keyman.interface.registerStub(Pstub);

or

KeymanWeb.KRS(Pstub); // Shorthand

Parameters

Pstub
Type: Object
A keyboard stub object representing the keyboard's basic lookup parameters.

Return Value

optional number
1 if the keyboard is preregistered, otherwise null.

Description


Note: This only registers the stub with KeymanWeb, allowing it to later request the keyboard from the server or filesystem upon demand in order to complete the linking process.


The keyman.interface.registerStub function is typically called on the user's behalf by the keyman.addKeyboards() function.