GM.registerMenuCommand

From GreaseSpot Wiki
Revision as of 14:27, 10 September 2011 by Arantius (talk | contribs) (Reverted edits by 222.221.75.56 (talk) to last revision by Arantius)
Jump to navigationJump to search


Description

This method allows user scripts to add an item to the User Script Commands menu.

Compatibility: Greasemonkey 0.2.5+

Syntax

function GM_registerMenuCommand( caption, commandFunc, accessKey )

Arguments

caption
String The caption to display on the menu item.
commandFunc
Function The function to call when this menu item is selected by the user.
accessKey
String A single character that can be used to select command when the menu is open. It should be a letter in the caption. [1]

History

In Greasemonkey 0.9.2, this API was changed. Previously, it accepted five parameters including accelKey and accelModifiers which have been removed. See this page's history for a description of them. If a script passes all five parameters, in the old style, then the fifth argument is used for accessKey.

Returns

undefined

Examples

GM_registerMenuCommand("Hello, world (simple)", helloSimple);
GM_registerMenuCommand("Hello, world!", hello, "h");
GM_registerMenuCommand("Hello, world! (again)", hello2, "e", "shift alt", "w");

The last example is in the pre-0.9.2 format. The 4th and 5th arguments will be ignored in recent versions of Greasemonkey.

See Also

The GM_config @require library can handle many of the tasks that GM_registerMenuCommand is otherwise used for, in a more user-friendly manner.