GM registerMenuCommand
From GreaseSpot
- The correct title of this article is GM_registerMenuCommand. The substitution or omission of an _ is due to technical restrictions.
 Greasemonkey Manual |
| Using Greasemonkey |
|---|
| Installing Scripts |
| Manage Dialog |
| Monkey Menu |
| User Script Authoring |
| Editing |
| Other Useful Tools |
| Environment |
| API |
| User Contributions |
| Code Snippets |
[edit] Description
This API method allows user scripts to add a menu command to the "User Script Commands" submenu.
[edit] Syntax
GM_registerMenuCommand( commandName, commandFunc, accelKey, accelModifiers, accessKey )
- Value: Function
- Returns: undefined
- Compatibility: Greasemonkey 0.2.5+
Parameters Properties Event Handlers commandNamecommandFuncaccelKeyaccelModifiersaccessKey
- All properties and event handlers are optional except commandName and commandFunc.
[edit] Properties
[edit] commandName
- Value: String
- Usage:
commandName = "Some Name";
- Name to display in the "User Script Commands" submenu.
[edit] commandFunc
- Value: Function
- Usage:
commandFunc = function(){ /* some code */ };
- Function to call
[edit] accelKey
- Value: String
- Usage:
accelKey = "g";
- A single character or keycode that can trigger the command.
[edit] accelModifiers
- Value: String
- Usage:
accelModifiers = "control alt";
- A string listing modifiers that must be pressed with the accelKey. If there's more than one, then they should be separated with spaces. Available modifiers are: shift, alt, meta, control, and accel.
[edit] accessKey
- Value: String
- Usage:
accessKey = "g";
- A single character that can be used to jump to the command when the menu is open. It should be a letter in commandName.
[edit] Examples
GM_registerMenuCommand("Hello, world (simple)", helloSimple);
GM_registerMenuCommand("Hello, world!", hello, "e", "control", "h");
GM_registerMenuCommand("Hello, world! (again)", hello2, "e", "shift alt", "w");
