GM.registerMenuCommand: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m display title fix |
m Text replace - "{{Core samp" to "{{Samp" |
||
| Line 73: | Line 73: | ||
== Examples == | == Examples == | ||
{{ | {{Samp |1=<pre style="border: none; margin: inherit;">GM_registerMenuCommand("Hello, world (simple)", helloSimple);</pre>}} | ||
{{ | {{Samp |1=<pre style="border: none; margin: inherit;">GM_registerMenuCommand("Hello, world!", hello, "e", "control", "h");</pre>}} | ||
{{ | {{Samp |1=<pre style="border: none; margin: inherit;">GM_registerMenuCommand("Hello, world! (again)", hello2, "e", "shift alt", "w");</pre>}} | ||
[[#top|top]] | [[#top|top]] | ||
[[Category:API_Reference|R]] | [[Category:API_Reference|R]] | ||
Revision as of 19:36, 3 February 2010
Description
This API method allows user scripts to add a menu command to the "User Script Commands" submenu.
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.
Properties
commandName
- Value: String
- Usage:
commandName = "Some Name";
- Name to display in the "User Script Commands" submenu.
commandFunc
- Value: Function
- Usage:
commandFunc = function(){ /* some code */ };
- Function to call
accelKey
- Value: String
- Usage:
accelKey = "g";
- A single character or keycode that can trigger the command.
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.
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.
