FormIt.Shortcuts API

Description

Functions
json	FormIt.Shortcuts.GetShortcutKeys ()
	Get the shortcuts. More...
json	FormIt.Shortcuts.RestoreFromJSON (jsonStr)
	Restore the shortcuts in the given JSON string. More...
json	FormIt.Shortcuts.GetJSON ()
	Get the shortcuts as a JSON string. More...
json	FormIt.Shortcuts.GetKeycodeString (key, modifier)
	GetKeycodeString returns a human-readable keyboard shortcut string. More...

Function Documentation

json FormIt.Shortcuts.GetJSON

(

)

Get the shortcuts as a JSON string.

Returns

A JSON string

json FormIt.Shortcuts.GetKeycodeString	(	key	,
		modifier
	)

GetKeycodeString returns a human-readable keyboard shortcut string.

In: key, modifier

Parameters

[in]	key	int
[in]	modifier	int

Returns

a human-readable keyboard shortcut string.

json FormIt.Shortcuts.GetShortcutKeys

(

)

Get the shortcuts.

Example:

var shortcuts = FormIt.Shortcuts.GetShortcutKeys();
console.clear();
for (index in shortcuts)
{
    var pair = shortcuts[index];
    console.log(JSON.stringify(pair));
}

Returns

An array of command -> assigned keyboard keys

json FormIt.Shortcuts.RestoreFromJSON

(

jsonStr

)

Restore the shortcuts in the given JSON string.

Parameters

[in]

jsonStr

String

Returns

JSON_UNDEFINED, i.e. {}