UIcmdList

Synopsis

the parent object of all UIcmds and UIoptions in a menu

group+OPort UIcmdList<NEcolor0=0x00ffff,is_val_func=1,export_all=1> {
string label;
Boolean+opt radioBehavior;
Boolean+opt tearOff<NEvisible=0>;
Boolean+opt isHelpCmd;
string+opt accelerator;
string+opt acceleratorText;
group+IPort2 &cmdList<NEcolor0=0x00ffff>[] {
string label;
Boolean+opt radioBehavior;
Boolean+opt tearOff<NEvisible=0>;
int+opt dims;
Boolean+opt isHelpCmd;
string+opt accelerator;
string+opt acceleratorText;
group+opt & cmdList[] {
string label;
Boolean+opt radioBehavior;
Boolean+opt tearOff<NEvisible=0>;
int+opt dims;
Boolean+opt isHelpCmd;
string+opt accelerator;
string+opt acceleratorText;
group+opt & cmdList[] {
string label;
Boolean+opt radioBehavior;
Boolean+opt tearOff<NEvisible=0>;
int+opt dims;
Boolean+opt isHelpCmd;
string+opt accelerator;
string+opt acceleratorText
group+opt & cmdList[];
};
};
};
};

Description

UIcmdList is the parent object of all UIcmds and UIoptions used in menus and other situations that require a list of commands.

Subobjects

label

String. Sets the label text for a cascading pulldown menu.

radioBehavior

Boolean. This subobject determines if the menu options behave as radio buttons or as simple options. Radio buttons permit only a single option to be selected at a time. 0= off (multiple selections); 1= on (radio buttons). The default is 0.

tearOff

Boolean. When on, the menu presented by the UIcmdList can be "torn off" the menu bar and reparented by the window manager. 0= off (no tear off behavior), 1= on (tearoff enabled). The default is off.

isHelpCmd

Boolean. When on, indicates that this menu is the "Help" menu at the right of the Network Editor's top menu bar. 0= off (menu in normal position on left side of menu bar); 1= on (menu on right side of menu bar). The default is off.

accelerator

String. Sets the accelerator on a UIcmd in a menu. An accelerator is a keystroke combination that will perform the UIcmd's action, in lieu of selecting the UIcmd menu item. The string describes a set of modifiers and the key that can be used to select the item. The format required is identical to that of the Motif translation manager, except that only a single event can be specified and only KeyPress events are allowed.

acceleratorText

String. Specifies the text displayed for the accelerator. The text is displayed beside the label string or pixmap.

dims => array_size(cmdList)

Integer. Port. Signifies the number of commands in the list.

&cmdList[]

Group. IPort2. The list can contain UIcmds, UIoptions, or other UIcmdLists, nested to a depth of four.

Example

Examples.Applications.IsoApp
Examples.Visualization.Surf_Plot
Examples.Applications.UIApp
examples/iso.v
examples/surf_plot.v
examples/ui_samp.v

File

v/UI.v