UIoption

Synopsis

a menu command to trigger an event if it is set

UIcmd UIoption {
        Boolean isUIoption;
        Boolean+opt+OPort2 set = 0;
        method+opt+notify_val update<NEvisible=0,lang="cxx",interruptable=0> = "UIoptionUpdate";
  };

Description

UIoption is similar to UIcmd, which is the base class for all objects that generate a single action when selected. UIoption differs from UIcmd because it defines the additional subobject &set, which changes between 0 and 1 each time the user

picks the UIoption.

Thus, UIoption is used in menus for functions such as raising additional panels of controls (connecting &set to the panel's visibility subobject), while UIcmd tends

to initiate actions defined in code.

Multiple UIoptions, one for each action, can be the parent objects in networks for

all "list of command" objects such as UIcmdList, its derived objects UIoptionList

and UIradioList, and their derived objects and macros UIoptionbox, UIradioBox, UIoptionBoxLabel and UIradioBoxLabel.

Subobjects

&visible;

&active;

pixmap <Not visible in Network Editor>;

color <Not visible in Network Editor>;

fontAttribute <Not visible in Network Editor>;

handle <Internal Object. Not visible in Network Editor>;

fontlist <No longer used. Not visible in Network Editor>;

cxxhandle <Internal Object. Not visible in Network Editor>;

motif_resources <No longer used. Not visible in Network Editor>;

window_resources <No longer used. Not visible in Network Editor>;

layout <No longer used. Not visible in Network Editor>

Inherited from UIcore through UImenuItem class.

label

Inherited from UImenuItem This subobject is for internal purposes and should not be used.

.message;

accelerator;

acceleratorText;

do;

&active;

id;

window;

Inherited from UIcmd.

is UIoption

Boolean. Dummy attribute needed to differentiate from UIcmd class type.

&set

Boolean. OPort2. A flag indicating whether the UIoption is selected. 1=selected; 0=not selected. This usually connects to another widget's visibility subobject. For example, if the user selects the UIoption "Read Field", it has the effect of raising the UIfileDialog.

Example

AVS5_Modules.Mappers.ACU_arbitrary_slicer
v/ACUmods.v
Examples.Applications.UIApp
examples/ui_samp.v

File

v/UI.v

See Also Related Modules

UIcmd

UIoptionBox