9.4 DUIM-Frames Module

<command-table-menu-item>

Sealed instantiable class

Summary

The class of menu items in command tables.

Superclasses

<object>

Init-keywords

name:: An instance of type false-or(<string>). Default value: #f.
image:: An instance of type false-or(type-union(<string>, <image>)). Default value: #f
type:: An instance of type one-of(#"command", #"function", #"menu", #"divider").
value:: An instance of type <object>. Default value: #f.
options:: An instance of type <sequence>. Default value: #().
accelerator:: An instance of type false-or(<gesture>). Default value: #f.
mnemonic:: An instance of type false-or(<gesture>). Default value: #f.

Library

duim-frames

Module

duim-frames

Description

The class of menu items in command tables. This class models menu items, tool bar items, accelerators, and mnemonics for a command table entry.

The type: init-keyword denotes what type of menu item has been created. This is either #"command", #"function", #"menu", or #"divider".

When type: is #"command", value: must be one of the following:

A command (a list consisting of a command name followed by a list of the arguments for the command).
A command name. In this case, value behaves as though a command with no arguments was supplied.

When all the required arguments for the command are supplied, clicking on an item in the menu invokes the command immediately. Otherwise, the user is prompted for the remaining required arguments.

When type: is #"function", value: must be a function having indefinite extent that, when called, returns a command. The function is called with two arguments:

The gesture used to select the item (either a keyboard or button press event).
A "numeric argument".

When type: is #"menu", this indicates that a sub-menu is required, and value must be another command table or the name of another command table.

When type: is #"divider", some sort of a dividing line is displayed in the menu at that point. If a string is supplied using the options: init-keyword, it will be drawn as the divider instead of a line. If the look and feel provided by the underlying window system has no corresponding concept, #"divider" items may be ignored. When type: is #"divider", value: is ignored.

The accelerator: and mnemonic: init-keywords let you specify a keyboard accelerator and mnemonic for the menu item.

Operations

add-command-table-menu-item menu-item-accelerator menu-item-mnemonic menu-item-name menu-item-options menu-item-type menu-item-value