FormIt Plugin API v25.0.0 (2025.0.0)
Loading...
Searching...
No Matches
FormIt.Shortcuts API

Description

Functions

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

Function Documentation

◆ GetJSON()

json FormIt.Shortcuts.GetJSON ( )

Get the shortcuts as a JSON string.

Returns
A JSON string

◆ GetKeycodeString()

json FormIt.Shortcuts.GetKeycodeString ( key  ,
modifier   
)

GetKeycodeString returns a human-readable keyboard shortcut string.

In: key, modifier

Parameters
[in]keyint
[in]modifierint
Returns
a human-readable keyboard shortcut string.

◆ GetShortcutKeys()

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));
}
FormIt.Shortcuts namespace.
Definition jsapi_include.dox:2821
FormIt namespace.
Definition jsapi_include.dox:1508
Returns
An array of command -> assigned keyboard keys

◆ RestoreFromJSON()

json FormIt.Shortcuts.RestoreFromJSON ( jsonStr  )

Restore the shortcuts in the given JSON string.

Parameters
[in]jsonStrString
Returns
JSON_UNDEFINED, i.e. {}