SoMenuItem Class Reference
[Dialog]
Abstract class for all menu item nodes.
More...
#include <DialogViz/dialog/SoMenuItem.h>
Detailed Description
Abstract class for all menu item nodes.
SoMenuItem is the abstract class for all menu item nodes. Menu item nodes are added in an SoMenuPopup.
For all of the derived classes, it is possible to define a mnemonic character and an accelerator key combination. (Note: SoMenuPopup cannot have an accelerator key combination). The mnemonic character, if any, is underlined in the label string. The purpose of menu accelerators is to allow the user to activate a menu item without opening any menus. Instead, the user can do it by using keyboard shortcuts. These key sequences are aligned on the right of the menu items.
To define a mnemonic and an accelerator, simply define the label field as follows:
- Use the "&" character before the character you want to use as a mnemonic. For example, for a menu label defined by "Open &File", the "F" character will be underlined.
- To register an accelerator, you must end your label with a block that begins with "\\t". For example, "Open\\tCtrl+O" registers the Ctrl+O key combination. Any time you press the Ctrl-O keyboard sequence, the action associated with this menu item is done. Available control keys are Alt, Ctrl, and Shift (and Meta on UNIX platforms). The key to press (e.g., O) must be at the end of the sequence.
The following examples show how accelerators must be formatted:
* "&Open\\tCtrl+O"
* "&Save\\tCtrl+S"
* "&Save As...\\tCtrl+Alt+S"
* "New\\tF12"
* ...
SEE ALSO
SoMenuBar, SoMenuCheckBox, SoMenuCheckBoxLauncher, SoMenuPopup, SoMenuPushButton, SoMenuPushButtonLauncher, SoMenuFileSelection, SoMenuRadioButtons, SoMenuSeparator
The documentation for this class was generated from the following file:
- DialogViz/dialog/SoMenuItem.h