Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 14.0 (current version)Version 10.0

On this page

IKeymanKeyboard Interface


Introduction

The IKeymanKeyboard interface describes a keyboard in Keyman Engine for Windows API. It is a base class and describes both installed keyboards and keyboard files.

Interface Hierarchy

IDispatch

IKeymanObject

IKeymanKeyboard

IKeymanKeyboardFile

IKeymanKeyboardFile2

IKeymanKeyboardInstalled

Properties

Bitmap read only : Returns the &bitmap icon from the keyboard file as an IPicture.

Copyright read only : Returns the &copyright string from the keyboard file.

DefaultBCP47Languages read only : Returns the set of default language ids for the keyboard as a space-separated list of BCP 47 codes. The first code in the list is the primary language.

DefaultHotkey read only : Returns the default hotkey for the keyboard.

DefaultPrimaryLanguage read only : Returns the default primary language id for the keyboard.

DefaultWindowsLanguages read only : Returns the set of default language ids for the keyboard as a space-separated list of hexadecimal strings.

Encodings read only : Returns the set of encodings supported by the keyboard layout.

Filename read only : Returns the fully-qualified filename of the keyboard file.

ID read only : Returns the identifier for the keyboard, which is the base name of the keyboard file without extension.

LayoutType read only : Returns the layout type of the keyboard as specified by the &mnemoniclayout store.

Message read only : Returns the &message string from the keyboard file.

Name read only : Returns the &name from the keyboard file.

Version read only : Returns the &keyboardversion string from the keyboard file.

Methods

GetCharsUsed() : Returns a string with every Unicode character used or generated by the keyboard.