erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-09-02 13:47:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

docs(web): more adjustments based on review comments

Browse source
This commit is contained in:
Eberhard Beilharz 2024-08-29 15:00:10 +07:00
parent 9fa3eb098a
commit dc265debd8
No known key found for this signature in database
GPG key ID: E9140597606020D3
1 changed files with 20 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
common/web/types/src/keyman-touch-layout/keyman-touch-layout-file.ts
View file

@ -7,9 +7,9 @@
// writing
//
/**
* On screen keyboard description consisting of specific layouts for tablet, phone,
* and desktop. Despite its name, this format is used for both touch layouts and
/**
* On screen keyboard description consisting of specific layouts for tablet, phone,
* and desktop. Despite its name, this format is used for both touch layouts and
* hardware-style layouts.
*/
export interface TouchLayoutFile {
@ -76,8 +76,8 @@ export interface TouchLayoutKey {
id?: TouchLayoutKeyId;
/** text to display on key cap */
text?: string;
/**
* the modifier combination (not layer) that should be used in key events,
/**
* the modifier combination (not layer) that should be used in key events,
* for this key, overriding the layer that the key is a part of.
*/
layer?: TouchLayoutLayerId;
@ -103,7 +103,7 @@ export interface TouchLayoutKey {
hint?: string;
};
/** special keys like framekeys, deadkeys, blank, etc. */
/** key type like regular key, framekeys, deadkeys, blank, etc. */
export const enum TouchLayoutKeySp {
normal=0,
/** A 'frame' key, such as Shift or Enter, which is styled accordingly; uses
@ -135,19 +135,22 @@ export type TouchLayoutKeyWidth = number; // 0-100000
/** defines a subkey */
export interface TouchLayoutSubKey {
/** key id: used to find key in VKDictionary */
/** key id: used to find key in VKDictionary, or a standard key from the K_ enumeration */
id: TouchLayoutKeyId;
/** text to display on key cap */
text?: string;
/** current layer */
/**
* the modifier combination (not layer) that should be used in key events,
* for this key, overriding the layer that the key is a part of.
*/
layer?: TouchLayoutLayerId;
/** next layer */
/** the next layer to switch to after this key is pressed */
nextlayer?: TouchLayoutLayerId;
/** font */
font?: TouchLayoutFont;
/** fontsize */
fontsize?: TouchLayoutFontSize;
/** special key */
/** the type of key */
sp?: TouchLayoutKeySp;
/** padding */
pad?: TouchLayoutKeyPad;
@ -161,18 +164,18 @@ export interface TouchLayoutSubKey {
export interface TouchLayoutFlick {
/** flick up (north) */
n?: TouchLayoutSubKey;
/** flick down */
/** flick down (south) */
s?: TouchLayoutSubKey;
/** flick right */
/** flick right (east) */
e?: TouchLayoutSubKey;
/** flick left */
/** flick left (west) */
w?: TouchLayoutSubKey;
/** flick up-right */
/** flick up-right (north-east) */
ne?: TouchLayoutSubKey;
/** flick up-left */
/** flick up-left (north-west) */
nw?: TouchLayoutSubKey;
/** flick down-right */
/** flick down-right (south-east) */
se?: TouchLayoutSubKey;
/** flick down-left */
/** flick down-left (south-west) */
sw?: TouchLayoutSubKey;
};