menu-item-help

Arguments: owner-window-or-screen menu menu-item

This generic function is called whenever the user presses the F1 key while a pop-up-menu or pull-down-menu is displayed and one of the menu items is highlighted. An application can add menu-item-help methods to show help for the menu itself or for the currently highlighted menu-item on the menu.

owner-window-or-screen is the window that owns the menu (see the stream argument to open-menu). menu is the menu that is currently displayed. menu-item is the menu-item that is currently highlighted on the menu. (If no menu-item is highlighted, then menu-item-help is not called.)

The built-in Common Graphics methods do nothing, though the IDE's menu-bar implements a menu-item-help method to show HTML help on the entire pull-down menu being displayed (since there are not individual pages for each menu-item).

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.2 page.
Created 2012.5.30.