Get menu item key
Get menu item key ( menu ; menuItem {; process} ) : Integer
| Parameter | Type | Description | |
|---|---|---|---|
| menu | Integer, Text | → | Menu number or Menu reference |
| menuItem | Integer | → | Menu item number or -1 for the last item added |
| process | Integer | → | Process reference number |
| Function result | Integer | ← | Character code of standard shortcut key associated with the menu item |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The Get menu item key command returns the code of the Ctrl (Windows) or Command (Macintosh) shortcut for the menu item whose menu number or reference is passed in menu and whose item number is passed in menuItem. You can pass -1 in menuItem in order to indicate the last item added to menu.
If you omit the process parameter, Get menu item key applies to the menu bar for the current process. Otherwise, Get menu item key applies to the menu bar for the process whose reference number is passed in process.
Note: If you pass a MenuRef in menu, the process parameter serves no purpose and will be ignored.
If the menu item has no associated shortcut or if the menuItem parameter designates a hierarchical submenu, Get menu item key returns 0 (zero).
Example
To obtain the shortcut associated with a menu item, it is useful to implement a programming structure of the following type:
If(Get menu item key(mymenu;1)#0)
$modifiers:=Get menu item modifiers(mymenu;1)
Case of
:($modifiers=Option key mask)
...
:($modifiers=Shift key mask)
...
:($modifiers=Option key mask+Shift key mask)
...
End case
End if