Class KeyboardLayoutService

Index

Constructors

Properties

keyboardLayoutChanged keyValidator? layoutChangeNotifier layoutProvider

Accessors

onKeyboardLayoutChanged

Methods

getCharacterIndex getKeyboardCharacter initialize resolveKeyCode shouldIncludeKey transformKeyCode transformNativeLayout updateLayout validateKeyCode

Constructors

constructor

new KeyboardLayoutService(): KeyboardLayoutService
Returns KeyboardLayoutService

Properties

`Protected`keyboardLayoutChanged

keyboardLayoutChanged: Emitter<KeyboardLayout> = ...

`Protected` `Optional` `Readonly`keyValidator

keyValidator?: KeyValidator

`Protected` `Readonly`layoutChangeNotifier

layoutChangeNotifier: KeyboardLayoutChangeNotifier

`Protected` `Readonly`layoutProvider

layoutProvider: KeyboardLayoutProvider

Accessors

onKeyboardLayoutChanged

get onKeyboardLayoutChanged(): Event<KeyboardLayout>
Returns Event<KeyboardLayout>
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:62

Methods

`Protected`getCharacterIndex

getCharacterIndex(key: Key, shift?: boolean): number
Parameters
- key: Key
- Optionalshift: boolean
Returns number
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:221

getKeyboardCharacter

getKeyboardCharacter(key: Key): string
Return the character shown on the user's keyboard for the given key. Use this to determine UI representations of keybindings.
Parameters
- key: Key
Returns string
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:98

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:66

resolveKeyCode

resolveKeyCode(inCode: KeyCode): KeyCode
Resolve a KeyCode of a keybinding using the current keyboard layout. If no keyboard layout has been detected or the layout does not contain the key used in the KeyCode, the KeyCode is returned unchanged.
Parameters
- inCode: KeyCode
Returns KeyCode
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:77

`Protected`shouldIncludeKey

shouldIncludeKey(code: string): boolean
Parameters
- code: string
Returns boolean
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:185

`Protected`transformKeyCode

transformKeyCode(
    inCode: KeyCode,
    mappedCode: KeyCode,
    keyNeedsShift: boolean,
): undefined | KeyCode
Parameters
- inCode: KeyCode
- mappedCode: KeyCode
- keyNeedsShift: boolean
Returns undefined | KeyCode
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:135

`Protected`transformNativeLayout

transformNativeLayout(nativeLayout: NativeKeyboardLayout): KeyboardLayout
Parameters
- nativeLayout: NativeKeyboardLayout
Returns KeyboardLayout
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:151

`Protected`updateLayout

updateLayout(newLayout: NativeKeyboardLayout): KeyboardLayout
Parameters
- newLayout: NativeKeyboardLayout
Returns KeyboardLayout
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:53

validateKeyCode

validateKeyCode(keyCode: KeyCode): void
Called when a KeyboardEvent is processed by the KeybindingRegistry. The KeyValidator may trigger a keyboard layout change.
Parameters
- keyCode: KeyCode
Returns void
- Defined in packages/core/src/browser/keyboard/keyboard-layout-service.ts:123