[ { "Constant" : [ ], "submodules" : [ ], "Function" : [ ], "Variable" : [ ], "stripped_doc" : [ ], "Deprecated" : [ ], "type" : "Module", "desc" : "Modal keybindings environment management. Just an wrapper of `hs.hotkey.modal`.", "Constructor" : [ ], "doc" : "Modal keybindings environment management. Just an wrapper of `hs.hotkey.modal`.\n\nDownload: [https:\/\/github.com\/Hammerspoon\/Spoons\/raw\/master\/Spoons\/ModalMgr.spoon.zip](https:\/\/github.com\/Hammerspoon\/Spoons\/raw\/master\/Spoons\/ModalMgr.spoon.zip)", "Method" : [ { "desc" : "Create a new modal keybindings environment", "stripped_doc" : [ "Create a new modal keybindings environment", "" ], "parameters" : [ " * id - A string specifying ID of new modal keybindings" ], "doc" : "Create a new modal keybindings environment\n\nParameters:\n * id - A string specifying ID of new modal keybindings", "notes" : [ ], "signature" : "ModalMgr:new(id)", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:new(id)", "name" : "new" }, { "desc" : "Toggle the cheatsheet display of current modal environments's keybindings.", "stripped_doc" : [ "Toggle the cheatsheet display of current modal environments's keybindings.", "" ], "parameters" : [ " * iterList - An table specifying IDs of modal environments or active_list. Optional, defaults to all active environments.", " * force - A optional boolean value to force show cheatsheet, defaults to `nil` (automatically)." ], "doc" : "Toggle the cheatsheet display of current modal environments's keybindings.\n\nParameters:\n * iterList - An table specifying IDs of modal environments or active_list. Optional, defaults to all active environments.\n * force - A optional boolean value to force show cheatsheet, defaults to `nil` (automatically).", "notes" : [ ], "signature" : "ModalMgr:toggleCheatsheet([idList], [force])", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:toggleCheatsheet([idList], [force])", "name" : "toggleCheatsheet" }, { "desc" : "Activate all modal environment in `idList`.", "stripped_doc" : [ "Activate all modal environment in `idList`.", "" ], "parameters" : [ " * idList - An table specifying IDs of modal environments", " * trayColor - An optional string (e.g. #000000) specifying the color of modalTray, defaults to `nil`.", " * showKeys - A optional boolean value to show all available keybindings, defaults to `nil`." ], "doc" : "Activate all modal environment in `idList`.\n\nParameters:\n * idList - An table specifying IDs of modal environments\n * trayColor - An optional string (e.g. #000000) specifying the color of modalTray, defaults to `nil`.\n * showKeys - A optional boolean value to show all available keybindings, defaults to `nil`.", "notes" : [ ], "signature" : "ModalMgr:activate(idList, [trayColor], [showKeys])", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:activate(idList, [trayColor], [showKeys])", "name" : "activate" }, { "desc" : "Deactivate modal environments in `idList`.", "stripped_doc" : [ "Deactivate modal environments in `idList`.", "" ], "parameters" : [ " * idList - An table specifying IDs of modal environments" ], "doc" : "Deactivate modal environments in `idList`.\n\nParameters:\n * idList - An table specifying IDs of modal environments", "notes" : [ ], "signature" : "ModalMgr:deactivate(idList)", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:deactivate(idList)", "name" : "deactivate" }, { "desc" : "Deactivate all active modal environments.", "stripped_doc" : [ "Deactivate all active modal environments." ], "parameters" : [ ], "doc" : "Deactivate all active modal environments.", "notes" : [ ], "signature" : "ModalMgr:deactivateAll()", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:deactivateAll()", "name" : "deactivateAll" } ], "Command" : [ ], "Field" : [ ], "items" : [ { "desc" : "Activate all modal environment in `idList`.", "stripped_doc" : [ "Activate all modal environment in `idList`.", "" ], "parameters" : [ " * idList - An table specifying IDs of modal environments", " * trayColor - An optional string (e.g. #000000) specifying the color of modalTray, defaults to `nil`.", " * showKeys - A optional boolean value to show all available keybindings, defaults to `nil`." ], "doc" : "Activate all modal environment in `idList`.\n\nParameters:\n * idList - An table specifying IDs of modal environments\n * trayColor - An optional string (e.g. #000000) specifying the color of modalTray, defaults to `nil`.\n * showKeys - A optional boolean value to show all available keybindings, defaults to `nil`.", "notes" : [ ], "signature" : "ModalMgr:activate(idList, [trayColor], [showKeys])", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:activate(idList, [trayColor], [showKeys])", "name" : "activate" }, { "desc" : "Deactivate modal environments in `idList`.", "stripped_doc" : [ "Deactivate modal environments in `idList`.", "" ], "parameters" : [ " * idList - An table specifying IDs of modal environments" ], "doc" : "Deactivate modal environments in `idList`.\n\nParameters:\n * idList - An table specifying IDs of modal environments", "notes" : [ ], "signature" : "ModalMgr:deactivate(idList)", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:deactivate(idList)", "name" : "deactivate" }, { "desc" : "Deactivate all active modal environments.", "stripped_doc" : [ "Deactivate all active modal environments." ], "parameters" : [ ], "doc" : "Deactivate all active modal environments.", "notes" : [ ], "signature" : "ModalMgr:deactivateAll()", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:deactivateAll()", "name" : "deactivateAll" }, { "desc" : "Create a new modal keybindings environment", "stripped_doc" : [ "Create a new modal keybindings environment", "" ], "parameters" : [ " * id - A string specifying ID of new modal keybindings" ], "doc" : "Create a new modal keybindings environment\n\nParameters:\n * id - A string specifying ID of new modal keybindings", "notes" : [ ], "signature" : "ModalMgr:new(id)", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:new(id)", "name" : "new" }, { "desc" : "Toggle the cheatsheet display of current modal environments's keybindings.", "stripped_doc" : [ "Toggle the cheatsheet display of current modal environments's keybindings.", "" ], "parameters" : [ " * iterList - An table specifying IDs of modal environments or active_list. Optional, defaults to all active environments.", " * force - A optional boolean value to force show cheatsheet, defaults to `nil` (automatically)." ], "doc" : "Toggle the cheatsheet display of current modal environments's keybindings.\n\nParameters:\n * iterList - An table specifying IDs of modal environments or active_list. Optional, defaults to all active environments.\n * force - A optional boolean value to force show cheatsheet, defaults to `nil` (automatically).", "notes" : [ ], "signature" : "ModalMgr:toggleCheatsheet([idList], [force])", "type" : "Method", "returns" : [ ], "def" : "ModalMgr:toggleCheatsheet([idList], [force])", "name" : "toggleCheatsheet" } ], "name" : "ModalMgr" } ]