event-synonym

Generic Function

Package: common-graphics

Arguments: menu-item

Returns the value of the event-synonym property of the argument menu-item. The value of this property, if true, should be the key-chord that will invoke this menu-item's command, assuming that the keyboard focus is inside the window whose menu-bar contains this menu-item. An event-synonym always contains a single main non-shift key, plus an optional set of one or more shift keys. If no shift keys are used, then the event-synonym consists entirely of a character name like #\A or a key name like vk-comma or vk-f3. If shift keys are used, then the event-synonym is a list whose members are the names of the shift keys (in any order) and the main non-shift key as the last member. The available shift key names are control-key, alt-key, and shift-key, and they may be used in any combination. Normally, typable characters are used only with either control-key or alt-key (or both), since otherwise the characters would not be typable as text.

Here are some example event synonyms:

#\A (not recommended since A cannot now be entered as a letter)

vk-period (not recommended since . cannot now be entered as a letter)

vk-f3

(control-key #\A)

(control-key vk-period)

(alt-key shift-key #\A)

(control-key alt-key shift-key vk-f7)

event-synonym is a property of the menu-item class.

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Created 2000.10.5.