docs » hs.keycodes

A mapping from string representation of a key to its keycode, and vice versa.

• For example: keycodes[1] == "s", and keycodes["s"] == 1, and so on.
• This is primarily used by the hs.eventtap and hs.hotkey extensions.
• Valid strings are any single-character string, or any of the following strings:
• f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15,
• f16, f17, f18, f19, f20, pad., pad*, pad+, pad/, pad-, pad=,
• pad0, pad1, pad2, pad3, pad4, pad5, pad6, pad7, pad8, pad9,
• padclear, padenter, return, tab, space, delete, escape, help,
• home, pageup, forwarddelete, end, pagedown, left, right, down, up,
• shift, rightshift, cmd, rightcmd, alt, rightalt, ctrl, rightctrl,
• capslock, fn

Gets the name of the current keyboard layout

• None

• A string containing the name of the current keyboard layout

Gets the icon of the current keyboard layout

• None

• An hs.image object containing the icon, if available

Get current input method

• None

• Name of current input method, or nil

Get or set the source id for the keyboard input source

• sourceID - an optional string specifying the input source to set for keyboard input

• If no parameter is provided, returns a string containing the source id for the current keyboard layout or input method; if a parameter is provided, returns true or false specifying whether or not the input source was able to be changed.

Gets an hs.image object for a given keyboard layout or input method

• sourceName - A string containing the name of an input method or keyboard layout

• An hs.image object, or nil if no image could be found

• Not all layouts/methods have icons, so you should assume this will return nil at some point

Sets the function to be called when your input source (i.e. qwerty, dvorak, colemac) changes.

• fn - A function that will be called when the input source changes. No arguments are supplied to the function.

• None

• This may be helpful for rebinding your hotkeys to appropriate keys in the new layout
• Setting this will un-set functions previously registered by this function.

Gets all of the enabled keyboard layouts that the keyboard input source can be switched to

• sourceID - an optional boolean, default false, indicating whether the keyboard layout names should be returned (false) or their source IDs (true).

• A table containing a list of keyboard layouts enabled in System Preferences

• Only those layouts which can be explicitly switched to will be included in the table. Keyboard layouts which are part of input methods are not included. See hs.keycodes.methods.

Gets all of the enabled input methods that the keyboard input source can be switched to

• sourceID - an optional boolean, default false, indicating whether the keyboard input method names should be returned (false) or their source IDs (true).

• A table containing a list of input methods enabled in System Preferences

• Keyboard layouts which are not part of an input method are not included in this table. See hs.keycodes.layouts.

Changes the system keyboard layout

• layoutName - A string containing the name of an enabled keyboard layout

• A boolean, true if the layout was successfully changed, otherwise false

Changes the system input method

• methodName - A string containing the name of an enabled input method

• A boolean, true if the method was successfully changed, otherwise false