Difference between revisions of "GM.registerMenuCommand"

From GreaseSpot Wiki
Jump to navigationJump to search
m (Arantius moved page GM registerMenuCommand to GM.registerMenuCommand: New GM-4 name with dot, not underscore.)
 
(36 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{underscore|title=GM_registerMenuCommand}}
__NOTOC__
== Description ==
== Description ==


This [[API_reference|API]] method allows user scripts to add a menu command to the [[Greasemonkey_Manual:Monkey_Menu#The_Menu|"User Script Commands" submenu]].
This method allows user scripts to add an item to the [[Greasemonkey_Manual:Monkey_Menu#The_Menu|User Script Commands]] menu.


[[#Examples|Examples]] | [[#Notes|Notes]]
Compatibility: [[Version_history#4.11|Greasemonkey 4.11+]]


== Syntax ==
== Syntax ==


'''GM_registerMenuCommand(''' ''commandName'', ''commandFunc'', ''accelKey'', ''accelModifiers'', ''accessKey'' ''')'''
{{Function|GM.registerMenuCommand|caption, commandFunc, accessKey}}
 
:Returns: Nothing
:Compatibility: [[Version_history#0.2.5|Greasemonkey 0.2.5+]]
 
:{| border="1" cellpadding="5"
|+ Parameters
!|'''Properties''' || !|'''Event Handlers'''
|-
| <code>[[#commandName |commandName]]</code> ||<code>[[#commandFunc|commandFunc]]</code>
|-
|<code>[[#accelKey |accelKey]]</code>
|-
|<code>[[#accelModifiers |accelModifiers]]</code>
|-
|<code>[[#accessKey |accessKey]]</code>
|}
:* All properties and event handlers are optional except [[#commandName|commandName]] and [[#commandFunc|commandFunc]].
 
[[#Description|top]]
=== Properties ===
----
==== <code>commandName</code> ====
:Value: String
:Usage: <code>'''commandName''' = "Some Name";</code>
 
:* Name to display in the [[Greasemonkey_Manual:Monkey_Menu#The_Menu|"User Script Commands" submenu]].
 
[[#Description|top]] | [[#Syntax|back]]''
 
==== <code>commandFunc</code> ====
:Value: Function
:Usage: <code>'''commandFunc''' = function(){ ''// Some code'' };</code>
 
:* Function to call
 
[[#Description|top]] | [[#Syntax|back]]
 
==== <code>accelKey</code> ====
:Value: String
:Usage: <code>'''accelKey''' = "g";</code>
 
:* A single character or keycode that can trigger the command.
 
[[#Description|top]] | [[#Syntax|back]]


==== <code>accelModifiers</code> ====
=== Arguments ===
:Value: String
:Usage: <code>'''accelModifiers''' = "control alt";</code>


:* A string listing modifiers that must be pressed with the [[#accelKey|accelKey]]. If there's more than one, then they should be separated with spaces. Available modifiers are: shift, alt, meta, control, and accel.
; <code>caption</code>
: <code>String</code> The caption to display on the menu item.
; <code>commandFunc</code>
: <code>Function</code> The function to call when this menu item is selected by the user.
; <code>accessKey</code>
: <code>String</code> A single character that can be used to select command when the menu is open. It should be a letter in the <code>caption</code>. [https://developer.mozilla.org/en/XUL/Attribute/accesskey]


[[#Description|top]] | [[#Syntax|back]]
==== History ====


==== <code>accessKey</code> ====
This method existed in a similar but different form before Greasemonkey 4.0.
:Value: String
:Usage: <code>'''accessKey''' = "g";</code>


:* A single character that can be used to jump to the command when the menu is open. It should be a letter in [[#commandName|commandName]].
== Returns ==


[[#Description|top]] | [[#Syntax|back]]
<code>undefined</code>


= Examples =
== Examples ==
<code><pre>GM_registerMenuCommand( "Hello, world!", hello, "e", "control", "h" );</pre></code>


<code><pre>GM_registerMenuCommand( "Hello, world! (again)", hello2, "e", "shift alt", "w" );</pre></code>
<pre class='sample'>GM_registerMenuCommand("Hello, world (simple)", () => alert("Hello, world!"));</pre>


<code><pre>GM_registerMenuCommand( "Hello, world (simple)", helloSimple );</pre></code>
<pre class='sample'>function hello() { ... }
GM_registerMenuCommand("Hello, world!", hello, "h");</pre>


[[#Description|top]]
[[Category:API_Reference|R]]


= Notes =
== See Also ==


[[#Description|top]]
The [[GM_config]] <code>@require</code> library is frequently used with <code>GM.registerMenuCommand</code>.
[[Category:API_Reference|G]]

Latest revision as of 21:10, 27 January 2021

Description

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

Compatibility: Greasemonkey 4.11+

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

This method existed in a similar but different form before Greasemonkey 4.0.

Returns

undefined

Examples

GM_registerMenuCommand("Hello, world (simple)", () => alert("Hello, world!"));
function hello() { ... }
GM_registerMenuCommand("Hello, world!", hello, "h");

See Also

The GM_config @require library is frequently used with GM.registerMenuCommand.