LoadUserMenu

LuaFAR for Editor

LoadUserMenu


menuItems, commands, hotKeys, handlers = utils.LoadUserMenu (FileName)

Parameters:
  FileName:  string (filename relative to the plugin's directory;
                     usually it is "_usermenu.lua")

Returns:
  menuItems: table with the following structure:
               { editor={},viewer={},panels={},config={},dialog={} }

  commands:  table with the following structure:
               { <command1>={}, ..., <commandN>={} }

  hotKeys:   table with the following structure:
               { <hotkey1>={}, ..., <hotkeyN>={} }

  handlers:  table with the following structure:
               { EditorInput={},EditorEvent={},ViewerEvent={},ExitScript={} }

Description:
  1. An environment table env containing all the Installation functions is created.
  2. env.AddUserFile(FileName) is run.